summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Cleberg <[email protected]>2026-07-13 00:26:52 -0500
committerChristian Cleberg <[email protected]>2026-07-13 18:46:35 -0500
commitf1a0321e1edb598cd1eb421e4621be769b2d8b75 (patch)
treec5d1307a4db81aa56acbce273cf117a05689e492 /README.md
parentde2460845efda51820eb3c6343fb158661ae76bb (diff)
downloadmicro-roguelike-f1a0321e1edb598cd1eb421e4621be769b2d8b75.tar.gz
micro-roguelike-f1a0321e1edb598cd1eb421e4621be769b2d8b75.tar.bz2
micro-roguelike-f1a0321e1edb598cd1eb421e4621be769b2d8b75.zip
Phase 0–1: verification guardrails and engine enablers for the 1MB expansion (#2)
* Add byte-budget gate, headless solver harness, and size ledger Phase 0 guardrails for the 1MB roguelike; no changes under 1mb/. - tools/check-size.sh: per-file byte ledger for 1mb/, fails past 1 MiB, warns loudly past 95% - tools/validate.js: evaluates the unmodified game in a stubbed vm environment and sweeps seeds x floors 2-6 through the real escapeSolve, failing on any unwinnable escape room - tools/check.sh: single entry point running both gates - tools/pre-commit: optional installable hook running check.sh - README: Budget & verification section; docs/SIZES.md: ledger seeded at 82,240 B (7.8% of budget) * Task 1.1: data-driven floor graph Move room topology out of build() into a GRAPH table in data.js: each floor declares its room set and exit wiring (TOPO shared by floors 1-7), and build() consumes it generically. BASES flatten to raw map arrays since their exit wiring now lives in GRAPH. Two new graph capabilities, exercised by a hidden floor-9 proving ground (debug key T): extra room instances beyond the nine fixed codes (h2, inheriting family behavior from its first letter — spawn, darkness, room text, path counters) and one-way exits ("!dest" seals after one crossing). Guard cover()/the debug solve line for floors with no e room. Behavior-neutral: fixed-seed summary() and variantSummary() identical across floors 1-7 before/after; save format unchanged (v:1 round-trips). * Task 1.2: procedural room generator Add genRoom(rand, spec) to the engine: builds a 12x12 map from a spec (required exit letters, pit-room O ring, wall-cluster and pit-vein tile budgets, trap/item sprinkles, a stamp pattern for the idol ring) with perimeter walls and a flood-fill guarantee that every walkable tile and exit stays mutually reachable — block-overlay spots count as solid, and overlay spot coords plus spawns are forced open so hazards never bury a door. Bounded retries end in a sparse layout, then an authored fallback. Floors 2+ draw each variant pick from the authored arrays plus PROC_SLOTS=2 generated slots per room type (PROC_SPECS in data.js); escapes stay authored from floor 6 up and BASES rooms are never generated. Procedural escape rooms are gated by escapeSolve at build time with regeneration on failure. Fully deterministic per seed. Generator weighs 3,268 bytes. validate.js 500: 2500/2500 solvable. * Task 1.3: full-floor solver Add floorSolve(seed, level) to the engine: proves a floor completable end to end — gate to bones for the torch, hall to idol for the bow, hall to vault via pit or crack, crown and key pickups, then the escape room via the existing beast simulation, back to the gate. Room legs are BFS path costs over the built maps with block overlays solid and pits never crossed; exits and item tiles are located dynamically from the GRAPH-built rooms, so future topologies validate without changes. Floor 1 crosses the escape room at torch 8 (fresh-run fuel plus an allowed brazier refuel; 6 was falsely failing a third of floor-1 seeds that play fine). validateSeeds (V key) and tools/validate.js now sweep floors 1-7 with full-floor checks: 200 seeds x 7 floors in ~6.5s, 500 in ~15s. The debug panel gains a "floor : ok:<cost>" line (n/a on graphs without idol/vault/escape rooms). A scratch copy with the vault crown walled off fails 250/350 checks with per-floor variant detail.
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index f2e6ae5..1392bc5 100644
--- a/README.md
+++ b/README.md
@@ -50,6 +50,15 @@ From the title screen, press a number to start:
Win once, and a hidden seventh floor opens up — for anyone who isn't done yet.
+### Budget & verification
+The whole game is the two raw files in `1mb/` — no build step, no minification, ever — and together they must stay under 1,048,576 bytes (1 MiB). `tools/check.sh` is the gate: it prints the byte ledger and proves every escape room stays winnable across hundreds of seeds (ledger history lives in [docs/SIZES.md](docs/SIZES.md)).
+
+```sh
+tools/check.sh
+```
+
+To run it automatically before each commit: `ln -s ../../tools/pre-commit .git/hooks/pre-commit`
+
---
## 1KB Version — the hypertext original