AuraJS Game Developer API Handbook

This page is the grouped index for the public AuraJS handbook.

If you are new, do not start here. Start with Start Here. If you want the truthful default-versus-supported starter boundary, use Supported Starter Catalog. If you want the shortest room-code multiplayer path, use Multiplayer Quickstart. If you want the fuller placement guide, use Handling State and Content.

Live handbook route: https://www.aurajs.gg/docs/handbook

Current bounded genre proof: examples/pokerogue-parity-proof is the monster-battler roguelite reference for runtime-owned battle, run, save, sync, and meta flow over retained screens. It is a gameplay/runtime proof, not a promise of Phaser-source compatibility, original upstream asset shipping, or live-ops/store breadth.

Recommended Reading Order

1. Start Here
2. Creating a New Game
3. Multiplayer Quickstart when the project is multiplayer-first
4. Supported Starter Catalog
5. Getting Started 2D or Getting Started 3D
6. Migrating from Three.js when porting a Three-style 3D project mental model
7. Working with an AuraJS Project
8. Handling State and Content
9. Examples and First-Game Recipes
10. Common Failures and Fixes
11. Exporting Your Game
12. Publishing and Large Assets
13. this handbook for grouped depth
14. AuraJS Reference Docs when exactness matters

Onboarding Pages

• Start Here
• Introduction
• Creating a New Game
• Multiplayer Quickstart
• Supported Starter Catalog
• Getting Started 2D
• Getting Started 3D

Practical Guides

• Assets and Media
• Multiplayer Quickstart
• Supported Starter Catalog
• Migrating from Three.js
• Working with an AuraJS Project
• Handling State and Content
• Examples and First-Game Recipes
• Common Failures and Fixes
• Web Wallet and Provider Bridges
• Builds
• Exporting Your Game
• Publishing and Large Assets
• 13 CLI, Create, Build, Dev, Test, and Project Files
• 14 Examples, Guides, and Canonical Sources

Handbook Sections

• 01 Runtime, Lifecycle, and Module Gates
• 02 Window, Input, and 2D Camera
• 03 Draw2D, Sprites, Text, and Transforms
• 04 Assets, Audio, Persistence, and Runtime FS
• 05 Animation, Tween, Particles, and Tilemaps
• 06 Math, Colors, Vectors, Timers, Collision, Collision3D, and ECS
• 07 Scenes, State, Debug, and Test Harness
• 08 Draw3D, Camera, Lighting, Shadows, and PostFX
• 09 Meshes, Materials, Scene3D, glTF, and Skinned Mesh
• 10 Physics, Terrain, Navmesh, Character3D, and Compute
• 11 Networking and Multiplayer
• 12 Video and Cutscenes
• 13 CLI, Create, Build, Dev, Test, and Project Files
• 14 Examples, Guides, and Canonical Sources
• 15 Environment and Configuration

Exact Reference

Use the handbook to choose the right family, then move here:

• AuraJS Reference Docs
• Runtime and 2D Exact Reference
• Lifecycle, Window, Input, and 2D Camera Exact Reference
• Draw2D, Assets, Audio, Storage, and Math Exact Reference
• Gameplay Systems Exact Reference
• Animation, Scenes, State, Tilemaps, and ECS Exact Reference
• 3D Rendering and Content Exact Reference
• Draw3D, Camera, Lighting, and PostFX Exact Reference
• Scene3D, Mesh, Material, glTF, and Avatar Exact Reference
• World Simulation and Multiplayer Exact Reference
• Physics3D, Terrain, Navmesh, Character3D, and Compute Exact Reference
• Net, Multiplayer, and Runtime Sessions Exact Reference

Canonical contract files remain the final source of truth for exact signatures, validation semantics, and reason codes:

• docs/api-contract.md
• docs/api-contract-3d.md
• docs/game-state-cli-contract-v1.md
• docs/wallet-provider-contract-v1.md
• docs/video-cutscene-contract-v1.md