From 8d11c04d4390f127546daef075a6e64362d14a27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Max=20=F0=9F=91=A8=F0=9F=8F=BD=E2=80=8D=F0=9F=92=BB=20Copl?= =?UTF-8?q?an?= Date: Mon, 3 Aug 2026 17:09:20 -0700 Subject: [PATCH] fix(docs): add support for Blue and Yellow --- docs/new-features.md | 8 ++++---- docs/required-to-function.md | 15 ++++++++------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/new-features.md b/docs/new-features.md index c3e6d30f..02aab6ec 100644 --- a/docs/new-features.md +++ b/docs/new-features.md @@ -1,10 +1,10 @@ # New features (deliberate additions beyond the original) -Intentional enhancements this port adds on top of faithful Pokémon Red -behavior. They have no Game Boy equivalent and are kept by design. +Intentional enhancements this port adds on top of faithful Pokémon Red, Blue, +and Yellow behavior. They have no Game Boy equivalent and are kept by design. Genuine divergences from the original (things still missing, wrong, or -approximated) live in docs/known-differences.md; faithfully-ported -behavior is in docs/behavior-porting-notes.md. +approximated) live in docs/known-differences.md; faithfully-ported behavior is +in docs/behavior-porting-notes.md. ## Survey zoom diff --git a/docs/required-to-function.md b/docs/required-to-function.md index b6b6ea2a..bc681949 100644 --- a/docs/required-to-function.md +++ b/docs/required-to-function.md @@ -1,12 +1,11 @@ # What This Port Requires The packaged desktop app requires one user-supplied input on first boot: a -canonical 1 MiB US Pokemon Red ROM. +canonical 1 MiB US Pokemon Red, Blue, or Yellow ROM. -The importer verifies SHA-1 -`ea9bcae617fdf159b045185467ae58b2e4a48b9a`. Other revisions, Virtual -Console releases, and Pokemon Blue are rejected rather than decoded with -incorrect addresses. +The importer verifies the SHA-1 for the game (see `src/core/GameVersion.lua` +for specific hashes). Other revisions and Virtual Console releases are rejected +rather than decoded with incorrect addresses. After verification, the app generates its private cache in the LÖVE save directory. It does not keep a copy of the ROM. Later boots use the cache. @@ -15,9 +14,11 @@ Python and Pillow are not required by the packaged app. ## Bundled Metadata Assembly removes high-level names and some relationships that the Lua port -needs. `tools/rom_manifest.json` therefore contains: +needs. The version-specific files `tools/rom_manifest.json`, +`tools/rom_manifest_blue.json`, and `tools/rom_manifest_yellow.json` therefore +contain: -- the 3,268 ROM symbol addresses actually read by the extractor +- the ROM symbol addresses actually read by the extractor - symbolic IDs and ordering for maps, species, moves, items, and trainers - source-erased dimensions, image names, and map object integration names - hand-ported field/script integration tables