pokemon/gen1recomp
1
0
Fork 0
mirror of https://github.com/bryanthaboi/gen1recomp.git synced 2026-08-12 08:21:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): add support for Blue and Yellow

Browse Source
This commit is contained in:
Max 👨🏽‍💻 Coplan
2026-08-03 17:09:20 -07:00
parent 8da51aa7ba
commit 8d11c04d43
2 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/new-features.md
+4 -4
View File
@@ -1,10 +1,10 @@
# New features (deliberate additions beyond the original) # New features (deliberate additions beyond the original)
Intentional enhancements this port adds on top of faithful Pokémon Red Intentional enhancements this port adds on top of faithful Pokémon Red, Blue,
behavior. They have no Game Boy equivalent and are kept by design. and Yellow behavior. They have no Game Boy equivalent and are kept by design.
Genuine divergences from the original (things still missing, wrong, or Genuine divergences from the original (things still missing, wrong, or
approximated) live in docs/known-differences.md; faithfully-ported approximated) live in docs/known-differences.md; faithfully-ported behavior is
behavior is in docs/behavior-porting-notes.md. in docs/behavior-porting-notes.md.
## Survey zoom ## Survey zoom
docs/required-to-function.md
+8 -7
View File
@@ -1,12 +1,11 @@
# What This Port Requires # What This Port Requires
The packaged desktop app requires one user-supplied input on first boot: a 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 The importer verifies the SHA-1 for the game (see `src/core/GameVersion.lua`
`ea9bcae617fdf159b045185467ae58b2e4a48b9a`. Other revisions, Virtual for specific hashes). Other revisions and Virtual Console releases are rejected
Console releases, and Pokemon Blue are rejected rather than decoded with rather than decoded with incorrect addresses.
incorrect addresses.
After verification, the app generates its private cache in the LÖVE save 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. 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 ## Bundled Metadata
Assembly removes high-level names and some relationships that the Lua port 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 - symbolic IDs and ordering for maps, species, moves, items, and trainers
- source-erased dimensions, image names, and map object integration names - source-erased dimensions, image names, and map object integration names
- hand-ported field/script integration tables - hand-ported field/script integration tables