Tool:decomp-toolkit
| Platforms | Platform:Nintendo GameCube |
|---|---|
| License | MIT OR Apache-2.0 |
| Website | https://github.com/encounter/decomp-toolkit |
| On this wiki | Facts · Code · Notes · Topics |
Rust command-line tool and build-system component for GameCube and Wii matching decompilation projects (MIT OR Apache-2.0): it analyses a DOL or REL, splits it into per-source-file objects driven by config.yml, symbols.txt and splits.txt, and handles archives and compression formats.
What it does
Used by many GameCube and Wii decompilation projects (for example doldecomp/melee, doldecomp/sms, doldecomp/pikmin2, doldecomp/mkdd) together with the project template dtk-template. Subcommands (from its README) include dol info / split / diff / apply / config, rel info / merge, rso info / make, elf disasm / fixup, elf2dol, map, shasum, disc info / extract / convert / verify, ar create / extract, u8 list / extract, rarc list / extract, yaz0 and yay0 compress / decompress, nlzss decompress, vfs ls / cp and wad info / extract / verify. The format pages Format:DOL executable, Format:REL relocatable module, Format:RARC archive, Format:Yaz0 and Format:Yay0 describe what it reads.
Project files
- config.yml: the object to split (object: sys/main.dol), its SHA-1 (hash:), object_base, the symbols and splits file paths, mw_comment_version, flags such as quick_analysis and globalize_symbols, and block_relocations lists (addresses the analyser must not treat as pointers, for example colour constants that look like addresses).
- symbols.txt: one symbol per line, see the fact on its grammar. Registering a project's build by the hash in config.yml and importing symbols.txt with import_symbols is the usual way to put such a project on this wiki.
- splits.txt: per source file, the address ranges of each section it owns, and a Sections list at the top that defines the sections with type, align and vaddr.
- build.sha1: SHA-1 of the rebuilt binaries that the build must reproduce (check target of the project's CI).
Identification
A project using it has config/<GAMEID>/config.yml, symbols.txt, splits.txt and build.sha1 and a configure.py.
Code & repositories
See linked repositories.
- https://github.com/encounter/decomp-toolkit @
0645e16511814920ffb05b25615dd71f1af73e4c· license: MIT OR Apache-2.0 (declared by the contributor for the files used; GitHub reports Apache-2.0 for the repository)
Rust analyser, splitter and archive tool for GameCube/Wii decompilation projects
Tested on: source read, not run: read source only · checked 2026-10-18; last activity 2026-09-10; Note: the latest release ships binaries; the wiki links only the source, never the binaries - https://github.com/PrimeDecomp/prime @
945f3a19777dc3c50e129e2e83421bff41fd8702· license: CC0-1.0
Matching decompilation of Metroid Prime (GameCube) with decomp-toolkit; per-version config/<GAMEID>/symbols.txt, splits.txt, build.sha1.
Tested on: source read, not run: GameCube, config files read at 945f3a1977 · checked 2026-10-18; last activity 2026-10-18 - https://github.com/ACreTeam/ac-decomp @
09ca8e8b5b24e6ab44047ee980cf0088ad7ecb4c· license: CC0-1.0
Matching decompilation of Animal Crossing (GameCube) with decomp-toolkit; static.dol plus foresta.rel, config/GAFE01_00 and GAFU01_00.
Tested on: source read, not run: GameCube, config files read at 09ca8e8b5b · checked 2026-10-18; last activity 2026-07-18 - https://github.com/mariopartyrd/marioparty4 @
5b01c79b4910525e3fc5aa312eddd6d014e7f337· license: CC0-1.0
Matching decompilation of Mario Party 4 (GameCube) with decomp-toolkit; six versions, main.dol plus REL modules.
Tested on: source read, not run: GameCube, config files read at 5b01c79b49 · checked 2026-10-18; last activity 2026-10-15 - https://github.com/bfbbdecomp/bfbb @
8fb1c232addcacf44932c10c4cede41b43f98f40· license: CC0-1.0
Matching decompilation of SpongeBob SquarePants: Battle for Bikini Bottom (GameCube, GQPE78) with decomp-toolkit.
Tested on: source read, not run: GameCube, config files read at 8fb1c232ad · checked 2026-10-18; last activity 2026-08-31