Files
security-game/docs/README.md
T
zwitschi 2ba40f3578
Full build / Import + headless tests (push) Successful in 41s
Full build / Full desktop build + optional release (push) Skipped
Reorganize docs into category folders and drop the retired head-review page
Group the top-level docs into docs/project, docs/design, docs/assets and
docs/process, each with its own README index. Delete the superseded
docs/screens/head-review page and sheets. Rewrite every markdown link,
absolute docs path and tool/test reference to the new locations, fix the
pre-existing broken anchors and remove the dead Joke Shop photo-board link.
check_docs OK, Python tooling 167/167.
2026-11-06 20:13:03 +01:00

3.3 KiB

Gig Line Documentation

Documentation is grouped by category. Product intent, the gap analysis and the release roadmap live in ../PLAN.md; the executable task list is ../TODO.md; the workflow rules are in ../AGENTS.md.

Categories

Folder Contents
project/ Architecture (arc42) and the implemented-features status
design/ Gameplay, venues, UI copy, accessibility and known limitations
assets/ Blender library, asset tooling, NPC sourcing and the 3D model review
process/ Setup/controls, release QA and the release runbook
adr/ Architecture Decision Records
screens/ Licensed references, concepts and screen designs
blender_previews/ Committed character/gear/prop preview sheets
screenshots/ The committed in-game gallery

Start here

Current work

v0.9.9 shipped the Quaternius NPC roster. The active patch line is 0.9.10 (roster follow-ups: outfit families, the Swat base orientation, per-slot atlases) through 0.9.12, followed by the 0.10.0 public-readiness minor. See ../TODO.md for the live checklist.

Quick preview

Reference Capture
Venue design Venue overview design
Current entrance (day) In-game venue overview
Current entrance (late) Late-night boulevard
Joke Shop Joke Shop at night
Character sheet NPC character sheet
Neutral NPC baseline Neutral NPC baseline sheet
Texture refinement Texture refinement comparison
Prop sheet Prop asset sheet