Starters#
Every ZUKU game ends up the same way: a folder with a zukujs.json manifest and a src/ directory holding an index.html entry point. The ZUKU CLI checks that folder with zuku validate and turns it into a package with zuku package.
How you get to that folder is up to you. Pick one of the three recipes below.
If you haven't installed the CLI yet, start with Installation, then come back here.
Canvas runner#
Best for: your first ZUKU game, learning the workflow, and small arcade ideas.
zuku create my-game scaffolds a small, playable Canvas jump game. The player jumps over incoming blocks with Space, the Up arrow, a click, or a tap. It uses no engine and no dependencies, just one HTML file and one JavaScript file.
Start with the Canvas runner →
Phaser 2D#
Best for: sprite-based 2D games with scenes, physics, and asset loading.
Download the Phaser starter archive. Phaser is bundled in the archive as a local vendor file, so the game never loads it from a CDN and there's nothing to install with npm.
Bring an existing game#
Best for: an HTML5, Canvas, or Phaser game that already runs in a browser.
Add a zukujs.json manifest, move your files under src/, make every asset path relative, bundle anything you currently load from the network, and validate.
Which should I pick?#
| If you... | Pick | First command |
|---|---|---|
| Are new to ZUKU and want something running in a minute | Canvas runner | zuku create my-game |
| Want plain JavaScript and full control over the game loop | Canvas runner | zuku create my-game |
| Want sprites, scenes, and arcade physics out of the box | Phaser 2D | Download zuku-phaser-starter.zip |
| Already have a working browser game | Existing game | zuku validate . |
| Would rather describe a game and have it generated | Game agent | zuku agent "..." |
The same workflow for every recipe#
Once your project folder exists, each recipe uses the same commands:
zuku run # preview locally (run inside the project folder)
zuku validate . # check the manifest and source files
zuku package . --format zwf # build dist/<name>-<version>.zwf
zuku run previews the project in the current folder, so cd into it first. validate and package take a path, and . means the current folder. None of the three needs a network connection. When you're ready to share your game, see Publishing. For every flag, see the command reference.
Generating a game instead#
zuku agent can generate a complete game from a one-line request. It designs, implements, playtests in a real browser, and packages the result. CLI 0.3.0 does not bundle Phaser; the agent can select it only when separately installed alongside the CLI. The agent only builds games and needs credentials for the selected model provider or a local model. A ZUKU account is needed for ZUKU AI, draft uploads and publishing. See Game agent and Authentication.