docs(m1-base-mundaneworld): 📝 Implement task-specific documentation in README.md with usage examples and setup guidance for the m1-base-mundaneworld module

Co-Authored-By: Lilith Autocommit <noreply@atlilith.com>
This commit is contained in:
Claude Code 2026-03-26 11:38:24 -07:00
parent 81a040531e
commit eaf25bf4a2

View file

@ -18,7 +18,7 @@ When this milestone is complete, you can generate a hex map, run N turns of clim
- All 9 autoloads, `project.godot`, main menu, GUT, `run` script
- 3 data files only: `game.json`, `vocabulary.json`, `climate_spec.json`
- pnpm workspace + `guide/engine/` + `guide/age-of-four/` shell
- pnpm workspace + `guide/engine/` + `guide/age-of-dwarves/` shell
- Transpiler pipeline + climate GDScript files (verbatim from `.messy/`)
- `ClimatePhysics.generated.ts` verified via `--check`
@ -101,15 +101,15 @@ M0 only ported 3 data files. M1 must port all terrain/climate/hydrology data.
| # | Task | Reference |
|---|------|-----------|
| 0.1 | Port `terrain/land.json` + FEATURE_GAP 3.1: add `jungle`, `boreal_forest`, `plains` terrain types; add `infiltration` field to ALL terrain types | `.messy/games/age-of-four/data/terrain/` + FEATURE_GAP 3.1 |
| 0.2 | Port `terrain/water.json` (ocean, deep_ocean, coast, river, lake, ice_cap) with hydrological properties | `.messy/games/age-of-four/data/terrain/` |
| 0.3 | Port `terrain/special.json` (natural wonders with `wonder_anchor_strength`, `wonder_anchor_school`) | `.messy/games/age-of-four/data/terrain/` |
| 0.4 | Port `climate_params.json` -- all 25+ keys including `atmosphere` sub-object, `deep_earth_water` | `.messy/games/age-of-four/data/climate_params.json` |
| 0.5 | Port `hydrology_params.json` -- source_bonuses, river thresholds, lake depth, rainfall multipliers | `.messy/games/age-of-four/data/hydrology_params.json` |
| 0.6 | Port `resources.json` -- physical resources with valid terrain types and yield bonuses | `.messy/games/age-of-four/data/resources.json` |
| 0.7 | Port `setup.json` -- map sizes (width, height, default_players, natural_wonders) | `.messy/games/age-of-four/data/setup.json` |
| 0.8 | Port `map_types.json` -- generation_params, ocean_percentage, continent_count, terrain_fractions | `.messy/games/age-of-four/data/map_types.json` |
| 0.9 | Port `wilds.json` + `villages.json` -- lair types, densities, terrain affinities | `.messy/games/age-of-four/data/` |
| 0.1 | Port `terrain/land.json` + FEATURE_GAP 3.1: add `jungle`, `boreal_forest`, `plains` terrain types; add `infiltration` field to ALL terrain types | `.messy/games/age-of-dwarves/data/terrain/` + FEATURE_GAP 3.1 |
| 0.2 | Port `terrain/water.json` (ocean, deep_ocean, coast, river, lake, ice_cap) with hydrological properties | `.messy/games/age-of-dwarves/data/terrain/` |
| 0.3 | Port `terrain/special.json` (natural wonders with `wonder_anchor_strength`, `wonder_anchor_school`) | `.messy/games/age-of-dwarves/data/terrain/` |
| 0.4 | Port `climate_params.json` -- all 25+ keys including `atmosphere` sub-object, `deep_earth_water` | `.messy/games/age-of-dwarves/data/climate_params.json` |
| 0.5 | Port `hydrology_params.json` -- source_bonuses, river thresholds, lake depth, rainfall multipliers | `.messy/games/age-of-dwarves/data/hydrology_params.json` |
| 0.6 | Port `resources.json` -- physical resources with valid terrain types and yield bonuses | `.messy/games/age-of-dwarves/data/resources.json` |
| 0.7 | Port `setup.json` -- map sizes (width, height, default_players, natural_wonders) | `.messy/games/age-of-dwarves/data/setup.json` |
| 0.8 | Port `map_types.json` -- generation_params, ocean_percentage, continent_count, terrain_fractions | `.messy/games/age-of-dwarves/data/map_types.json` |
| 0.9 | Port `wilds.json` + `villages.json` -- lair types, densities, terrain affinities | `.messy/games/age-of-dwarves/data/` |
| 0.10 | Verify `climate_spec.json` (ported in M0) has all required sections: terrain_transitions, terrain_classification, precipitation_latitude, aerosol | Already ported |
**Parallelism**: 0.1-0.9 are independent ports -- run in parallel. 0.10 is verification.
@ -174,7 +174,7 @@ Port + split the climate system. M0 Block 4.2 already ports these verbatim; M1 s
| # | Task | Reference |
|---|------|-----------|
| 5.1 | Verify `ClimateSimulationPage.tsx` renders hex grid with temperature/moisture/pressure/wind lenses | `.messy/guide/age-of-four/src/pages/ClimateSimulationPage.tsx` |
| 5.1 | Verify `ClimateSimulationPage.tsx` renders hex grid with temperature/moisture/pressure/wind lenses | `.messy/guide/age-of-dwarves/src/pages/ClimateSimulationPage.tsx` |
| 5.2 | Verify hydrology lens (river edge lines, lakes, flow accumulation heatmap) | `.messy/guide/engine/src/components/climate/` |
| 5.3 | Verify biome/terrain lens (color-coded by biome type) | -- |
| 5.4 | Verify climate controls (seed input, turn slider, play/pause, speed, lens selector) | -- |
@ -199,7 +199,7 @@ Port + split the climate system. M0 Block 4.2 already ports these verbatim; M1 s
| # | Task |
|---|------|
| 7.1 | Guide proof: `pnpm dev` in `guide/age-of-four/`, run simulation 20 turns on seed `42`. Screenshot showing hex grid with temperature heatmap, rivers as blue edges, lakes, biome colors. Review visually |
| 7.1 | Guide proof: `pnpm dev` in `guide/age-of-dwarves/`, run simulation 20 turns on seed `42`. Screenshot showing hex grid with temperature heatmap, rivers as blue edges, lakes, biome colors. Review visually |
| 7.2 | Godot proof scene: `engine/scenes/tests/climate_proof.tscn`. Generate 20x20 map, run 20 turns, render temperature + moisture + water lenses. Auto-screenshot + SCP to plum |
---