beezm/islaApocalypse
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: BLUEPRINT_FORMAT.md + README updates for the v2 container (terrain-water task 02)

Browse source 
Byte-accurate v2 contract (magic/version, tagged sections, registered
FourCC table, validation rules, re-encode sentinels, extension path)
plus the v1 legacy summary — v1 stays live per the safety-net plan.
READMEs updated additively: parser dispatch, dual-write outputs,
harness usage, server params cross-check, wire-format hazard rewording
(u8 on v2 path, range-checked; append-only rule unchanged).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Stewart Howe 2026-08-06 07:31:03 -04:00
parent 8532d88771
commit a7e6c17422
7 changed files with 185 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

13
Tools/Scenes/README.md
View file

@ -23,6 +23,19 @@ tiny or black PNG.
Note the generator writes the `.dat` on its own — the capture wrapper only matters for the
full-resolution image.
## `RoundTripHarness.tscn`
The blueprint format regression test (script: `Tools/Scripts/RoundTripHarness.cs`). Run it
headless from a terminal — it never generates, it round-trips an existing blueprint through the
real parser and v2 writer and asserts semantic equality:
```
Godot --headless --path <repo> res://Tools/Scenes/RoundTripHarness.tscn
```
Defaults to the preserved reference blueprint (`user://reference_1409879727/`); override with the
`HARNESS_V1_PATH` / `HARNESS_V2_PATH` environment variables. Exit code 0 = pass.
## Generating a new world
1. Open `MapPreview.tscn` (or `Scenes/MapCaptureTool.tscn` for the full-resolution PNG).