JARVIG manual
This manual is how you make something with JARVIG. It is written for a person sitting at the editor: create a project, place a solid, bring in a model, light a level, press Play, and build a loose game. The same pages are the front door if a working session is gone and the repository is all that remains.
The generated site is a reader for these pages and for the architecture library beside them. It does not outrank an accepted decision. Authority stays:
- Accepted ADRs
- The architecture pages under
docs/ designdoc.htmlat the repository root- Accepted RFCs
- Source contracts and tests
- Status notes
- Chat
Build the site from the repository root:
pwsh -File scripts\build-docs.ps1Open docs/site/index.html. That folder is the rendered copy of these pages. Rebuild it with the command above. Session logs stay in docs/status/ and are not part of the site. The private surface rule for procedural detail is not taught here.
Start here
| What you want | Page |
|---|---|
| Build the editor and place the first block | Your first hour |
| Camera, selection, undo, panels | The editor |
| Extrude, inset, bevel | Blocks |
| glTF import and the content browser | Models and content |
| Level, Land, and Character | Worlds |
| Environment, lights, and debug views | Lighting |
| Play and a standalone exe | Play and build |
| The public API, as it exists | Programming |
| Meters, axes, and faces | Coordinates |
| What this build does not do | Limits |
| Where a cold session reads next | Authority |
Two kinds of page
A manual page tells you what to click and what gets saved. An architecture page or an ADR tells you what the engine is required to do. When they disagree, the accepted ADR wins, and the manual should be corrected. Do not treat a green test name in a status log as a feature you can ship.
The TypeScript dock at http://127.0.0.1:4780 is an old prototype host. JARVIGEditor.exe is the product.