BK Recomp Romhack Tool

This is a tool used to help with converting modified Banjo-Kazooie ROMs made with select ROM editing tools into mods for Banjo: Recompiled. This tool accepts a modified ROM and a symbol toml for that ROM which is used to locate custom code added to the game. It outputs a mod binary and mod symbol file, which can be packed into an nrm to make a mod for Banjo: Recompiled.

Alternatively, the files can be merged with a normal Banjo: Recompiled code mod using the recomp mod merger to add code changes to the converted mod. An example of using the mod merger approach can be found here.

The symbol toml accepted by this project is in the same format as symbol tomls used by N64: Recompiled. There is no standard way to generate symbol files for this project, but spimdisasm can be used to analyze a specific region of a ROM in order to split it into individual functions. Banjo-Kazooie ROM editing tools generally place new code at ROM offset 0x3F00000. You can find an example symbol toml in project linked in the previous paragraph.

Building

1. Clone this repository recursively by using git clone --recurse-submodules. If you have already cloned non-recursively, you can clone submodules by running git submodule update --init --recursive.
2. Configure CMake for this project by running cmake -S . -B build. Additional CMake flags can be passed to change the build type, and the build directory can be configured by changing the argument passed to the -B flag.
3. Build the repo by using cmake --build build. Change the argument passed to the --build flag to match the build directory chosen in step 2.

On Windows, you may also build this project by opening this folder in Visual Studio 2022 after following step 1. Ensure that the "Desktop development with C++" and "C++ CMake tools for Windows" options are installed in the Visual Studio Installer.