Start Here

This is the public first page for AuraJS docs.

If you are new, use this order:

1. create a project
2. pick the 2D or 3D path
3. understand the scaffold and state model
4. use the handbook for grouped depth
5. 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 current scaffolded native-first lane.

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
• Common Failures and Fixes

I am making a multiplayer game

• Multiplayer Quickstart
• 11 Networking and Multiplayer
• Examples and First-Game Recipes
• Common Failures and Fixes

I am making a 2D game

• Getting Started 2D
• Assets and Media
• 02 Window, Input, and 2D Camera
• 03 Draw2D, Sprites, Text, and Transforms

I am making a 3D game

• Getting Started 3D
• 08 Draw3D, Camera, Lighting, Shadows, and PostFX
• 09 Meshes, Materials, Scene3D, glTF, and Skinned Mesh
• 10 Physics, Terrain, Navmesh, Character3D, and Compute

I need exact APIs or CLI behavior

• AuraJS Reference Docs
• Runtime and 2D Exact Reference
• Gameplay Systems Exact Reference
• 3D Rendering and Content Exact Reference
• World Simulation and Multiplayer Exact Reference

I am working with an AI coding agent

• Working with AI Agents
• Starter Utils Reference
• Packs and Bundles
• Where Does This Code Live?
• Creating a New Game
• Working with an AuraJS Project
• AuraJS Reference Docs

First Hour Checklist

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

Public Reading Order

Start here:

• Creating a New Game
• Working with AI Agents
• Starter Utils Reference
• Packs and Bundles
• Where Does This Code Live?
• Multiplayer Quickstart
• Getting Started 2D or Getting Started 3D
• Working with an AuraJS Project
• Handling State and Content
• Examples and First-Game Recipes
• Common Failures and Fixes

Then go broader:

• Game Dev API Handbook

Then go exact:

• AuraJS Reference Docs
• docs/api-contract.md
• docs/api-contract-3d.md

If You Are Using an LLM or Coding Agent

Use this routing rule:

1. start on this page
2. move to the smallest exact-reference page that matches the task
3. 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.