Scaff Godot

A Professional Command Line Interface (CLI) tool to bootstrap Godot 4 projects in seconds. Stop wasting time creating folders and manually setting up State Machines.

🚀 Features

• Professional Directory Structure: Follows industry standards for Godot project organization.
• Built-in State Machine: Automatically generates a high-quality Finite State Machine (FSM) architecture.
• Smart Templates: Includes optimized README.md and project configs based on your game type (2D or 3D).
• Clean Architecture: Decouples logic from entities using a base State pattern.

📦 Installation

Install it globally via NPM:

npm install -g scaff-godot

Or using pnpm:

pnpm add -g scaff-godot

🛠️ Usage

Simply run the command in your projects folder:

scaff-godot

The CLI will guide you through:

1. Project Name: The folder name for your new game.
2. Game Type: Choose between 2D and 3D to optimize templates.
3. Developer Name: To personalize your project files.

📂 Generated Structure

/your-game
├── assets/              # Raw art, sounds, and music
├── scenes/              # .tscn files (Player, Levels, UI)
├── scripts/
│   ├── entities/        # Character & Object logic
│   │   └── states/      # FSM State logic (Idle, Walk, etc.)
│   └── autoloads/       # Global singletons
├── resources/           # .tres files
└── README.md            # Auto-generated project guide

🏗️ The FSM Architecture

scaff-godot doesn't just create folders; it implements a robust State Machine:

• StateMachine.gd: Manages state transitions and active state updates.
• State.gd: The base class for all your custom states.
• Signal-driven: Built to work with Godot's signal system for clean, decoupled code.

📄 License

This project is licensed under the MIT License.

Created with ❤️ for the Godot Community.