Banjo: Recompiled Symbols

This repo contains the symbol files used by the recompiler to generate the code for the Banjo: Recompiled project (link needed lol). These files were generated from the Banjo-Kazooie decompilation project, which allows the recompilation project to use function and variable names from the decompilation to help with writing patches.

This is a separate repo from the main one so that mods can reference just this repo instead of the recompilation's entire repo. It also helps avoid bloating the main repo's size and history, as the symbol files are very large.

The syms.toml file contains function definitions that the recompiler uses to find code in the ROM during the initial recompilation. The syms.toml and datasyms.toml files are all used during patch recompilation to allow the recompiler to resolve references to functions and variables in patch code. This allows patches to be written by copying in matched functions from the decompilation and tweaking them.

Modding

Mods can submodule/subrepo this repo (or just copy the files from it) to provide to the mod builder. Commits of this repo are tied to commits of the decompilation project, so mods should use the corresponding decompilation commit in order to guarantee consistency between headers and symbol names. For more information, check out the mod template.

The commit of the decompilation that these symbols were generated from can be found here.

Mods do not have to update these files to support newer versions of the recompilation project, as symbol names are discarded in the process of building a mod.