zwitschi
2ba40f3578
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.
54 lines
3.3 KiB
Markdown
54 lines
3.3 KiB
Markdown
# Gig Line Documentation
|
|
|
|
Documentation is grouped by category. Product intent, the gap analysis and the release roadmap
|
|
live in [`../PLAN.md`](../PLAN.md); the executable task list is [`../TODO.md`](../TODO.md); the
|
|
workflow rules are in [`../AGENTS.md`](../AGENTS.md).
|
|
|
|
## Categories
|
|
|
|
| Folder | Contents |
|
|
| --- | --- |
|
|
| [`project/`](project/README.md) | Architecture (arc42) and the implemented-features status |
|
|
| [`design/`](design/README.md) | Gameplay, venues, UI copy, accessibility and known limitations |
|
|
| [`assets/`](assets/README.md) | Blender library, asset tooling, NPC sourcing and the 3D model review |
|
|
| [`process/`](process/README.md) | Setup/controls, release QA and the release runbook |
|
|
| [`adr/`](adr/README.md) | Architecture Decision Records |
|
|
| [`screens/`](screens/README.md) | Licensed references, concepts and screen designs |
|
|
| [`blender_previews/`](blender_previews/README.md) | Committed character/gear/prop preview sheets |
|
|
| [`screenshots/`](screenshots/README.md) | The committed in-game gallery |
|
|
|
|
## Start here
|
|
|
|
- [`../PLAN.md`](../PLAN.md) — product, design pillars, gap analysis and the roadmap to 1.0.0
|
|
- [`../TODO.md`](../TODO.md) — milestone-ordered active tasks
|
|
- [`project/architecture.md`](project/architecture.md) — system architecture and ownership
|
|
- [`project/development-status.md`](project/development-status.md) — what the build supports now
|
|
- [`design/gameplay.md`](design/gameplay.md) — the playable loop and escalation model
|
|
- [`design/venues.md`](design/venues.md) — venue mapping and real-site evidence
|
|
- [`assets/npc-model-sourcing.md`](assets/npc-model-sourcing.md) — the active NPC base and licence
|
|
rules
|
|
- [`assets/3d-model-review.md`](assets/3d-model-review.md) — asset measurements and scorecard
|
|
- [`process/getting-started.md`](process/getting-started.md) — setup, run/test and controls
|
|
- [`../tools/README.md`](../tools/README.md) — tool inventory and test runner
|
|
- [`../CREDITS.md`](../CREDITS.md) — credits, AI/reference provenance and licensing
|
|
- [`../PRIVACY.md`](../PRIVACY.md) — local-only data and save files
|
|
|
|
## 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`](../TODO.md) for the live checklist.
|
|
|
|
## Quick preview
|
|
|
|
| Reference | Capture |
|
|
| --- | --- |
|
|
| Venue design | <img src="screens/designs/venue_overview.png" width="320" alt="Venue overview design"> |
|
|
| Current entrance (day) | <img src="screenshots/01-venue-overview.png" width="320" alt="In-game venue overview"> |
|
|
| Current entrance (late) | <img src="screenshots/05-late-night-avenue.png" width="320" alt="Late-night boulevard"> |
|
|
| Joke Shop | <img src="screenshots/12-joke-shop.png" width="320" alt="Joke Shop at night"> |
|
|
| Character sheet | <img src="blender_previews/sheet_npc.jpg" width="320" alt="NPC character sheet"> |
|
|
| Neutral NPC baseline | <img src="blender_previews/sheet_npc_baseline.jpg" width="320" alt="Neutral NPC baseline sheet"> |
|
|
| Texture refinement | <img src="blender_previews/sheet_texture_refinement_0.9.5.jpg" width="320" alt="Texture refinement comparison"> |
|
|
| Prop sheet | <img src="blender_previews/sheet_props.jpg" width="320" alt="Prop asset sheet"> |
|