Shining Soul II (Europe) — Decompilation

Work-in-progress matching decompilation of Shining Soul II for the Game Boy Advance (Europe, AU2P, En/Fr/De/Es/It). The build reproduces the original ROM byte for byte.

Each cell is one function (area = size in bytes):

Colour	Meaning
🟩 green	matching C or linked library code; separate totals are shown above the map
🟨 yellow	compiling C draft; tracked large functions fill progressively by documented work milestones
⬜ grey	no matching C, original ASM, or unfinished tracked milestones; hover for the exact state

The graphic shows recognized display names while preserving canonical symbols in its tooltips. Partial yellow fill is a count of evidenced work milestones, not matching bytes, semantic equivalence or an estimate of remaining time. Function owners update their own docs/agents/function_work/sub_XXXXXXXX.json at checkpoints; CI refreshes the map when those commits are integrated. Data is shown as an inventory, without a decoding percentage.

The historical matched + linked percentage includes linked library code and excludes original ASM. Matching C counts only matching C bytes over all C module bytes; compiling drafts are reported separately. Identification is a separate source/evidence metric, not a decompilation or understanding percentage. See metric definitions and naming workflow.

CI regenerates the complete function/name inventory, identification summary, source call graph (JSON, DOT) and raw data inventory without a ROM. The graph records source observations and unresolved calls; it is not a complete runtime graph.

Join the collaboration

Start with the contributor quick start. On Windows, download the ROM-free toolkit into your own folder, extract it there and start with its bootstrap script. Each contributor and agent needs an independent checkout and an exclusive shard assignment. Bring your own EU ROM; it is never included in the toolkit or uploaded to Git.

Public guides, progress labels and tables, commit messages, and pull-request text use English so contributors can coordinate across communities.

Building

The ROM is not included. You need your own dump, saved as baserom.gba:

File	SHA1
baserom.gba	aa1288be9257337abdfe3034898cf6c7aa778fbc

Requirements: binutils-arm-none-eabi gcc-arm-none-eabi make python3 git gcc (Linux/WSL) or MSYS2 UCRT64 on Windows (see CONTRIBUTING.md).

sh tools/setup_tools.sh       # agbcc, m2c, decomp-permuter-agbcc, asm-differ, objdiff (all inside tools/, git-ignored)
make -j$(nproc) compare       # -> shiningsoul2_eu.gba: OK
make expected                 # snapshot of the matching objects (diff target for objdiff / asm-differ)
python3 tools/scripts/gen_objdiff.py && tools/objdiff/objdiff
make progress                 # regenerate docs/progress/*.svg

Contributing

Anyone can help: read CONTRIBUTING.md (setup, per-function workflow, compiler rules). AI agents: CLAUDE.md and docs/agents/.

Layout

Path	Contents
src/*.c	C modules. Not yet decompiled functions are pulled in with INCLUDE_ASM(...)
asm/nonmatchings/<module>/<func>.s	one assembly file per not yet decompiled function
asm/crt0.s, asm/*.s	hand written assembly (start up, m4a core, libgcc)
data/rodata.s	ROM data, taken from baserom.gba with .incbin
include/	headers
tools/config/functions.cfg	function list (address, name)
tools/config/modules.cfg	module boundaries
tools/scripts/	analysis, asm generation and progress tools

To decompile a function: replace its INCLUDE_ASM line in src/<module>.c with C code, delete its .s file and run make compare.

See docs/RESEARCH.md (Spanish) for the research behind the project: how other GBA decompilations work, the toolchain and the ROM layout.