diff --git a/docs/README.md b/docs/README.md index 8b6b211..de11f10 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,12 +14,7 @@ MeatSlicer is an endless top-down arena roguelite. You are the Butcher, descendi | [Perks](perks.md) | All 23 Mutation Draft perks, XP curve, draft mechanics | | [Enemies](enemies.md) | All 11 enemy types, elites, drops, wave and scaling formulas | | [Bosses](bosses.md) | All 9 bosses: rotation, scaling, full attack patterns, counters | - -For developers: - -| Doc | Contents | -|---|---| -| [Debug Console](dev-debug.md) | Hidden dev-only cheat/inspection toolset (backtick `` ` `` key, `--dev` flag): all 8 tabs, run tainting, stat-rebuild internals | +| [Debug Console](dev-debug.md) | In-game cheat/inspection toolset (backtick `` ` `` key, `--dev` flag): all 8 tabs, run tainting, stat-rebuild internals | | [Changelog](CHANGELOG.md) | Release history by version | ### Quick numbers @@ -64,6 +59,15 @@ npm test Runs the smoke test (`test/smoke.js`). +### Debug console + +An in-game cheat/inspection panel is available in dev builds. Launch with the +dev flag โ `MeatSlicer.exe --dev`, `npm start -- --dev`, or `play-dev.bat` / +`http://localhost:8123/?dev=1` in a browser โ then press the **backtick `` ` ``** +key in play or pause. Eight tabs cover health, weapons, items, perks, pressure, +spawning enemies/bosses, timescale, visualizers, and a live stats readout. Using +mutating actions voids the run's best score. See [Debug Console](dev-debug.md). + ## Tech overview - **Stack:** plain JavaScript + HTML5 canvas, no framework. Electron wrapper for desktop. diff --git a/docs/dev-debug.md b/docs/dev-debug.md index f7da314..a2afc81 100644 --- a/docs/dev-debug.md +++ b/docs/dev-debug.md @@ -1,7 +1,8 @@ -# Debug Console (dev only) +# Debug Console -A hidden in-game cheat / inspection toolset. Not linked from the player-facing -help manual โ it is meant to stay undiscovered in normal play. +An in-game cheat / inspection toolset. It is gated behind a dev launch flag so +it doesn't interfere with normal play, and it's documented here because the +game is still in development โ testers and players are welcome to use it. ## Enabling it diff --git a/index.html b/index.html index 3cef805..2e8a8c0 100644 --- a/index.html +++ b/index.html @@ -6,32 +6,32 @@