applications/magicciv
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

docs(docs): 📝 Update README sections to document new project structure and best practices

Browse source 
Co-Authored-By: Lilith Autocommit <noreply@atlilith.com>
This commit is contained in:
autocommit 2026-04-15 16:53:08 -07:00
parent 1a5aa38103
commit ebb3b346d8
1 changed files with 6 additions and 64 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
README.md
View file

@ -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.