Files
tts-workshop/docs/overview.md
T
hypercross 211c151971 docs: add bgm state model design
Describe the format's state model: components as constants, setup as the shape of states, path-to-stack by facing (part affordance x zone restriction), and the stacks-on-paths anchoring scope cut.
2026-08-16 12:38:58 +08:00

1.3 KiB

Docs

The documentation is split into the living specs, which describe how the system works today, and the status/plans, which track development iterations and go stale as work lands.

Specs — how the system works

Doc Covers
architecture.md System architecture and the package dependency graph
decisions.md Key design decisions and the rationale behind them
bgm/format.md The board game manifest (bgm) format spec
bgm/engine.md The bgm message layer: queue, triggers, orchestrators
bgm/commands.md bgm command execution: lifecycle, run contexts, tap interaction
bgm/tabletop.md The r3f tabletop component library
bgm/state-model.md The format's state model: components vs setup, facing, anchoring scope

Status & plans (dev logs)

Doc Covers
status/implementation-plan.md Original build plan
status/bgm-loader.md bgm loader — what's built, works, missing
status/bgm-tabletop.md bgm tabletop — implementation plan / status
status/full-setup-view.md Full-setup view plan