diff options
author | Rangi <remy.oukaour+rangi42@gmail.com> | 2020-07-13 21:21:42 -0400 |
---|---|---|
committer | Rangi <remy.oukaour+rangi42@gmail.com> | 2020-07-13 21:21:42 -0400 |
commit | 9b27adaf0288dc4fefa77cfe4457ab2cb7676582 (patch) | |
tree | 50856796d095dbfc545667d254c8b26e215658be | |
parent | a304573fcb27b5c709c3b3075568284044d548a9 (diff) |
Document G/S-only bugs and glitches (fixes #52)
-rw-r--r-- | docs/bugs_and_glitches.md | 94 |
1 files changed, 94 insertions, 0 deletions
diff --git a/docs/bugs_and_glitches.md b/docs/bugs_and_glitches.md new file mode 100644 index 00000000..965700b7 --- /dev/null +++ b/docs/bugs_and_glitches.md @@ -0,0 +1,94 @@ +# Bugs and Glitches + +These are known bugs and glitches in the original Pokémon Gold and Silver games: code that clearly does not work as intended, or that only works in limited circumstances but has the possibility to fail or crash. + +Fixes are written in the `diff` format. If you've used Git before, this should look familiar: + +```diff + this is some code +-delete red - lines ++add green + lines +``` + +All the bugs documented here were fixed in Pokémon Crystal. Any that weren't are already documented in [the pokecrystal repo](https://github.com/pret/pokecrystal/blob/master/docs/bugs_and_glitches.md), so they're not duplicated here. + + +## Contents + +- [Using the Coin Case can cause arbitrary code execution](#using-the-coin-case-can-cause-arbitrary-code-execution) +- [Entering the Hall of Fame without a save file can corrupt the PC boxes](#entering-the-hall-of-fame-without-a-save-file-can-corrupt-the-pc-boxes) +- [The Lucky Number Show does not find winning ID numbers in inactive boxes 10-14](#the-lucky-number-show-does-not-find-winning-id-numbers-in-inactive-boxes-10-14) +- [Present's text overflows when it fails to heal an enemy Pokémon with a long name](#presents-text-overflows-when-it-fails-to-heal-an-enemy-pokémon-with-a-long-name) +- [You can fish in the water in Cerulean Gym](#you-can-fish-in-the-water-in-cerulean-gym) + + +## Using the Coin Case can cause arbitrary code execution + +([Videos](https://www.youtube.com/playlist?list=PLO3UplJNTO8YGl0na5FT_6dVYsC27D0rk)) + +**Fix:** Edit `_CoinCaseCountText` in [data/text/common_3.asm](https://github.com/pret/pokegold/blob/master/data/text/common_3.asm): + +```diff +-; BUG: "done" is not a valid terminator here, needs to change to "text_end" + _CoinCaseCountText:: + text "Coins:" + line "@" + text_decimal wCoins, 2, 4 +- done ++ text_end +``` + + +## Entering the Hall of Fame without a save file can corrupt the PC boxes + +([Video](https://www.youtube.com/watch?v=lxkQ7QdfdqM)) + +**Fix:** Edit `HallOfFame` in [engine/events/halloffame.asm](https://github.com/pret/pokegold/blob/master/engine/events/halloffame.asm): + +```diff +-; Bug: Gold/Silver fail to (conditionally) erase the previous save and +-; initialize the current save, if the player did not save on this playthrough. ++ ld a, [wSavedAtLeastOnce] ++ and a ++ jr nz, .saved ++ farcall ErasePreviousSave ++.saved +``` + + +## The Lucky Number Show does not find winning ID numbers in inactive boxes 10-14 + +**Fix:** Edit `CheckForLuckyNumberWinners` in [engine/events/lucky_number.asm](https://github.com/pret/pokegold/blob/master/engine/events/lucky_number.asm): + +```diff +- ; BUG: fails to find winning mon in boxes 10-14 if not the active box +- cp NUM_BOXES_JAPANESE ++ cp NUM_BOXES + jr c, .BoxesLoop +``` + + +## Present's text overflows when it fails to heal an enemy Pokémon with a long name + +**Fix:** Edit `CantReceiveGiftText` in [data/text/battle.asm](https://github.com/pret/pokegold/blob/master/data/text/battle.asm): + +```diff +-; BUG: Pokémon names 8-10 characters long can overflow the textbox, +-; printing as "Enemy 1234567890 can't": up to 21 characters, over 18. + CantReceiveGiftText: +- text "<TARGET> can't" +- line "receive the gift!" ++ text "<TARGET>" ++ line "refused the gift!" + prompt +``` + + +## You can fish in the water in Cerulean Gym + +**Fix:** Edit `MapGroup_Cerulean` in [data/maps/maps.asm](https://github.com/pret/pokegold/blob/master/data/maps/maps.asm): + +```diff +- map CeruleanGym, TILESET_PORT, INDOOR, LANDMARK_CERULEAN_CITY, MUSIC_GYM, TRUE, PALETTE_DAY, FISHGROUP_SHORE ++ map CeruleanGym, TILESET_PORT, INDOOR, LANDMARK_CERULEAN_CITY, MUSIC_GYM, TRUE, PALETTE_DAY, FISHGROUP_NONE +``` |