Skip to content

Latest commit

 

History

30 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🗺️ Encounters Guide

A map-first wild-encounter guide for Gen1Recomp.

One read-only mod — know where to find every wild Pokémon, straight from your imported ROM:

  • Encounter Guide — walk the real Kanto Town Map, hop between encounter-bearing locations, and drill down to exact routes, floors, and buildings, with truthful level ranges and per-step odds derived from your imported ROM.

API 2 Profile: Content Read-only Tests Platform


Screenshots

PKMN MAP (Kanto) Walking HUD Encounter List
PKMN MAP Walking HUD Encounter List

Features

🗺️ Encounter Guide

  • The real Kanto map — artwork and coordinates come from your locally imported ROM. Nothing is bundled or redrawn.
  • Map-first navigation — only locations with wild encounters are selectable; the cursor snaps between them.
  • Exact source identity — floors, caves, gates, buildings, and Pokémon Centers are never blended. -- MT. MOON 1F stays honest about being an interior.
  • You are here — a blinking white marker shows your current location on Kanto, even where that spot has no wild encounters.
  • Walking HUD — while exploring, a top-right panel lists the current area's LAND and WATER species with their exact level ranges; it hides itself in menus and battles.
  • HUD modes — AUTO (only while standing on grass or water, showing just that table), ALWAYS, or OFF, from the Options menu or the H key.
  • HUD sizes — SMALL, MEDIUM, or LARGE from the Options menu (ENC. GUIDE SIZE).
  • Owned markers — caught Pokémon carry the Pokédex ball, on the walking HUD and in every species list.
  • LAND and WATER as separate views — no deceptive merged tables.
  • Compact level ranges, full odds on demandZUBAT Lv. 8-10 up top, then every exact level with its chance per movement step.
  • SELECT opens the complete list — catches every encounter source, including any that lack Town Map coordinates.
  • Pure ROM-derived data — works with Red, Blue, or Yellow; zero hard-coded species tables; no copyrighted content shipped.

Install

  1. Open MODS in Gen1Recomp (F10 on desktop).
  2. Import mod .zip and select wills_mod-1.0.1.zip.
  3. Enable Encounters Guide.

Works on desktop and Android. Requires an imported Pokémon Red, Blue, or Yellow ROM.

💡 Mods are loaded from the installed copy. After editing source, rebuild (python3 tools/bundle.py), repack, and re-import — tests alone don't update a running game.

Usage

Encounter Guide

Input Action
D-pad Move between encounter-bearing locations on Kanto
A Open the selected location's exact source maps
A (in lists) Drill down: source → LAND/WATER → species → levels
SELECT Jump to the complete location list (incl. unmapped sources)
B Back one level
H Cycle the walking HUD: AUTO → ALWAYS → OFF
START → PKMN MAP
  → KANTO MAP                (D-pad, A to select)
    → MT. MOON               (grouped Town Map marker)
      → -- MT. MOON 1F       (exact source, always separate)
        → LAND · WATER       (never merged)
          → ZUBAT  Lv. 8-10  (truthful compact range)
            → Lv. 8  · 1.95% (exact per-step odds)

How it works

your imported ROM
      │  (Gen1Recomp extraction)
      ▼
generated data  ──►  model.lua          ──►  screens (list + detail)
(encounters,      │   groups sources,        │
 field/townMap,   │   never merges maps,     ▼
 pokemon,         │   sums duplicate slots,  ListMenu UI (A open / B back)
 constants)       └── calculates odds        MapScreen (D-pad cursor)

The mod is read-only: it never touches saves, encounter mechanics, or link state.

Project layout

.
├── main.lua               # self-contained release entry (generated)
├── lib/
│   ├── entry.lua          # screen registration + hook wraps          (source of truth)
│   ├── model.lua          # source grouping, methods, levels, buckets, odds
│   ├── names.lua          # player-facing map/source labels
│   ├── screens.lua        # ListMenu-based area/source/method/species screens
│   ├── map_screen.lua     # Town Map viewer: ROM tiles, cursor, markers, controls
│   └── hud.lua            # walking HUD: per-area species panel via render.hud
├── tools/bundle.py        # deterministic bundler: lib/ → main.lua
├── tests/                 # LÖVE test suite (10 files, fixtures + live Blue cache)
├── manifest.json          # mod metadata (id: wills_mod, github: illanrego/wills-mod)
├── mod.card               # launcher-facing description
└── dist/                  # importable release ZIPs

Development

Requires any LÖVE 11+ runtime (the Gen1Recomp AppImage bundles one) plus the official modkit.py tooling.

# run the test suite (fixtures + your imported Blue cache)
WILLS_MOD_ROOT="$PWD" love tests/runner

# regenerate main.lua after editing lib/
python3 tools/bundle.py

# official mod validation, ROM-content lint, and packaging
modkit validate --base fixture --strict .
modkit lint .
modkit pack -o dist/wills_mod-1.0.1.zip .

Every release gate runs before tagging: 10/10 test files green → strict loader validation → no-ROM-content lint → clean archive → live in-game smoke test.

Scope

  • Covered: walking/LAND and Surf/WATER encounter tables.
  • Deferred (truthfully labeled later): fishing, static encounters, gifts, trades, prizes, and Game Corner — each deserves its own honest acquisition method before it appears in the guide.

Roadmap

  • v0.1.0 — Encounter Guide: exact-source area browser, LAND/WATER separation, odds
  • v0.2.0 — map-first Kanto navigation on ROM-generated artwork
  • v0.3.0 — PKMN MAP menu entry + blinking player-position marker
  • v0.4.0 — walking HUD with per-area species and level ranges
  • v0.5.0 — HUD modes (AUTO/ALWAYS/OFF + H key + options menu) and owned-ball markers
  • v0.6.0 — HUD size option (SMALL/MEDIUM/LARGE)
  • v0.1.0–0.1.5 — Battle HUD owned-ball markers (feature removed in v1.0.1 — covered by other mods)
  • v1.0.0 — Encounters Guide: both tools merged into one install
  • Red/Yellow data pass on real caches
  • Fishing as its own method

Credits

  • Gen1Recomp — the decompiled-Gen-1 runtime, public mod API, and UI toolkit this mod is built on.
  • pret/pokered — the original disassembly reference behind the data extraction.
  • Built for Illan, who wanted to know what's in the tall grass before stepping in it — and which ones he still needs.

About

Catch-'em-all toolkit for Gen1Recomp: map-first encounter guide plus owned-ball battle HUD.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages