From 59869945d03bb0086fa7d61c4a712ea47f9590ea Mon Sep 17 00:00:00 2001 From: Quintine Date: Thu, 13 Aug 2026 13:37:02 +1000 Subject: [PATCH] docs: unify styling across guides (enemy tables, item counts, headers) --- docs/README.md | 6 ++-- docs/dev-debug.md | 4 ++- docs/enemies.md | 79 +++++++++++++++++++++++++++++++++++++++-------- docs/items.md | 8 ++--- 4 files changed, 77 insertions(+), 20 deletions(-) diff --git a/docs/README.md b/docs/README.md index de11f10..849381a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,13 +4,15 @@ MeatSlicer is an endless top-down arena roguelite. You are the Butcher, descending floor by floor through an infinite meat-locker hell: clear rooms of flesh-hungry horrors, draft mutations, stack grotesque passive items into a broken build, kill the boss, take the stairs. The descent never ends — the only question is how deep you get before you're butchered, and whether your score becomes the new best cut. +--- + ## Documentation index | Doc | Contents | |---|---| | [Gameplay Guide](gameplay.md) | Core loop, controls, player stats, rooms & floors, pickups, leveling, scoring, pressure/difficulty systems, HUD | | [Weapons](weapons.md) | All 16 weapons with exact stats, drop tiers, and damage math | -| [Items](items.md) | All 46 passive items, stacking/tier rules, proc numbers, synergies | +| [Items](items.md) | All 82 passive items, stacking/tier rules, proc numbers, synergies | | [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 | @@ -20,7 +22,7 @@ MeatSlicer is an endless top-down arena roguelite. You are the Butcher, descendi ### Quick numbers - **16 weapons** (1 infinite-ammo sidearm + 15 special weapons across 4 tiers) -- **46 passive items** (stacking, tier cap IX) +- **82 passive items** (stacking, tier cap IX) - **23 perks** (draft 1 of 3 per level-up) - **11 enemy types** (+ elite variants) - **9 bosses** (fixed rotation, one per floor) diff --git a/docs/dev-debug.md b/docs/dev-debug.md index a2afc81..5a344c9 100644 --- a/docs/dev-debug.md +++ b/docs/dev-debug.md @@ -4,6 +4,8 @@ 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 The console is gated behind a dev flag and is completely inert otherwise (the @@ -57,7 +59,7 @@ pinning) do **not** taint. Taint resets on the next run (`resetRun()`). Give +1 (routes through `giveItem`), remove 1 tier, remove all, set to max tier, or set an exact tier. Presets: *one of everything*, *max everything*, *clear build*. -4. **PERKS+ACTIVE** — grant any of the 22 `PERKS` by id, remove a drafted perk, +4. **PERKS+ACTIVE** — grant any of the 23 `PERKS` by id, remove a drafted perk, clear all perks. Set / fire an active item from `ACTIVES`. 5. **WORLD** — warp to floor N (`genFloor` + `enterRoom`), next floor, teleport to the boss/item room, clear room, kill all, kill boss, regen floor. Spawn diff --git a/docs/enemies.md b/docs/enemies.md index 36c71a2..78f572b 100644 --- a/docs/enemies.md +++ b/docs/enemies.md @@ -84,12 +84,77 @@ Small, vicious gore-red chaser. Never spawns directly from room waves. Splitter Suicide bomber. Charges at you; within 56 px its **0.5 s fuse** lights (it flashes). When the fuse ends — or when it's killed by anything — it detonates: radius 70 (fuse) / 60 (killed), **2 damage**. The blast only hurts *you*, not other enemies. Kill them at range or bait the fuse and back off. +### Censer + +| Stat | Value | +|---|---| +| Base HP | 34 | +| Base speed | 45 | +| Contact damage | 1 | +| Hitbox radius | 19 | +| XP | 3 | +| First appears | Floor 4 (spawn weight 8) | + +A zone caster that every ~3.3s predicts player movement and telegraphs a hostile acid pool (radius 38, 0.75s warning, ~4.2s life). Excluded from wave picks when the arena's minimum dimension is below 300px. + +### Bulwark + +| Stat | Value | +|---|---| +| Base HP | 60 | +| Base speed | 38 | +| Contact damage | 2 | +| Hitbox radius | 23 | +| XP | 3 | +| First appears | Floor 5 (spawn weight 8) | + +Slowly faces the player; hits within ±70° of its front deal 20%, flank/rear hits full. Resists on-hit stun and cannot be elite. + +### Flenserling + +| Stat | Value | +|---|---| +| Base HP | 22 | +| Base speed | 150 | +| Contact damage | 2 | +| Hitbox radius | 16 | +| XP | 3 | +| First appears | Floor 5 (spawn weight 7) | + +Periodically phases untargetable, appears behind the aim vector, and lunges. + +### Choirmaster + +| Stat | Value | +|---|---| +| Base HP | 40 | +| Base speed | 50 | +| Contact damage | 1 | +| Hitbox radius | 19 | +| XP | 4 | +| First appears | Floor 6 (spawn weight 6) | + +Its 180px aura grants +35% speed and heals nearby non-boss monsters ~1.8% max HP per second (minimum 0.5). At most one is selected by a normal wave. + +### Brood Sac + +| Stat | Value | +|---|---| +| Base HP | 45 | +| Base speed | 20 | +| Contact damage | 1 | +| Hitbox radius | 22 | +| XP | 4 | +| First appears | Floor 7 (spawn weight 6) | + +Spawns 2 Minis every 4s and 4 on death. At most two are wave-selected; the brood population cap is 40. Cannot be elite and is excluded from thin halls. + --- ## Spawn weights | Enemy | First floor | Weight | -|---|---:|---:| +|---|---|---| | Shambler | 1 | 30 | | Runner | 1 | 22 | | Spitter | 2 | 14 | @@ -103,18 +168,6 @@ Suicide bomber. Charges at you; within 56 px its **0.5 s fuse** lights (it flash Weights stay flat once unlocked; floors get harder through stat scaling and wave size, not new mixes. -## New enemy types - -**Censer** — 34 HP, speed 45, damage 1, radius 19, XP 3; floor 4, weight 8. A zone caster that every ~3.3s predicts player movement and telegraphs a hostile acid pool (radius 38, 0.75s warning, ~4.2s life). Excluded from wave picks when the arena's minimum dimension is below 300px. - -**Bulwark** — 60 HP, speed 38, damage 2, radius 23, XP 3; floor 5, weight 8. Slowly faces the player; hits within ±70° of its front deal 20%, flank/rear hits full. Resists on-hit stun and cannot be elite. - -**Flenserling** — 22 HP, speed 150, damage 2, radius 16, XP 3; floor 5, weight 7. Periodically phases untargetable, appears behind the aim vector, and lunges. - -**Choirmaster** — 40 HP, speed 50, damage 1, radius 19, XP 4; floor 6, weight 6. Its 180px aura grants +35% speed and heals nearby non-boss monsters ~1.8% max HP per second (minimum 0.5). At most one is selected by a normal wave. - -**Brood Sac** — 45 HP, speed 20, damage 1, radius 22, XP 4; floor 7, weight 6. Spawns 2 Minis every 4s and 4 on death. At most two are wave-selected; the brood population cap is 40. Cannot be elite and is excluded from thin halls. - ## Elites Any wave-spawned enemy can roll as an **elite** (gold ring, HP bar pip): diff --git a/docs/items.md b/docs/items.md index c7d8571..3e10e91 100644 --- a/docs/items.md +++ b/docs/items.md @@ -1,6 +1,6 @@ # Items -All **72 passive items** in MeatSlicer, with exact effects pulled from `js/items.js` and the proc logic in `js/enemies.js` / `js/player.js`. +All **82 passive items** in MeatSlicer, with exact effects pulled from `js/items.js` and the proc logic in `js/enemies.js` / `js/player.js`. --- @@ -37,7 +37,7 @@ Legendary items are **boss-exclusive** — they never roll from item rooms or el ## Damage & Fire Rate -| Item | Description | Effect per tier | +| Item | Description | Exact effect per tier | |---|---|---| | **Hollow Points** | +25% damage | `dmgMul ×1.25` | | **Marrow Glut** | +20% damage, −10% fire rate | `dmgMul ×1.20`, `rateMul ×0.90` | @@ -53,7 +53,7 @@ Note: attack size (`sizeMul`) also enlarges melee arcs, blast radii, acid pools, ## Shot Modifiers -| Item | Description | Effect per tier | +| Item | Description | Exact effect per tier | |---|---|---| | **Scalpel** | +25% shot speed | `shotSpeedMul ×1.25` | | **Lead Marrow** | +25% range | `rangeMul ×1.25` | @@ -123,7 +123,7 @@ All of these trigger from your weapon hits (orbital knives proc at half chance). ## Criticals -| Item | Description | Effect per tier | +| Item | Description | Exact effect per tier | |---|---|---| | **Bloodshot Eye** | +6% critical chance | `crit +0.06` (base 5%) | | **Hollow Needle** | +50% critical damage | `critMul +0.50` (base ×2.0) |