Getting started

1Choose a template

• 2D top-down

  Explore a pixel-art courtyard, light shrines and save your progress.

  2d-topdown

• 2D side-scroller

  Run, jump and collect coins across a scrolling pixel-art level.

  2d-sidescroller

• 3D third-person

  Explore with an animated character, a following camera and an AI companion.

  3d-third-person

• 3D first-person

  Explore in first person, push crates and interact with objects.

  3d-first-person

Each template includes a title screen, pause menu, audio and graphics settings, control rebinding and checkpoint saves. Use it as a starting point, then add your own gameplay and art.

2Create a project

npx @ignifx/cli@latest my-game

This creates a 2d-topdown project. To start with a different template instead, use its name:

npx @ignifx/cli@latest my-game --template 3d-third-person

3Run it

cd my-gamenpm installnpm run dev

Open http://localhost:5173. Press backtick for the devtools overlay. Press Escape for the pause menu.

4Change something

Open src/scripts/ and find a Script. Change a speed, save, and watch the game update without a reload. Every field you declare with Script.define shows up in the devtools inspector.

5Build

Run npm run build to create the dist/ folder. Upload its contents to a static web host or a browser-game platform such as itch.io.

Desktop

Add --desktop when creating your project to include an Electron desktop app. Use npm run dev:desktop during development and npm run dist:desktop to package it. The template configures the window and build tools for you.

npx @ignifx/cli@latest my-game --template 3d-first-person --desktop

What next

• Guides — one task each.
• Examples — see a feature running and read its source.
• API reference — every export.
• Something wrong? Open an issue.