Guides:Glitch Pokédex Mode ACE setup: Difference between revisions

Content deleted Content added
TimoVM (talk | contribs)
TimoVM (talk | contribs)
 
(16 intermediate revisions by the same user not shown)
Line 154: Line 154:
Have the following pokémon in the box:
Have the following pokémon in the box:
# Two Bellsprout
# Two Bellsprout
# Ine normal Pokémon.
# One normal Pokémon.


Keep in mind that all these pokémon, with the exception of the normal pokémon, will be corrupted during this process. Please make sure to obtain copies of these pokémon using normal cloning if you wish to keep any of them.
Keep in mind that all these pokémon, with the exception of the normal pokémon, will be corrupted during this process. Please make sure to obtain copies of these pokémon using normal cloning if you wish to keep any of them.
Line 207: Line 207:
* Prepare a mail and box name code
* Prepare a mail and box name code
* Sell TMs in specific quantities in order to be able to run the Mail Writer
* Sell TMs in specific quantities in order to be able to run the Mail Writer
* Use Wrong Pocket TM25 to run the Mail Writer and clean up the side-effects of the setup.
* Use Wrong Pocket TM33 to run the Mail Writer and clean up the side-effects of the setup.


==Step 4: Setting up the Mail Writer==
==Step 4: Setting up the Mail Writer==


Give any party pokémon a mail with the following language-dependent content to hold:
* Make sure you have at least one item in the main item pocket. This item will be overwritten to become a TM33.
* Give any party pokémon a mail with the following language-dependent content to hold:


{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
! English !! Italian & Spanish
! English !! Italian || Spanish
|-
|-
|
|
Line 223: Line 222:
|}
|}


* We'll set up TM33 and obtain 255 copies of every TM using a single execution. Write the following box name codes:
We'll set up TM33 and obtain 255 copies of every TM using a single execution. Write the following box name codes:


{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
Line 244: Line 243:
You can use Glitch Pokédex Mode ACE using the following process:
You can use Glitch Pokédex Mode ACE using the following process:


* In case you have more than one Key Item, make sure that the Mystery Egg is located at the top of the key item pocket.
* Make sure you have an item you can afford to miss in the first slot of the main item pocket.
* Read the held mail that was previously given to a party pokémon.
* Read the held mail that was previously given to a party pokémon.
* Open the start menu and open the pokédex. If the mail and box name codes were written correctly, this will immediately open and automatically close the pokédex.
* Open the start menu and open the pokédex. If the mail and box name codes were written correctly, this will immediately open and automatically close the pokédex.

===Effect of the mail and box name code===


The code that we used had the following effects.
The code that we used had the following effects.
Line 256: Line 253:
* Code was added to ensure that using TM33 executes code in the TM/HM pocket.
* Code was added to ensure that using TM33 executes code in the TM/HM pocket.


Make sure to verify that the TM33 is present and all TMs have a quantity of 255 before continuing. '''Do not use this TM33 yet! This TM will allow us to execute the contents of the TM/HM pocket as code, but due to the specific quantities currently present it will be guaranteed to crash the game.'''
'''Before continuing, make sure to verify that a TM33 is present in the Main Item pocket and that all TMs have a quantity of 255.'''

'''Do not use this TM33 yet! This TM will allow us to execute the contents of the TM/HM pocket as code, but due to the specific quantities currently present it will be guaranteed to crash the game.'''


===Troubleshooting===
===Troubleshooting===
Line 394: Line 393:


# It is recommended to save before continuing.
# It is recommended to save before continuing.
# Use TM33. If everything went correctly, this will start the mail writer and open a screen asking you to input text for a mail.
# Use TM33. If everything went correctly, this will start the mail writer and open a screen asking you to input text for a mail.
# Due to limitations, there is no in-built option to safely exit the mail writer. Instead, you can safely exit by typing the below mail, selecting END on the mail screen, then pressing START to execute the mail.
# From now on, you can repeat this process at any time to start the mail writer.

# The next section will elaborate on the usage of the Mail Writer. Please read these instructions carefully before proceeding.
{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
|
[[File:Mail_English_GS_Rh.png]]
|}

From now on, you can repeat this process at any time to start the mail writer.

'''The next section will elaborate on the usage of the Mail Writer. Please read these instructions carefully before proceeding.'''


===Troubleshooting & repairing TM33===
===Troubleshooting & repairing TM33===
Line 404: Line 411:
'''Please mind the differences between uppercase X ([[File:Character UCX.png]]), lowercase x ([[File:Character lcx.png]]) and multiplication symbol ([[File:Character mul.png]])'''.
'''Please mind the differences between uppercase X ([[File:Character UCX.png]]), lowercase x ([[File:Character lcx.png]]) and multiplication symbol ([[File:Character mul.png]])'''.
{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
! English !! Italian !! Spanish
|-
|
|
[[File:Reset box code GSEN.png]]
[[File:Reset box code GSEN.png]]
| colspan="2" |
[[File:Box Italian GS Reset.png]]
|}
|}


Line 412: Line 423:
* Open the pokédex. If the pokédex opens and immediately closes, the setup will have worked.
* Open the pokédex. If the pokédex opens and immediately closes, the setup will have worked.


===How the mail writer works===
==Step 7 : How the mail writer works==


'''From now on, simply use TM33 to start up the mail writer.'''
Upon execution, the Mail writer will open the mail character entry screen where the player can write up to 32 different characters. After the player has confirmed the mail, the following actions take place:


* The Mail writer will take pairs of characters and convert them into a single combined value. These values are then sequentially written, converting the 32 letter mail into a 16 byte long line of code.
The mail writer will open a screen that asks you to write the contents of a mail. This is where you'll need to enter mail codes. Once done, use the "END" option to finish the mail.
* Next, the Mail writer will display a checksum calculated from the combined value of all written bytes for the player to verify. Then the program enters a waiting state where they can either choose to write another mail, go back and correct previously written values or stop the mail writer and execute the newly written payload.
* If the player has chosen to write a new mail, the Mail writer will open a new mail entry screen. The new mail is then also converted into a 16 byte long line of code and placed right after the code written by the previous mail(s), allowing the player to write arbitrarily long payloads.
* Assembly can easily be converted to mail codes using [https://timovm.github.io/MailConverter/ TimoVM's MailConverter]. Simply paste the assembly of the code you wish to enter here, press "run" and the converter will automatically generate mail codes requiring the least amount of button presses to write.


This will cause the mail writer to convert the newly written code into assembly. It will also '''print a checksum''' (sum of all written values) on the screen just to the right of the lower row. This can be used to verify if a code was entered correctly.
===Mail Writer Controls===

Due to a lack of available memory in the TM/HM pocket, it is not possible to quit the RAM writer without executing the newly written code. '''If you ever accidentally activate the mail writer and would like to quit, simply write a mail containing "Rh", then confirm and exit the RAM writer.'''

{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
|
[[File:Mail_English_GS_Rh.png]]
|}

Assembly can easily be converted to mail codes using [https://timovm.github.io/MailConverter/ TimoVM's MailConverter]. Simply paste the assembly of the code you wish to enter here, press "run" and the converter will automatically generate mail codes requiring the least amount of button presses to write.

===Controls===


Between entering mail codes, the mail writer will ask for user input.
Between entering mail codes, the mail writer will ask for user input.
* '''Press A''' to open a new mail and continue writing data.
* '''Press SELECT''' to open a new mail and continue writing data.
* '''Press B''' to immediately jump to and start executing the newly written program. '''Only use this when you've finished every mail.'''
* '''Press START''' to immediately jump to and start executing the newly written program. '''Only use this when you've finished every mail.'''
* '''Press any other button''' to go back one byte at a time to correct errors. '''If the printed checksum doesn't match the expected checksum, press DOWN 16 times to retry the last mail.''' This will also overwrite the printed checksum with the value at the currently selected address, giving you a method to check how far back you're going.
* '''Press any other button''' to go back one byte at a time to correct errors. '''If the printed checksum doesn't match the expected checksum, press DOWN 16 times to retry the last mail.''' This will also overwrite the printed checksum with the value at the currently selected address, giving you a method to check how far back you're going.


{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
==Step 7: Using the Mail Writer to fix the side effects of the setup==
| [[File:Mail writer write mode.png|288px]] || [[File:Mail writer input mode.png|288px]]
|-
| Enter your mail code, then press "END". || It prints the checksum and waits for input.
|}

==Step 8: Improving the setup==


Finally, we can both test the Mail Writer and fix the side effects of the setup. '''Please note that, for safety reasons, this cleanup code will not disable Glitch Pokédex Mode ACE'''. A second code will be provided that allows you to alter the current Pokédex Mode directly.
Finally, we can both test the Mail Writer and fix the side effects of the setup. '''Please note that, for safety reasons, this cleanup code will not disable Glitch Pokédex Mode ACE'''. A second code will be provided that allows you to alter the current Pokédex Mode directly.

Since the mail writer is written using TM quantities, using or gaining TMs will break the mail writer. Because of this, we'll use the mail writer to execute a code that achieves the following:
* Copies the mail writer to unused memory
* Overwrite the existing quantities in the TM/HM pocket to x1 for every TM
* Alter TM33's underlying code to execute the mail writer in unused memory
* As a bonus, we'll also fix the side effects of the setup. '''Please note that, for safety reasons, this cleanup code will not disable Glitch Pokédex Mode ACE'''. A second code will be provided that allows you to alter the current Pokédex Mode directly.
You can use the mail code converter page as follows:
* Copy the code in the table below
* Follow the link at the top of the table to the mail code converter
* Paste the code in the text box on the code converter's page
* Select the correct language and version
* Click on the "Run" button to display the mails you need to enter


Simply copy the assembly code that is applicable for your setup, then click the link at the top of the table to go to the MailConverter tool. Make sure to select the current language and "Gold/Silver" as version.
Simply copy the assembly code that is applicable for your setup, then click the link at the top of the table to go to the MailConverter tool. Make sure to select the current language and "Gold/Silver" as version.

'''Before executing this code, make sure to swap the glitch pokémon into the last party slot. Make sure the MYSTERY EGG is in the last key item slot.'''


{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
{| class="wikitable" style="margin-left: auto; margin-right: auto; border: none;"
|+ Codes to be used with [https://timovm.github.io/MailConverter/ TimoVM's MailConverter]
|+ Codes to be used with [https://timovm.github.io/MailConverter/ TimoVM's MailConverter]
|-
|-
! Language !! Gold & Silver
! All languages
|-
! scope="row"| English
||
11 F2 D6 21 1B D4 73 23 72 2E 18 2A 12 13 2A 12
13 21 7E D5 E5 CD 23 12 3E 01 0E 32 E1 CD 4C 31
2E FC 22 2E E1 CD 8F DD 21 7A D6 2A 23 22 21 03
DC CB BE 2E 23 CB BE 21 22 DA 4E 35 09 36 FF C9
|-
! scope="row"| Italian
||
11 F2 D6 21 1B D4 73 23 72 2E 18 2A 12 13 2A 12
13 21 7E D5 E5 CD 39 12 3E 01 0E 32 E1 CD 71 31
2E FC 22 2E E1 CD 8F DD 21 7A D6 2A 23 22 21 03
DC CB BE 2E 23 CB BE 21 22 DA 4E 35 09 36 FF C9
|-
|-
! scope="row"| Spanish
||
||
21 7A D6 2A 23 F6 84 22 AF 21 E1 D5 35 47 4E 09
11 F2 D6 21 1B D4 73 23 72 2E 18 2A 12 13 2A 12
23 36 FF 2E FC 36 01 21 03 DC CB BE 2E 23 CB BE
13 21 7E D5 E5 CD 3C 12 3E 01 0E 32 E1 CD 70 31
21 22 DA 4E 35 09 36 FF C9
2E FC 22 2E E1 CD 8F DD 21 7A D6 2A 23 22 21 03
DC CB BE 2E 23 CB BE 21 22 DA 4E 35 09 36 FF C9
|}
|}


The cleanup code has the following effects:
The cleanup code has the following effects:
# Move the mail writer program to unused memory.
# Adjust TM33's code so that using it now activates the mail writer at its new location.
# Set all TM quantities to x1.
# Restore the previous PokéGear flags.
# Restore the previous PokéGear flags.
# Remove the last MYSTERY EGG from the key item pocket and add a CANCEL button at the end of the key item list.
# Remove the last MYSTERY EGG from the key item pocket and add a CANCEL button at the end of the key item list.
Line 467: Line 525:
The Mail writer allows you to easily write and execute arbitrary payloads. Aside from writing your own codes, we recommend the following:
The Mail writer allows you to easily write and execute arbitrary payloads. Aside from writing your own codes, we recommend the following:
* [[User:TimoVM/Mail Writer Codes|Mail codes]]: this page contains a collection of assembly for mail codes that can be used for a variety of common purposes such as editing pokémon, obtaining items, etc..
* [[User:TimoVM/Mail Writer Codes|Mail codes]]: this page contains a collection of assembly for mail codes that can be used for a variety of common purposes such as editing pokémon, obtaining items, etc..
* [[User:TimoVM/RAM Writer|RAM writer]]: (recommended for more experienced users) this page contains the assembly for a large one-size-fits all program that allows you to edit any value in RAM with a user-friendly GUI. It will also fix the side effects of the ACE setup when you first run it.
* [[User:TimoVM/RAM Writer|RAM writer]]: (recommended for more experienced users) this page contains the assembly for a large one-size-fits all program that allows you to edit any value in RAM with a user-friendly GUI.


=Appendix=
=Appendix=
Line 575: Line 633:
Converting the characters from box names to assembly results in the following code. Please note that the box name code overwrites part of itself, the translated assembly assumes the code was already used once.
Converting the characters from box names to assembly results in the following code. Please note that the box name code overwrites part of itself, the translated assembly assumes the code was already used once.


The code overwrites part of itself to call the byteFill function. This will fill the area between $D57E and $D5AF with $FF values, setting all 50 TM quantities to 255.
The code overwrites part of itself to be able to fill the area between $D57E and $D5AF with $FF values, setting all 50 TM quantities to 255.


Separately, this code overwrites the latter half of party pokémon #3's stat experience data, allowing it to function as a TM25 bootstrap that redirects execution to the Mail Writer.
Separately, this code targets $F418, TM33's execution pointer, and writes a 5-byte bootstreap allowing it to redirect execution to the Mail Writer.


Lastly, the value of the first item ID in the main item pocket is overwritten so that it becomes a TM25.
Lastly, the value of the first item ID in the main item pocket is overwritten so that it becomes a TM33.


<pre>
<pre>
Line 792: Line 850:
===Effect of the reset box name code===
===Effect of the reset box name code===


Converting the characters from box names to assembly results in the following code. This code overwrites the latter half of party pokémon #3's stat experience data, allowing it to function as a TM25 bootstrap that redirects execution to the Mail Writer.
Converting the characters from box names to assembly results in the following code. This code overwrites itself to target $D418, TM33's execution pointer, writing a 5-byte bootstrap that redirects TM33 execution to the Mail Writer.


<pre>
<pre>