Tool:nx-decomp-tools
| On this wiki | Facts · Code · Notes · Topics |
|---|
Shared Python tooling of the open-ead Nintendo Switch matching-decompilation projects (Breath of the Wild, Super Mario Odyssey): NSO setup, NSO to ELF conversion, function-list checking.
Overview
https://github.com/open-ead/nx-decomp-tools is included as the submodule tools/common in zeldaret/botw and MonsterDruide1/OdysseyDecomp (.gitmodules). Their tools/setup.py calls helpers in it (_decompress_nso, _convert_nso_to_elf, _apply_xdelta3_patch) to turn the user's own main NSO into the ELF that the build compares against, after checking its SHA-256. Build outputs are compared function by function against that ELF.
See Software:The Legend of Zelda: Breath of the Wild and Software:Super Mario Odyssey for the function lists, Format:NSO for the container and Technique:Matching decompilation for the method. Contents of the tools repository, read at commit e0eae2f7f403befec6b60cb615f6680a6937d0c9 (setup_common.py): _convert_nso_to_elf(nso_path, elf_out_path, uncompressed_nso_out_path) runs the external nx2elf <nso> --export-elf <elf> and, when given an output path, --export-uncompressed <nso>; _decompress_nso runs hactool -tnso --uncompressed=<dest> <nso> and emits a DeprecationWarning ("Using hactool to decompress the target NSO is deprecated, please use _convert_nso_to_elf instead"); _apply_xdelta3_patch runs xdelta3 -d -s <input> <patch> <dest> and fails with "error: install xdelta3 and try again" if it is missing; install_viking builds the Rust crate in viking/ with cargo build --release and installs the binaries check, listsym and decompme into the project's tools directory.
Code & repositories
- https://github.com/zeldaret/botw @
28de09ade7a2ac4c9fc22c82edad348555617181· license: none
Work-in-progress decompilation of Breath of the Wild 1.5.0: data/uking_functions.csv (Address,Quality,Size,Name), data_symbols.csv, tools/setup.py with the NSO SHA-256 hashes.
Tested on: source read, not run: Breath of the Wild 1.5.0 (Switch) · checked 2026-10-18; last activity 2026-10-18; no license: not reusable - https://github.com/MonsterDruide1/OdysseyDecomp @
696db2ff5ed558b053c753de420504b8682f24b0· license: none
Work-in-progress decompilation of Super Mario Odyssey 1.0.0: data/file_list.yml (per-function offsets and status), data_symbols.csv, data_strings.csv, tools/setup.py with the NSO SHA-256 hashes.
Tested on: source read, not run: Super Mario Odyssey 1.0.0 (Switch) · checked 2026-10-18; last activity 2026-10-12; no license: not reusable