Leahnaya/Poke_Transporter_GB
1
0
Fork 0
mirror of https://github.com/GearsProgress/Poke_Transporter_GB.git synced 2026-03-21 17:34:42 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
a5ed8b5bda
Poke_Transporter_GB/source/payload_builder.cpp
The Gears of Progress a5ed8b5bda Prep for Z80-ASM
2024-07-26 12:13:39 -04:00

1208 lines
45 KiB
C++
Raw Blame History

#include "payload_builder.h"
#include "gb_rom_values/base_gb_rom_struct.h"
#include "gb_rom_values/eng_gb_rom_values.h"
#include "debug_mode.h"
#include <iostream>
#include <fstream>
#include <iomanip>
byte payload_storage[PAYLOAD_SIZE] = {};
byte copy_table_storage[0x40] = {};
int copy_table_offset = 0;
#define copy_table_start 0xBF00
byte *generate_payload(GB_ROM curr_rom, int type, bool debug)
{
/* 10 RNG bytes
8 Preamble bytes
418 / 441 Party bytes
7 Preamble bytes
194 Patch list bytes (last 2 are unused)
637 / 660 total bytes
*/
int offset = 0;
if ((curr_rom.generation == 1 && curr_rom.method == METHOD_NEWLINE))
{
// RNG Seed:
// at 0x00, 0x0A in length
// Does not need to be set
// Preamble
// At 0x0A, 0x08 in length
// Must be filled with 0xFD
for (int i = 0; i < 8; i++)
{
payload_storage[0x0A + i] = 0xFD;
}
// Rival name
// At 0x12, 0x0B in length
// Set to stored name
for (int i = 0; i < 11; i++)
{
payload_storage[0x12 + i] = curr_rom.custom_name[i];
}
// Number of Pokemon
// At 0x1D, 0x01 in length
// Does not need to be set
payload_storage[0x1D] = 0x06;
// Pokemon list
// At 0x1E, can be up to 0x1A2 / 0x1B9 bytes in length.
// Calculate the number of Pokemon names that need to be printed,
// and add them to the list. Then terminate the list.
int distance = curr_rom.stack_overwrite_location - curr_rom.print_string_start;
distance /= 20; // Automatically truncated, so it won't overshoot
for (int i = 0; i < distance; i++)
{
payload_storage[0x1E + i] = curr_rom.short_pkmn_name;
}
payload_storage[0x1E + distance] = curr_rom.pointer_pkmn_name;
payload_storage[0x1E + distance + 1] = 0xFF;
// Patchlist preamble
// At 0x1B4 / 0x1D7, 0x07 in length
// Set as five 0xFD and two 0xFF
for (int i = 0; i < 7; i++)
{
payload_storage[0x1B4 + i] = (i < 5 ? 0xFD : 0xFF);
}
// Set the entrance vector
payload_storage[5] = 0xC3;
payload_storage[6] = curr_rom.enter_vector_location & 0xFF;
payload_storage[7] = (curr_rom.enter_vector_location >> 8) & 0xFF;
// Patchlist
// At 0x1BB / 0x1DE, 0xC2 in length (0xC4, but the last 2 are unused)
// Fill with custom code
int offset = 0x1BB;
/* Write transferring message to screen: */
// call ClearScreen
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.clearScreen >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.clearScreen >> 8) & 0xFF;
// ld hl, [upper left textbox corner in VRAM]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.textBorderUppLeft >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.textBorderUppLeft >> 8) & 0xFF;
// ld b, 3 [height]
payload_storage[offset++] = 0x06;
payload_storage[offset++] = (curr_rom.textBorderWidth >> 0) & 0xFF;
// ld c, 14 [width]
payload_storage[offset++] = 0x0E;
payload_storage[offset++] = (curr_rom.textBorderHeight >> 0) & 0xFF;
// call CableClub_TextBoxBorder
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.CableClub_TextBoxBorder >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.CableClub_TextBoxBorder >> 8) & 0xFF;
// ld hl, [transfer string location]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.transferStringLocation >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.transferStringLocation >> 8) & 0xFF;
// ld de, TransferWaitString
payload_storage[offset++] = 0x11;
payload_storage[offset++] = (curr_rom.transferWaitString >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.transferWaitString >> 8) & 0xFF;
// call PlaceString
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.placeString >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.placeString >> 8) & 0xFF;
/* Transfer box data: */
// ld hl, hSerialConnectionStatus
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 8) & 0xFF;
// ld [hl], 0x01 [Make sure GB is the slave, master if debug]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = (debug ? 0x02 : 0x01);
// ld hl, (wBoxDataStart - 1) [data to send]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - 1) >> 0) & 0xFF;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - 1) >> 8) & 0xFF;
// ld [hl], 0xFD [set the start of the data to 0xFD so Serial_ExchangeBytes is happy]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = 0xFD;
// ld de, (wBoxDataStart - 3) [location to put stored data]
payload_storage[offset++] = 0x11;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - (debug ? 2 : 3)) >> 0) & 0xFF;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - (debug ? 2 : 3)) >> 8) & 0xFF;
// ld bc, (wBoxDataEnd - wBoxDataStart) + 2
payload_storage[offset++] = 0x01;
payload_storage[offset++] = (((curr_rom.wBoxDataEnd - curr_rom.wBoxDataStart) + 2) >> 0) & 0xFF;
payload_storage[offset++] = (((curr_rom.wBoxDataEnd - curr_rom.wBoxDataStart) + 2) >> 8) & 0xFF;
// call Serial_ExchangeBytes [Send the box data]
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.Serial_ExchangeBytes >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.Serial_ExchangeBytes >> 8) & 0xFF;
/* Recieve the Pokemon to remove */
// ld hl, hSerialConnectionStatus
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 8) & 0xFF;
// ld [hl], 0x01 [Make sure GB is the slave, master if debug]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = (debug ? 0x02 : 0x01);
// ld hl, 0xC613 [data to send, garbage data]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.garbageDataLocation >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.garbageDataLocation >> 8) & 0xFF;
// ld de, 0xC651 [data to recieve]
payload_storage[offset++] = 0x11;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 8) & 0xFF;
// ld bc, 0x001E [size of data]
payload_storage[offset++] = 0x01;
payload_storage[offset++] = 0x1E;
payload_storage[offset++] = 0x00;
// call Serial_ExchangeBytes [Recieve the removal array]
if (debug)
{
offset += 3; // Don't add in the Serial_ExchangeBytes call if in debug
}
else
{
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.Serial_ExchangeBytes >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.Serial_ExchangeBytes >> 8) & 0xFF;
}
/* Remove the transfered Pokemon */
// ld hl, wRemoveMonFromBox
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.wRemoveMonFromBox >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.wRemoveMonFromBox >> 8) & 0xFF;
// ld [hl], [!= 0x00 specifies the current box]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = 0x01;
// ld a, [arrayCounter]
payload_storage[offset++] = 0xFA;
payload_storage[offset++] = (curr_rom.arrayCounter >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.arrayCounter >> 8) & 0xFF;
// ld e, a
payload_storage[offset++] = 0x5F;
// ld d, 0x00
payload_storage[offset++] = 0x16;
payload_storage[offset++] = 0x00;
// ld hl, [removalArray]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 8) & 0xFF;
// add hl, de
payload_storage[offset++] = 0x19;
// inc a
payload_storage[offset++] = 0x3C;
// ld [arrayCounter], a
payload_storage[offset++] = 0xEA;
payload_storage[offset++] = (curr_rom.arrayCounter >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.arrayCounter >> 8) & 0xFF;
// ld a, [wBoxCount]
payload_storage[offset++] = 0xFA;
payload_storage[offset++] = (curr_rom.wBoxCount >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.wBoxCount >> 8) & 0xFF;
// ld b, a
payload_storage[offset++] = 0x47;
// ld a, [hl]
payload_storage[offset++] = 0x2A;
// cp a, 0xFF
payload_storage[offset++] = 0xFE;
payload_storage[offset++] = 0xFF;
// jr z, 12
payload_storage[offset++] = 0x28;
payload_storage[offset++] = 0x0C;
// cp a, b
payload_storage[offset++] = 0xB8;
// jr nc, -26
payload_storage[offset++] = 0x30;
payload_storage[offset++] = 0xE6;
// ld hl, wWhichPokemon
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.wWhichPokemon >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.wWhichPokemon >> 8) & 0xFF;
// ld [hl], a
payload_storage[offset++] = 0x77;
// call _RemovePokemon
if (DONT_REMOVE_PKMN)
{
offset += 3;
}
else
{
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom._RemovePokemon >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom._RemovePokemon >> 8) & 0xFF;
}
// jr, -35
payload_storage[offset++] = 0x18;
payload_storage[offset++] = 0xDD;
/* Save the current box */
// ld b, 0x1C [memory bank of SaveSAVtoSRAM1]
payload_storage[offset++] = 0x06;
payload_storage[offset++] = (curr_rom.SaveSAVtoSRAM1 >> 16) & 0xFF;
// ld hl, SaveSAVtoSRAM1
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.SaveSAVtoSRAM1 >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.SaveSAVtoSRAM1 >> 8) & 0xFF;
// call Bankswitch [which will jump to what's loaded in HL]
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.Bankswitch >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.Bankswitch >> 8) & 0xFF;
// ld b, 0x1C [memory bank of SaveSAVtoSRAM2]
payload_storage[offset++] = 0x06;
payload_storage[offset++] = (curr_rom.SaveSAVtoSRAM1 >> 16) & 0xFF;
// ld hl, SaveSAVtoSRAM2
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.SaveSAVtoSRAM2 >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.SaveSAVtoSRAM2 >> 8) & 0xFF;
// call Bankswitch [which will jump to what's loaded in HL]
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.Bankswitch >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.Bankswitch >> 8) & 0xFF;
// jp SoftReset
payload_storage[offset++] = 0xC3;
payload_storage[offset++] = (curr_rom.SoftReset >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.SoftReset >> 8) & 0xFF;
// 1 byte to store the current array counter
// $C650
if (offset > (0x1BB + (194 - 72)))
{
std::cout << "# Error: Script exceeded by " << offset - (0x1BB + (194 - 72)) << " bytes!" << std::endl;
}
offset = 0x1BB + (194 - 72);
payload_storage[offset++] = 0x00;
// 40 byte storage for list of Pokemon to remove
// $C651
for (int i = 0; i < 40; i++)
{
if (debug)
{
payload_storage[offset++] = (i < 30 ? (29 - i) : 0xFF);
}
else
{
payload_storage[offset++] = (i < 30 ? 0xFD : 0xFF);
}
}
// permanent array terminator, just in case
// $C679
payload_storage[offset++] = 0xFF;
// TransferWaitString
// $C67A
for (int i = 0; i < 30; i++)
{
payload_storage[offset++] = curr_rom.transferString[i];
}
// This payload works by placing Pokemon ID 0xFC's name in the stack, and causing a return to CD8E,
// which is part of the RNG seed. From there we can jump anywhere- and we choose to jump to D887,
// which is the rival's name. This code fixes the stack and jumps to the patchlist, which is where
// our final code is.
}
else if ((curr_rom.generation == 1 && curr_rom.method == METHOD_MEW))
{
// RNG Seed:
// at 0x00, 0x0A in length
// Does not need to be set
// Preamble
// At 0x0A, 0x08 in length
// Must be filled with 0xFD
for (int i = 0; i < 8; i++)
{
payload_storage[0x0A + i] = 0xFD;
}
// Rival name
// At 0x12, 0x0B in length
// Set to stored name
for (int i = 0; i < 11; i++)
{
payload_storage[0x12 + i] = curr_rom.custom_name[i];
}
// Number of Pokemon
// At 0x1D, 0x01 in length
// Does not need to be set
payload_storage[0x1D] = 0x06;
// Pokemon list
// At 0x1E, can be up to 0x1A2 / 0x1B9 bytes in length.
// Calculate the number of Pokemon names that need to be printed,
// and add them to the list. Then terminate the list.
int distance = curr_rom.stack_overwrite_location - curr_rom.print_string_start;
distance /= 20; // Automatically truncated, so it won't overshoot
for (int i = 0; i < distance; i++)
{
payload_storage[0x1E + i] = (i != 277 ? curr_rom.short_pkmn_name : 0xC8);
}
payload_storage[0x1E + distance] = curr_rom.pointer_pkmn_name;
payload_storage[0x1E + distance + 1] = 0xFF;
// Add in the code for reloading the script, keeping in mind the MEWs
offset = 0x19E;
// ld hl, hSerialConnectionStatus
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 8) & 0xFF;
// ld [hl], 0x01 [Make sure GB is the slave, master if debug]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = (debug ? 0x02 : 0x01);
offset += 4; // Mew
// ld hl, 0x0161 [data to send, garbage data]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.garbageDataLocation >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.garbageDataLocation >> 8) & 0xFF;
// ld de, 0xC5D0 [data to recieve]
payload_storage[offset++] = 0x11;
payload_storage[offset++] = 0xD0;
payload_storage[offset++] = 0xC5;
// Relative jump, since that's all we have space for
// jr -47
payload_storage[offset++] = 0x18;
payload_storage[offset++] = 0xD1;
offset -= 47;
// ld bc, 0x00C2 [size of data]
payload_storage[offset++] = 0x01;
payload_storage[offset++] = 0xC2;
payload_storage[offset++] = 0x00;
// call Serial_ExchangeBytes [Refresh the patch section]
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.Serial_ExchangeBytes >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.Serial_ExchangeBytes >> 8) & 0xFF;
// ld a, 0x1C
payload_storage[offset++] = 0x3E;
payload_storage[offset++] = (curr_rom.SaveSAVtoSRAM1 >> 16) & 0xFF;
// call BankswitchCommon
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = 0x7E;
payload_storage[offset++] = 0x3E;
// call LoadSAV1
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = 0xFC;
payload_storage[offset++] = 0x79;
offset += 5; // Mew
// call LoadSAV2
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = 0x24;
payload_storage[offset++] = 0x7A;
// jump 0xC5D7
payload_storage[offset++] = 0xC3;
payload_storage[offset++] = 0xD6;
payload_storage[offset++] = 0xC5;
// Patchlist preamble
// At 0x1B4 0x07 in length
// Set as five 0xFD and two 0xFF
for (int i = 0; i < 7; i++)
{
payload_storage[0x1B4 + i] = (i < 5 ? 0xFD : 0xFF);
}
// Patchlist
// At 0x1BB / 0x1DE, 0xC2 in length (0xC4, but the last 2 are unused)
// Fill with custom code
int offset = 0x1BB;
if (type == TRANSFER)
{
// ld a, 0x01
payload_storage[offset++] = 0x3E;
payload_storage[offset++] = 0x01;
// call BankswitchCommon
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = 0x7E;
payload_storage[offset++] = 0x3E;
/* Write transferring message to screen: */
// call ClearScreen
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.clearScreen >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.clearScreen >> 8) & 0xFF;
// ld hl, [upper left textbox corner in VRAM]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.textBorderUppLeft >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.textBorderUppLeft >> 8) & 0xFF;
// ld b, 3 [height]
payload_storage[offset++] = 0x06;
payload_storage[offset++] = (curr_rom.textBorderWidth >> 0) & 0xFF;
// ld c, 14 [width]
payload_storage[offset++] = 0x0E;
payload_storage[offset++] = (curr_rom.textBorderHeight >> 0) & 0xFF;
// call CableClub_TextBoxBorder
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.CableClub_TextBoxBorder >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.CableClub_TextBoxBorder >> 8) & 0xFF;
// ld hl, [transfer string location]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.transferStringLocation >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.transferStringLocation >> 8) & 0xFF;
// ld de, TransferWaitString
payload_storage[offset++] = 0x11;
payload_storage[offset++] = (curr_rom.transferWaitString >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.transferWaitString >> 8) & 0xFF;
// call PlaceString
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.placeString >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.placeString >> 8) & 0xFF;
/* Transfer box data: */
// ld hl, hSerialConnectionStatus
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 8) & 0xFF;
// ld [hl], 0x01 [Make sure GB is the slave, master if debug]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = (debug ? 0x02 : 0x01);
// ld hl, (wBoxDataStart - 1) [data to send]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - 1) >> 0) & 0xFF;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - 1) >> 8) & 0xFF;
// ld [hl], 0xFD [set the start of the data to 0xFD so Serial_ExchangeBytes is happy]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = 0xFD;
// ld de, (wBoxDataStart - 3) [location to put stored data]
payload_storage[offset++] = 0x11;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - (debug ? 2 : 3)) >> 0) & 0xFF;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - (debug ? 2 : 3)) >> 8) & 0xFF;
// ld bc, (wBoxDataEnd - wBoxDataStart) + 2
payload_storage[offset++] = 0x01;
payload_storage[offset++] = (((curr_rom.wBoxDataEnd - curr_rom.wBoxDataStart) + 2) >> 0) & 0xFF;
payload_storage[offset++] = (((curr_rom.wBoxDataEnd - curr_rom.wBoxDataStart) + 2) >> 8) & 0xFF;
// call Serial_ExchangeBytes [Send the box data] (unless Debug)
if (debug)
{
offset += 3;
}
else
{
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.Serial_ExchangeBytes >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.Serial_ExchangeBytes >> 8) & 0xFF;
}
/* Recieve the Pokemon to remove */
// ld hl, hSerialConnectionStatus
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 8) & 0xFF;
// ld [hl], 0x01 [Make sure GB is the slave, master if debug]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = (debug ? 0x02 : 0x01);
// ld hl, 0x0161 [data to send, garbage data]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.garbageDataLocation >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.garbageDataLocation >> 8) & 0xFF;
// ld de, 0xC651 [data to recieve]
payload_storage[offset++] = 0x11;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 8) & 0xFF;
// ld bc, 0x001E [size of data] - Preamble does *not* count
payload_storage[offset++] = 0x01;
payload_storage[offset++] = 0x1E;
payload_storage[offset++] = 0x00;
// call Serial_ExchangeBytes [Recieve the removal array]
if (debug)
{
offset += 3; // Don't add in the Serial_ExchangeBytes call if in debug
}
else
{
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom.Serial_ExchangeBytes >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.Serial_ExchangeBytes >> 8) & 0xFF;
}
/* Remove the transfered Pokemon */
// ld hl, wRemoveMonFromBox
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.wRemoveMonFromBox >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.wRemoveMonFromBox >> 8) & 0xFF;
// ld [hl], [!= 0x00 specifies the current box]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = 0x01;
// ld a, [arrayCounter]
payload_storage[offset++] = 0xFA;
payload_storage[offset++] = (curr_rom.arrayCounter >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.arrayCounter >> 8) & 0xFF;
// ld e, a
payload_storage[offset++] = 0x5F;
// ld d, 0x00
payload_storage[offset++] = 0x16;
payload_storage[offset++] = 0x00;
// ld hl, [removalArray]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 8) & 0xFF;
// add hl, de
payload_storage[offset++] = 0x19;
// ld e, 0xFF
payload_storage[offset++] = 0x1E;
payload_storage[offset++] = 0xFF;
// inc a
payload_storage[offset++] = 0x3C;
// ld [arrayCounter], a
payload_storage[offset++] = 0xEA;
payload_storage[offset++] = (curr_rom.arrayCounter >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.arrayCounter >> 8) & 0xFF;
// ld a, [wBoxCount]
payload_storage[offset++] = 0xFA;
payload_storage[offset++] = (curr_rom.wBoxCount >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.wBoxCount >> 8) & 0xFF;
// ld b, a
payload_storage[offset++] = 0x47;
// ld a, [hl]
payload_storage[offset++] = 0x2A;
// cp a, e
payload_storage[offset++] = 0xBB;
// jr z, 12
payload_storage[offset++] = 0x28;
payload_storage[offset++] = 0x0C;
// cp a, b
payload_storage[offset++] = 0xB8;
// jr nc, -27
payload_storage[offset++] = 0x30;
payload_storage[offset++] = 0xE5;
// ld hl, wWhichPokemon
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.wWhichPokemon >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.wWhichPokemon >> 8) & 0xFF;
// ld [hl], a
payload_storage[offset++] = 0x77;
// call _RemovePokemon
if (DONT_REMOVE_PKMN)
{
offset += 3;
}
else
{
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (curr_rom._RemovePokemon >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom._RemovePokemon >> 8) & 0xFF;
}
// jr, -36
payload_storage[offset++] = 0x18;
payload_storage[offset++] = 0xDC;
/* Save the current box */
// ld a, 0x1C
payload_storage[offset++] = 0x3E;
payload_storage[offset++] = (curr_rom.SaveSAVtoSRAM1 >> 16) & 0xFF;
// call BankswitchCommon
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = 0x7E;
payload_storage[offset++] = 0x3E;
// call SaveSAVtoSRAM1
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = 0x32;
payload_storage[offset++] = 0x7B;
// call SaveSAVtoSRAM2
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = 0x56;
payload_storage[offset++] = 0x7B;
// jp SoftReset
payload_storage[offset++] = 0xC3;
payload_storage[offset++] = (curr_rom.SoftReset >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.SoftReset >> 8) & 0xFF;
// 1 byte to store the current array counter
// $C650
if (offset > (0x1BB + (194 - 72)))
{
std::cout << "Error: Script exceeded by " << offset - (0x1BB + (194 - 72)) << " bytes!" << std::endl;
}
offset = 0x1BB + (194 - 72);
payload_storage[offset++] = 0x00;
// 40 byte storage for list of Pokemon to remove
// $C651
for (int i = 0; i < 40; i++)
{
if (debug)
{
payload_storage[offset++] = (i < 30 ? (29 - i) : 0xFF);
}
else
{
payload_storage[offset++] = (i < 30 ? 0xFD : 0xFF);
}
}
// permanent array terminator, just in case
// $C679
payload_storage[offset++] = 0xFF;
// TransferWaitString
// $C67A
for (int i = 0; i < 30; i++)
{
payload_storage[offset++] = curr_rom.transferString[i];
}
// This payload works by placing Pokemon ID 0xFC's name in the stack, and causing a return to CD8E,
// which is part of the RNG seed. From there we can jump anywhere- and we choose to jump to D887,
// which is the rival's name. This code fixes the stack and jumps to the patchlist, which is where
// our final code is.
}
else if (type == EVENT)
{
// ld a, $03
payload_storage[offset++] = 0x3A;
payload_storage[offset++] = 0x03;
// call OpenSRAM
payload_storage[offset++] = 0xC3;
payload_storage[offset++] = (curr_rom.OpenSRAM >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.OpenSRAM >> 8) & 0xFF;
// ld de, $BEB0
payload_storage[offset++] = 0x11;
payload_storage[offset++] = 0xB0;
payload_storage[offset++] = 0xBE;
// ld bc, $150
payload_storage[offset++] = 0x01;
payload_storage[offset++] = 0x50;
payload_storage[offset++] = 0x01;
// ld hl, ???
payload_storage[offset++] = 0x21;
payload_storage[offset++] = 0x00;
payload_storage[offset++] = 0x00;
// CUSTOM EVENT SCRIPT:
// Start with the table data
int init_offset = offset;
insert_ext_copy_cmd(&offset, 0x11410E, 0xD930, 18); // Copy text pointers
insert_ext_copy_cmd(&offset, 0x00C120, 0xC140, 10); //
insert_ext_copy_cmd(&offset, 0x00C220, 0xC240, 16); //
byte temp[] = {0xD0, 0x0A};
insert_int_copy_cmd(&offset, 0xD4E9, 2, temp); //
byte temp1[] = {0x15, 0x05};
insert_int_copy_cmd(&offset, 0xD517, 2, temp1); //
byte temp2[] = {0x30, 0xD9};
insert_int_copy_cmd(&offset, 0xD36B, 2, temp2); //
byte temp3[] = {0x0B, 0xF0, 0xFF};
insert_int_copy_cmd(&offset, 0xD5D3, 3, temp3); //
byte temp4[] = {0x05};
insert_int_copy_cmd(&offset, 0xD4E0, 1, temp4); //
byte temp5[] = {0x44, 0xD9, 0x08, 0x21, 0x54, 0xD9, 0xCD, 0x68, 0x31, 0x21, 0xB0, 0xC1, 0x00, 0x00, 0xC3, 0xD2, 0x23, 0x01, 0x00, 0x5E, 0xD8, 0xD8, 0xC9, 0xD8, 0xC9, 0xD8, 0xC9, 0xD8, 0xC9, 0x00, 0x8C, 0xB8, 0xB4, 0xB4, 0xE7, 0x50, 0x08, 0x3E, 0x83, 0xCD, 0x8B, 0x11, 0xCD, 0x3E, 0x37, 0xC3, 0xD2, 0x23};
insert_int_copy_cmd(&offset, 0xD942, 48, temp5); //
payload_storage[offset++] = 0xFF;
/*
// call CloseSRAM
payload_storage[offset++] = 0xC3;
payload_storage[offset++] = (curr_rom.CloseSRAM >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.CloseSRAM >> 8) & 0xFF;
// call SoftReset
payload_storage[offset++] = 0xC3;
payload_storage[offset++] = (curr_rom.SoftReset >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.SoftReset >> 8) & 0xFF;
*/
}
}
else if (curr_rom.generation == 2)
{
// RNG Seed:
// at 0x00, 0x0A in length
// Does not need to be set
offset = 0x0A;
// Preamble
// At 0x0A, 0x08 in length
// Must be filled with 0xFD
for (int i = 0; i < 8; i++)
{
payload_storage[offset++] = 0xFD;
}
// Rival name
// At 0x12, 0x1C5 in length
// Set to stored name
int distance = curr_rom.stack_overwrite_location - curr_rom.print_string_start;
int remainder = distance % 40;
distance /= 40; // Automatically truncated, so it won't overshoot
distance -= 8; // Gen 2 does some weird copy paste, so this allows it to ignore that. 8 because of the OT name length
for (int i = 0; i < distance; i++)
{
payload_storage[offset++] = curr_rom.short_pkmn_name;
}
for (int i = 0; i < remainder; i++)
{
payload_storage[offset++] = 0x80;
}
payload_storage[offset++] = curr_rom.enter_vector_location & 0xFF;
payload_storage[offset++] = (curr_rom.enter_vector_location >> 8) & 0xFF;
payload_storage[offset++] = 0x50;
// Opens the PC box and then crashes- only used for debugging
// write_call(curr_rom.generation, payload_storage, offset, 0x0363D8);
// Saving the box overwrites our code, so we need to move it here.
write_call(curr_rom.generation, payload_storage, offset, curr_rom.SaveBox);
// jp SoftReset
payload_storage[offset++] = 0xC3;
payload_storage[offset++] = (curr_rom.SoftReset >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.SoftReset >> 8) & 0xFF;
// Patchlist preamble
// At 0x1B4 / 0x1D7, 0x07 in length
// Set as five 0xFD and two 0xFF
offset = 0x1D7;
for (int i = 0; i < 7; i++)
{
payload_storage[offset++] = (i < 5 ? 0xFD : 0xFF);
}
// Patchlist
// At 0x1DE, 194 in length
// Fill with custom code
/* Write transferring message to screen: */
// call ClearScreen
write_call(curr_rom.generation, payload_storage, offset, curr_rom.clearScreen);
// ld hl, [upper left textbox corner in VRAM]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.textBorderUppLeft >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.textBorderUppLeft >> 8) & 0xFF;
// ld b, 3 [height]
payload_storage[offset++] = 0x06;
payload_storage[offset++] = (curr_rom.textBorderWidth >> 0) & 0xFF;
// ld c, 14 [width]
payload_storage[offset++] = 0x0E;
payload_storage[offset++] = (curr_rom.textBorderHeight >> 0) & 0xFF;
// call CableClub_TextBoxBorder
write_call(curr_rom.generation, payload_storage, offset, curr_rom.CableClub_TextBoxBorder);
// ld hl, [transfer string location]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.transferStringLocation >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.transferStringLocation >> 8) & 0xFF;
// ld de, TransferWaitString
payload_storage[offset++] = 0x11;
payload_storage[offset++] = (curr_rom.transferWaitString >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.transferWaitString >> 8) & 0xFF;
// call PlaceString
write_call(curr_rom.generation, payload_storage, offset, curr_rom.placeString);
/* Transfer box data: */
// ld hl, hSerialConnectionStatus
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 8) & 0xFF;
// ld [hl], 0x01 [Make sure GB is the slave, master if debug]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = (debug ? 0x02 : 0x01);
// call OpenSRAM
payload_storage[offset++] = 0x3E;
payload_storage[offset++] = 0x01;
write_call(curr_rom.generation, payload_storage, offset, curr_rom.OpenSRAM);
// ld hl, (wBoxDataStart - 1) [data to send]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - 1) >> 0) & 0xFF;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - 1) >> 8) & 0xFF;
// ld [hl], 0xFD [set the start of the data to 0xFD so Serial_ExchangeBytes is happy]
// TODO Change me because of save corruption yayyyyyy
payload_storage[offset++] = 0x36;
payload_storage[offset++] = 0xFD;
// ld de, (wBoxDataStart - 3) [location to put stored data]
payload_storage[offset++] = 0x11;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - (debug ? 2 : 3)) >> 0) & 0xFF;
payload_storage[offset++] = ((curr_rom.wBoxDataStart - (debug ? 2 : 3)) >> 8) & 0xFF;
// ld bc, (wBoxDataEnd - wBoxDataStart) + 2
payload_storage[offset++] = 0x01;
payload_storage[offset++] = (((curr_rom.wBoxDataEnd - curr_rom.wBoxDataStart) + 2) >> 0) & 0xFF;
payload_storage[offset++] = (((curr_rom.wBoxDataEnd - curr_rom.wBoxDataStart) + 2) >> 8) & 0xFF;
// call Serial_ExchangeBytes [Send the box data]
write_call(curr_rom.generation, payload_storage, offset, curr_rom.Serial_ExchangeBytes);
/* Recieve the Pokemon to remove */
// ld hl, hSerialConnectionStatus
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.hSerialConnectionStatus >> 8) & 0xFF;
// ld [hl], 0x01 [Make sure GB is the slave, master if debug]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = (debug ? 0x02 : 0x01);
// ld hl, 0xC613 [data to send, garbage data]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.garbageDataLocation >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.garbageDataLocation >> 8) & 0xFF;
// ld de, 0xC651 [data to recieve]
payload_storage[offset++] = 0x11;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 8) & 0xFF;
// ld bc, 0x001E [size of data]
payload_storage[offset++] = 0x01;
payload_storage[offset++] = 0x1E;
payload_storage[offset++] = 0x00;
// call Serial_ExchangeBytes [Recieve the removal array]
if (debug)
{
offset += 3; // Don't add in the Serial_ExchangeBytes call if in debug
}
else
{
write_call(curr_rom.generation, payload_storage, offset, curr_rom.Serial_ExchangeBytes);
}
/* Remove the transfered Pokemon */
// ld hl, wRemoveMonFromBox
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.wRemoveMonFromBox >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.wRemoveMonFromBox >> 8) & 0xFF;
// ld [hl], [!= 0x00 specifies the current box]
payload_storage[offset++] = 0x36;
payload_storage[offset++] = 0x01;
/* LOOP BEGIN */
// ld a, [arrayCounter]
payload_storage[offset++] = 0xFA;
payload_storage[offset++] = (curr_rom.arrayCounter >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.arrayCounter >> 8) & 0xFF;
// ld e, a
payload_storage[offset++] = 0x5F;
// ld d, 0x00
payload_storage[offset++] = 0x16;
payload_storage[offset++] = 0x00;
// ld hl, [removalArray]
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.pkmnTransferArray >> 8) & 0xFF;
// add hl, de
payload_storage[offset++] = 0x19;
// inc a
payload_storage[offset++] = 0x3C;
// ld [arrayCounter], a
payload_storage[offset++] = 0xEA;
payload_storage[offset++] = (curr_rom.arrayCounter >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.arrayCounter >> 8) & 0xFF;
// ld a, [wBoxCount]
payload_storage[offset++] = 0xFA;
payload_storage[offset++] = (curr_rom.wBoxCount >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.wBoxCount >> 8) & 0xFF;
// ld b, a
payload_storage[offset++] = 0x47;
// ld a, [hl]
payload_storage[offset++] = 0x2A;
// cp a, 0xFF
payload_storage[offset++] = 0xFE;
payload_storage[offset++] = 0xFF;
// jr z, 15
payload_storage[offset++] = 0x28;
payload_storage[offset++] = 0x0F;
// cp a, b
payload_storage[offset++] = 0xB8;
// jr nc, -26
payload_storage[offset++] = 0x30;
payload_storage[offset++] = 0xE6;
// ld hl, wWhichPokemon
payload_storage[offset++] = 0x21;
payload_storage[offset++] = (curr_rom.wWhichPokemon >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.wWhichPokemon >> 8) & 0xFF;
// ld [hl], a
payload_storage[offset++] = 0x77;
// call TakePartyItem
// call _RemovePokemon
if (DONT_REMOVE_PKMN)
{
offset += 6;
}
else
{
// write_call(curr_rom.generation, payload_storage, offset, 0x046C60);
write_call(curr_rom.generation, payload_storage, offset, curr_rom._RemovePokemon);
}
// jr, -38
payload_storage[offset++] = 0x18;
payload_storage[offset++] = 0xDA;
/* LOOP END */
// jp pkmn list (because saving the box overwrites the data)
payload_storage[offset++] = 0xC3;
payload_storage[offset++] = (curr_rom.jump_vector_location >> 0) & 0xFF;
payload_storage[offset++] = (curr_rom.jump_vector_location >> 8) & 0xFF;
// 72 total bytes of string/array stuff
// 1 byte to store the current array counter
// $C650
if (offset > (0x1DE + (194 - 72)))
{
std::cout << "# Error: Script exceeded by " << offset - (0x1DE + (194 - 72)) << " bytes!" << std::endl;
}
offset = (0x1DE + (194 - 72));
payload_storage[offset++] = 0x00;
// 40 byte storage for list of Pokemon to remove
// $C651
for (int i = 0; i < 40; i++)
{
if (debug)
{
payload_storage[offset++] = (i < 30 ? (29 - i) : 0xFF);
}
else
{
payload_storage[offset++] = (i < 30 ? 0xFD : 0xFF);
}
}
// permanent array terminator, just in case
// $C679
payload_storage[offset++] = 0xFF;
// TransferWaitString
// $C67A
for (int i = 0; i < 30; i++)
{
payload_storage[offset++] = curr_rom.transferString[i];
}
// This payload works by placing Pokemon ID 0xFC's name in the stack, and causing a return to CD8E,
// which is part of the RNG seed. From there we can jump anywhere- and we choose to jump to D887,
// which is the rival's name. This code fixes the stack and jumps to the patchlist, which is where
// our final code is.
}
return payload_storage;
};
void write_call(int generation, byte array_data[], int &offset, word call_location)
{
if (generation == 1)
{
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (call_location >> 0) & 0xFF;
payload_storage[offset++] = (call_location >> 8) & 0xFF;
}
else
{
// Swap banks: Load bank into a, call rst 10 (0xD7)
if (((call_location >> 16) & 0xFF) != 0x00)
{
payload_storage[offset++] = 0x3E;
payload_storage[offset++] = (call_location >> 16) & 0xFF;
payload_storage[offset++] = 0xD7;
}
payload_storage[offset++] = 0xCD;
payload_storage[offset++] = (call_location >> 0) & 0xFF;
payload_storage[offset++] = (call_location >> 8) & 0xFF;
}
};
void insert_ext_copy_cmd(int *offset, word source, hword destination, byte size)
{
payload_storage[(*offset)++] = size;
payload_storage[(*offset)++] = destination >> 8;
payload_storage[(*offset)++] = destination >> 0;
payload_storage[(*offset)++] = source >> 16;
payload_storage[(*offset)++] = source >> 8;
payload_storage[(*offset)++] = source >> 0;
}
void insert_int_copy_cmd(int *offset, hword destination, byte size, byte data[])
{
insert_ext_copy_cmd(offset, copy_table_start + copy_table_offset, destination, size);
for (int i = 0; i < size; i++){
copy_table_storage[copy_table_offset + i];
}
copy_table_offset += size;
}
int test_main() // Rename to "main" to send the payload to test_payload.txt
{
freopen("test_payload.txt", "w", stdout);
std::cout << std::endl;
byte *payload = generate_payload(ENG_YELLOW, EVENT, true);
if (!EVENT)
{
for (int i = 0; i < PAYLOAD_SIZE; i++)
{
std::cout << "0x" << std::setfill('0') << std::setw(2) << std::hex << std::uppercase << (unsigned int)payload[i] << ", ";
if (i % 0x10 == 0xF)
{
std::cout << std::endl
<< "# 0x" << std::hex << i + 1 << std::endl;
}
}
}
else
{
for (int i = 0; i < 0x150; i++)
{
std::cout << std::setfill('0') << std::setw(2) << std::hex << std::uppercase << (unsigned int)payload[i + ((0x10 * 28) + 9)] << " ";
if (i % 0x10 == 0xF)
{
std::cout << std::endl;
}
}
return 0;
}
}
Reference in New Issue View Git Blame Copy Permalink