AURA
JSGG
Examples and First-Game Recipes
Use this page when you want to copy a current AuraJS pattern instead of starting from the full handbook or full contracts.
Table of Contents
1. How To Use This Page
Pick the smallest example that already proves the subsystem you need.
Then read in this order:
- the example README
- the matching public handbook page
- the matching exact-reference page
- the canonical contract only if you still need exact signatures or validation
That keeps the search space small for both humans and coding agents.
2. Fast Recipe Map
| I want to build... | Start here | Read next | Exact reference |
|---|---|---|---|
| a 2D RPG or adventure | examples/auramon |
Getting Started 2D | Lifecycle, Window, Input, and 2D Camera Exact Reference |
| a rhythm or audio-driven game | examples/aurasu |
Assets and Media | Gameplay Systems Exact Reference |
| a web-first 3D game with Aura Three | examples/auramon-three |
Getting Started 3D | Draw3D, Camera, Lighting, and PostFX Exact Reference |
| a 3D voxel or procedural world | examples/auracraft |
Getting Started 3D | Draw3D, Camera, Lighting, and PostFX Exact Reference |
| local-first room-code multiplayer | examples/multiplayer-party or scaffold multiplayer |
Multiplayer Quickstart | Net, Multiplayer, and Runtime Sessions Exact Reference |
examples/auramon-three is the stronger example once you want descriptor-owned
asset packs, region kits, and bounded streamed-region transitions in a real
overworld shell.
If you want the smallest Aura Three helper pattern instead of the fuller
overworld showcase, start with examples/aura-three-lab after auramon-three.
That lab is also the clearest small example of the starter-facing
src/runtime/aura-three helper layer once you want descriptor-owned scene kits
or higher-level render-target and composer recipes.
3. Recommended Reading Order
If you are still picking a direction:
- Start Here
- Creating a New Game
- this page
- Working with an AuraJS Project
- Common Failures and Fixes when the first run does not behave as expected
If you already know the subsystem:
- open the example
- copy the smallest working pattern
- confirm the behavior in the matching exact-reference page
- only then open
docs/api-contract.mdordocs/api-contract-3d.md
4. Rules For Copying Examples Safely
- Copy one subsystem at a time.
- Do not merge 3D rendering, physics, and networking into the same first experiment.
- Prefer the examples that already match the current public docs path.
- When an example and a contract disagree, the contract wins.
- When an example and the scaffold shape disagree, the scaffold shape wins for new projects.