botw-symbols

This repo contains:

• Linker scripts (*.ld) for linking modules against BOTW 1.5.0 and 1.6.0
• A toolkit containing helper functions for modding BOTW

Install

Clone the repo with git. Add --depth 1 since the diffs might be large for generated files.

git clone https://github.com/Pistonight/botw-symbols --depth 1

Or add as a submodule to your repo

# with git
git submodule add --name botw-symbols --branch main https://github.com/Pistonight/botw-symbols <path>
# with magoo
magoo install https://github.com/Pistonight/botw-symbols <path> --name botw-symbols --branch main --depth 1

Linker Scripts

The linker scripts are located in /ld. They contain addresses for symbols from the decomp project so you can call them in your code.

The scripts are passed to the linker via the -T flag, or -Wl,-T when invoking the linker through the compiler.

The scripts are separated into 2 files:

• normal functions: (ld150.ld and ld160.ld)
• stub functions: (ld150_stubs.ld and ld160_stubs.ld)

Generally you only need the normal functions. The stub functions are address for undecompiled functions.

For version 1.6.0, most symbols are stubbed because there's no decompilation done. If you figure out the address of a function in 1.6.0, feel free to contribute by adding it to listing_160.csv (using the mangled name from the decomp project)

Toolkit Library

The toolkit library has some common code that I use for my mods. Feel free to use them. The library depends on my build system/tool megaton

To configure the toolkit, add the following to Megaton.toml (assuming toolkit is at libs/botw-symbols):

[build]
sources = [
    # ... other sources,
    "libs/botw-symbols/src"
]
includes = [
    # ... other includes,
    "libs/botw-symbols/include"
]
ldscripts = [
    # ... other ldscripts,
    "libs/botw-symbols/ld/ld150.ld", # or ld160.ld, depends on version
]

[build.flags]
c = [
    # ... other flags,
    "-DBOTW_VERSION=150", # or 160
    "-DBOTWTOOLKIT_TCP_SEND", # (optional) enable TCP debugging
]

Development - Adding Symbols

To add new symbols:

• For 1.6.0, add it to listing_160.csv
• For 1.5.0, the symbols are sourced from my fork of the decomp project and are updated every so often with upstream
• Add to toolkit_150.csv or toolkit_160.csv for symbols neede in the toolkit

The update.py script will update the linker scripts from the sources

pip install requests
python update.py