The docs
Twelve numbered chapters mirroring the canonical spec in the repo's docs/ folder, plus an API reference and SDK guides for integrators. Read the chapters in order for the design story; jump in mid-way for a specific concern.
- 00
00 — Vision & Overview
The portfolio already has dedicated tools for many things:
- 01
01 — Data Model
This is the canonical shape. The full Zod schema lives in packages/world-engine/src/world.ts (Phase 1). For now, this document is the contract — every package depends on it.
- 02
02 — Asset & Terrain Framework
A world document composes four independent layers (see also 01-data-model.md §4):
- 03
03 — Editor Architecture
| Design element | Status | Where | | --- | --- | --- | | Three editors (World / Region / Adventure Builder, §1) | ❌ Not built as separate presets | One editor at /editor/[worldId] (components/edit…
- 04
04 — 2D → 3D World Engine
WebGPU is preferred when available (Chrome 113+, Safari 17+). Falls back to WebGL2 transparently. The renderer is feature-gated, not branched — every material shader compiles for both backends.
- 05
05 — Simulation & Game Modes
| Design element | Status | Where | | --- | --- | --- | | Five mode shells (§8) — Editor / Explorer / Cinematic / GM / Replay | ✅ SHIPPED (PR #26, 2026-08-21) | components/modes/{ModeShell,ModeSwit…
- 06
06 — Cinematic Director
Camera paths are authored inside the world document (World.json#world.cameraPaths[]) so the same camera path can be used by:
- 07
07 — Export & Engine Targets
| Target | Status | Depth | Notes | | --- | --- | --- | --- | | .gas-world JSON | ✅ SHIPPED | Full round-trip | Canonical interchange; deterministic serializeWorld + deserializeWorld in packages/wo…
- 08
08 — Print System
| Design element | Status | Where | | --- | --- | --- | | Layout engine + vector output (§2, §3) | ✅ SHIPPED (tags spec-4-print-complete, spec-4-print-slice-2-complete, spec-4-themes-borders-and-pr…
- 09
09 — Multiplayer, Versioning & Collaboration
| Design element | Status | Where | | --- | --- | --- | | Yjs CRDT co-editing realm (§2) | ✅ SHIPPED (tags spec-11-foundations-complete, spec-11-phase-3-complete) | apps/api/src/realm/{wss,connecti…
- 10
10 — Marketplace & Packs
| Design element | Status | Where | | --- | --- | --- | | Marketplace backend + picker | ✅ SHIPPED (Spec 5, 2026-08-04) | packages/marketplace/src/{db,domain,schemas,client,semver}.ts; components/m…
- 11
11 — Phased Roadmap
WorldForge Studio is the universal authoring environment for the GAS world format — the place where designers, artists, writers, and game masters create the living worlds consumed by adventure-craf…
API reference →
13 route-group pages — auth, worlds, collaboration, atlas, wiki, packs, proposals, print, gameplay, AI, MCP.
SDK guides →
7 guides for @blueforge-studio/worldforge-sdk — quickstart, auth, resources, offline tools, realtime, MCP.
Prefer the raw source? Browse the repo docs directly. These pages are auto-generated from the same Markdown at build time.