gwen init

Scaffold a new GWEN game project in a new directory. Creates a complete project structure with TypeScript, Vite, ECS components, systems, and a playable demo scene.

Usage

gwen init [name] [options]

Arguments

Argument	Description
name	Project directory name (prompted if omitted)

Options

Option	Type	Description
--modules	string	Comma-separated list of optional modules to install

Global Options

Option	Alias	Type	Description
--verbose	-v	boolean	Show detailed logs
--debug		boolean	Show debug information

Generated Files

Running gwen init my-game creates:

my-game/
├── package.json
├── tsconfig.json
├── oxlint.json
├── .oxfmtrc.json
├── gwen.config.ts
├── README.md
└── src/
    ├── components/
    │   └── game.ts
    ├── systems/
    │   ├── movement.ts
    │   ├── input.ts
    │   ├── collision.ts
    │   ├── spawn.ts
    │   └── render.ts
    └── scenes/
        └── game.ts

Examples

# Interactive: prompts for project name
gwen init

# Scaffold into "my-game/" directory
gwen init my-game

# Scaffold with additional modules
gwen init my-game --modules @gwenjs/physics2d,@gwenjs/audio

Optional Modules

When running gwen init, you can select optional modules to include in your project. The list is fetched live from the GWEN module registry and may grow over time as the ecosystem expands.

Use --modules to skip the interactive prompt and pass a comma-separated list of package names:

gwen init my-game --modules @gwenjs/physics2d,@gwenjs/audio

INFO

@gwenjs/input is always included in new projects.