# ngin docs

Documentation for NGIN's reusable engine and independent games. During game work,
only the selected game folder is writable; the engine and reference demo are protected.
See [AGENTS.md](../AGENTS.md) and [new-game.md](./new-game.md) for rules and change checks.

**Creator handbook** (prompts, not code): open [index.php](./index.php) or http://localhost:8080/docs/

| Doc                                              | Purpose                                                    |
| ------------------------------------------------ | ---------------------------------------------------------- |
| [index.php](./index.php)                       | What game creators can ask for                             |
| [walking-module.md](./walking-module.md)         | Architecture, boot order, locomotion APIs                  |
| [vehicle-module.md](./vehicle-module.md)         | Jolt wheeled vehicles, enter/exit, towing                  |
| [water-module.md](./water-module.md)             | Buoyancy volumes, pool, boat                               |
| [interaction-module.md](./interaction-module.md) | Look-at actions, carry, inventory                          |
| [glb-module.md](./glb-module.md)                 | GLB load, clone, mesh/box colliders, optional carry        |
| [textures-module.md](./textures-module.md)       | 16px procedural textures and material loading              |
| [effects-module.md](./effects-module.md)         | Particles, weather, day/night                              |
| [new-game.md](./new-game.md)                     | Start a new game from the template                         |
| [ai-prompt.md](./ai-prompt.md)                   | Copy-paste prompt for AI-assisted game work                |

Protected reference: [games/sandbox/scripts/sandbox.js](../games/sandbox/scripts/sandbox.js).
Copyable starter: [games/template/index.php](../games/template/index.php) and its complete folder.
Each copied game launches at its own `games/<slug>/` URL; no shared startup edits.