Start Here

This is the public first page for AuraJS docs.

If you are new, use this order:

create a project
pick the 2D or 3D path
understand the scaffold and state model
use the handbook for grouped depth
use exact reference only when you need signatures or validation detail

Fastest Project Path

npm install -g auramaxx
auramaxx create my-game
cd my-game
npm run dev

That gets you onto the canonical 2d-adventure starter. Use auramaxx create with no name if you want the interactive starter prompt, or pass --template ... to choose explicitly.

Choose Your Path

I want the shortest possible first game path

Creating a New Game
Working with AI Agents if you are building with Codex, ChatGPT, Claude, or another agent
Starter Utils Reference
Packs and Bundles
Where Does This Code Live?
Multiplayer Quickstart if this is a room-code multiplayer game
Working with an AuraJS Project
Handling State and Content
Examples and First-Game Recipes
Exporting Your Game
Common Failures and Fixes

I am making a multiplayer game

I am making a 2D game

I am making a 3D game

I need exact APIs or CLI behavior

I am working with an AI coding agent

First Hour Checklist

Read src/main.js, src/runtime/, and scenes/ once before moving files around.
Replace starter assets and starter content with your own nouns quickly.
Use auramaxx make instead of inventing file names and registry edits by hand.
Keep the first loop small enough that you can prove it in one session.
Add audio, UI, saves, and advanced systems only after the core loop feels correct.

Public Reading Order

Start here:

Then go broader:

Game Dev API Handbook

Then go exact:

If You Are Using an LLM or Coding Agent

Use this routing rule:

start on this page
move to the smallest exact-reference page that matches the task
open the full contract only after you know the namespace or subsystem

That keeps the search space small and reduces the chance of mixing 2D, 3D, and optional-module behavior.

AURA

JSGG