JARVIG

JARVIG is a native multi-platform game engine. The browser is one export target, not the owner of the engine. A shipped game must be able to boot as a native executable without Node, Electron, or a DOM. The editor hosts that same engine. It does not carry a private copy of import, cooking, materials, or simulation.

The TypeScript packages in this repository are the current executable prototype of the contracts. The native core starts at native/jarvig_core. See ADR-0017 and ADR-0018.

The founding specification is designdoc.html (AAA Engine Platform — Project Start & Technical Framework v0.2, 2026-09-22). Do not delete or replace that file. Maintainable docs extracted from it live under docs/. Accepted ADRs outrank the founding document only for the decision they name.

The working codename in the founding document was left TBD. This repository adopts JARVIG. See ADR-0014.

Phase

The native editor is the product you run. JARVIGEditor.exe hosts the engine, opens a project from the Hub, and can play a runtime copy of the level. Research systems stay off by default. Later roadmap milestones, including streaming, a full gameplay loop, and networking, are not done. The creator manual is docs/manual/README.md.

Status: docs/status/CURRENT.md. Milestone sequence: ROADMAP.md.

Requirements

To build and run the editor:

Windows
A Rust toolchain with cargo
A GPU that can present Direct3D 12

Node.js 22 or newer, and pnpm 10.15.1 pinned in package.json, are for the TypeScript prototype, the boundary check, and the old dock. They are not required to launch JARVIGEditor. PowerShell scripts stay first-class.

Bootstrap

pwsh -File scripts\bootstrap.ps1

That installs dependencies, runs the boundary check, typecheck, unit/integration tests, the TypeScript build, and the smoke commands.

Everyday commands

Action	Command
Launch JARVIGEditor	`cargo run --offline --manifest-path native/Cargo.toml -p jarvig_editor --bin JARVIGEditor`
Build the local docs site	`pwsh -File scripts\build-docs.ps1`
Launch the transitional TypeScript dock	`pwsh -File scripts\dev-editor.ps1`
Same transitional dock, via pnpm	`pnpm dev:editor`
Boot the client once	`pwsh -File scripts\dev-client.ps1`
Boot the dedicated server once	`pnpm dev:server`
Run tests	`pwsh -File scripts\test.ps1`
Build	`pwsh -File scripts\build.ps1`
Smoke the built hosts	`pnpm smoke`
CLI project info	`pnpm cli info`

The cargo command is JARVIGEditor.exe. A launch with no project shows the Hub. pnpm dev:editor still serves the transitional dock on http://127.0.0.1:4780 until Ctrl+C. That page is not the product editor. Do not wrap it in a WebView. The docs site is written to docs/site/ and is not part of the engine.

Layout

The canonical layout is the one in designdoc.html section 5, with the Phase 0 naming notes in ARCHITECTURE.md. Engine packages live in engine/. The native editor is native/jarvig_editor. Older hosts live in apps/ and hosts/. The engine does not import the editor. The dedicated server does not import the renderer.

Authority

Accepted ADRs
Current architecture docs
designdoc.html
Accepted RFCs
Source contracts and tests
Temporary notes
Chat or model suggestions

License

JARVIG's own license has not been chosen. See LICENSES.md. The native runtime is the engine. PlayCanvas is not vendored, and it is not what the editor runs. CryEngine source is not allowed in this repository.