diff options
| -rw-r--r-- | SL0P.md | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/SL0P.md b/SL0P.md new file mode 100644 index 00000000..a498a3eb --- /dev/null +++ b/SL0P.md @@ -0,0 +1,58 @@ +# POKéMON SL0P EDITION + +A cheeky romhack of Pokémon Yellow, built on the [pret/pokeyellow](https://github.com/pret/pokeyellow) +disassembly. All the mods live in a handful of files and are toggled/used +entirely in-game — no external cheat device. + +## Features + +### ⚡ Fastboot +If a save exists, the game skips the GameFreak intro, the title screen, and the +CONTINUE menu, and drops you straight into your save. (New game still shows the +normal flow.) +- `home/init.asm` / `engine/movie/intro.asm` — skip the intro +- `engine/movie/title.asm` — skip the title +- `engine/menus/main_menu.asm` — autoload + splash + +### 🎬 Custom intro splash +A brief **POKéMON / SL0P / EDITION** graphic (a real 2bpp image, not text) is +shown for ~2s on boot. +- `engine/slop_intro.asm` + `gfx/slop/intro.png` (built with a custom rgbgfx + Makefile rule → deduped tiles + tilemap) + +### 🎛️ SL0P MENU — press **SELECT** in the overworld +A table-driven cheat menu. Cursor + A to pick, B to back out / close. + +| Entry | Effect | +|-------|--------| +| **WARP** | submenu: fly-warp to any of 13 destinations (all towns + Route 4/10) | +| **HEAL** | full HP + clear status for the whole party | +| **MONEY** | ¥999,999 | +| **COINS** | 9,999 game-corner coins | +| **BADGES** | all 8 gym badges | +| **DEX** | mark every Pokémon owned + seen | +| **MAXTEAM** | whole party → Lv100, perfect DVs, maxed EVs, 999 stats/HP | +| **TEACH** | give every party member Hyper Beam / Earthquake / Ice Beam / Thunderbolt | +| **HMS** | give all five HMs (Cut/Fly/Surf/Strength/Flash) | +| **ITEMS** | submenu: give ×99 of balls, Rare Candy, Full Restore, Max Revive, Max Elixer, PP Up, and all five evolution stones | +| **NOWILD** | toggle wild encounters off (shows `ON`) | +| **REPEL** | refill repel steps | + +Everything is in `engine/slop_menu.asm`. Adding a new entry = add a name to +`SlopMenuText`, a `dw Handler` to `SlopMenuHandlers`, and bump `SLOP_MENU_COUNT`. +Handlers return carry set (a warp/exit was started) or clear (back to the menu), +and can be submenus or one-shot actions. + +Persistent toggle flags live in `wSlopNoWild` (the repurposed unused `wc5d8`). + +### TODO +- **NOCLIP** (walk-through-walls): prototyped, but its hook lands in the full + home bank (ROM0). Needs ~5 bytes of home budget reclaimed first. + +## Build + +```sh +make # -> pokeyellow.gbc (rgbds 1.0.1) +``` + +The build is reproducible; the intro graphic regenerates from `gfx/slop/intro.png`. |