From ebb3b346d873ff39902199d45347e138ff5969d8 Mon Sep 17 00:00:00 2001 From: autocommit Date: Wed, 15 Apr 2026 16:53:08 -0700 Subject: [PATCH] =?UTF-8?q?docs(docs):=20=F0=9F=93=9D=20Update=20README=20?= =?UTF-8?q?sections=20to=20document=20new=20project=20structure=20and=20be?= =?UTF-8?q?st=20practices?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Lilith Autocommit --- README.md | 70 +++++-------------------------------------------------- 1 file changed, 6 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index d9b575f0..3b069e56 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,9 @@ -# Magic Civilization +# .local/ — ephemeral, gitignored workspace -Fantasy 4X turn-based strategy game (Civ5 + Master of Magic + MTG color pie) in Godot 4 / GDScript. +Paths canonicalized here instead of /tmp: -## Structure +- `.local/batches/` — autoplay-batch.sh output (per-seed game dirs) +- `.local/iter/` — per-iteration diagnostic dumps from the /loop pipeline +- `.local/smoke/` — single-game smoke test outputs -``` -engine/ — genre-agnostic game engine (GDScript) - src/ — autoloads, entities, map, generation, modules, rendering - scenes/ — Godot scenes (.tscn + .gd) - docs/ — engine architecture docs - -games/ - age-of-dwarves/ — fantasy game pack (the default theme) - data/ — all JSON game content - assets/ — sprites, icons - docs/ — game design docs (races, combat, spells, economy) - -guide/ — player guide web app (React/TypeScript) - engine/ — @magic-civ/guide-engine (shared components) - age-of-dwarves/ — guide pages for Age of Dwarves - -packages/ - engine-ts/ — @magic-civ/engine-ts (auto-generated climate simulation) - -tools/ — sprite generation, transpiler, screenshot capture -``` - -## Docs - -### Engine (`engine/docs/`) - -| Doc | Covers | -|-----|--------| -| ARCHITECTURE.md | Project structure, autoloads, scene lifecycle | -| ABSTRACTION.md | Genre-agnostic vocabulary, theme pack system | -| DATA_FORMAT.md | JSON data schemas, DataLoader patterns | - -### Game Design (`public/games/age-of-dwarves/docs/`) - -| Doc | Covers | -|-----|--------| -| [RACES.md](public/games/age-of-dwarves/docs/RACES.md) | 4 demo races, gendering, fusions, release schedule | -| [ECONOMIC_SYSTEMS.md](public/games/age-of-dwarves/docs/ECONOMIC_SYSTEMS.md) | Economy, civic axis, capitalism cascade | -| [GOVERNMENTS.md](public/games/age-of-dwarves/docs/GOVERNMENTS.md) | Government types and mechanics | -| [GLOSSARY.md](public/games/age-of-dwarves/docs/GLOSSARY.md) | Term definitions | -| COMBAT_SYSTEM.md | Combat mechanics (written when M8 is built) | -| SPELL_SYSTEM.md | Spell/mana system (written when M9 is built) | -| ERA_SYSTEM.md | Era progression (written when needed) | - -### Build Process (`.project/`) - -| Doc | Covers | -|-----|--------| -| [ROADMAP.md](.project/ROADMAP.md) | Demo scope + 12-phase build sequence | -| [FEATURE_GAP.md](.project/FEATURE_GAP.md) | New systems beyond the reference implementation | -| `tasks/m0-m4/` | Milestone task lists with porting checklists | - -## Quick Start - -```bash -./run play # Launch the game -./run editor # Open Godot editor -./run lint # gdlint engine/src/ -./run test # GUT tests headless -pnpm dev # Serve the player guide -``` +See CLAUDE.md "Safety Rules" for why /tmp is forbidden.