re4 README

The project's README from github.com/adonis-singh/re4. As one markdown file: README.md.

Resident Evil 4 (GameCube) — decompilation

A complete, byte-identical decompilation of Resident Evil 4 for the Nintendo GameCube: the G4BE08 debug build (the "Nov 25 2004" prototype, both discs), whose Bio4.sym files name every function. Building the repository reproduces main.dol and all 114 REL overlays exactly (config/G4BE08/build.sha1, checked on every build).
Objects 1083 (675 in the DOL, 408 across the 114 RELs), all byte-identical; 23289 function symbols (14587 distinct names; template and inline copies repeat per module)
Source ~571k lines of C/C++ (src/: 635 .cpp, 380 .c), ~43k lines in 417 headers (include/); no assembly files
Game code SN Systems ProDG 3.9.3 — GCC 2.95.3 "SN BUILD v1.79", built natively from SN's GPL source drop
CRI middleware (src/lib/adx_*, sfd_*, mpv_*, …) Metrowerks CodeWarrior 2.4.7 (GC/2.7), the compiler CRI shipped the libraries with
Nintendo SDK (src/lib/OS*, GX*, …) Metrowerks CodeWarrior GC/1.2.5n, sources from dolsdk2004

The repository contains no game assets and no code or data copied from the discs. You need your own images of the debug discs to build (disc 1 for main.dol and most RELs, disc 2 for the four island-stage RELs); the original files are read from them at configure time.

Building

Linux, Python 3, ninja. Compilers and tools (decomp-toolkit, objdiff, wibo, the CodeWarrior builds) are downloaded by the first configure run, except the native SN GCC:

# 1. the native cc1/cc1plus (once): needs SN's GPL source drop, see tools/sn-gcc/build.sh
SN_GCC_SRC=/path/to/NGC_GNU_SRC/NGC tools/sn-gcc/build.sh

# 2. your disc images (disc 1: main.dol + 110 RELs; disc 2: the four island-stage RELs st3_0..st3_3)
cp re4_debug_disc1.iso re4_debug_disc2.gcm orig/G4BE08/

# 3. build and verify
python3 configure.py && ninja

ninja ends with the progress report (100% matched and linked for the DOL and the REL modules); build/tools/dtk shasum -c config/G4BE08/build.sha1 prints 115 OK lines. To work on a unit, python3 tools/bytecmp.py game/foo compares its object with the original word by word and python3 tools/fdiff.py game/foo <symbol> shows one function.

Layout

What "matching" means here

Every unit compiles to the original bytes with the original compilers. Where the compiler needed a particular source shape to reproduce a register choice or a schedule and no natural spelling was found, the construct is marked with a // COMPILER-DIFF: comment (578 of them: dead tests, empty asm("") launders and anchors, register T x asm("rN") pins, padding statements). None of them emits an instruction: python3 tools/asmcheck.py --all compiles every GCC unit with its asm templates marked and lists the instructions that came from a template — the only hits are the hardware kernels below (TOTAL 231; the eight asm-bodied units are reported on their own line and kept out of that number). An earlier state of this tree had ~100 hand-placed instructions (asm("li %0,0"), asm("lis/addi"), asm("mr")) in the game code and ~100 register-pinning asm { } blocks in the CRI libraries; they were replaced by C on 2026-09-17 (docs/research/compiler.md, section "Asm-removal pass", records the recipe and the compiler mechanism per site). Each tag's mechanism is documented in docs/matching.md and docs/research/.

Assembly that remains, all of it code the original authors also wrote in assembly because their compilers had no other way to express it:

Naming

Function names are Capcom's, from the debug build's Bio4.sym files; they are C++-mangled, which is why the game code is C++ and the SDK, CRI and newlib units are C. File names and unit boundaries come from the D:/Bio4/Prog/<file>.cpp strings the asserts left in the binaries. Struct and field names are of three kinds: the vendor's, from the PS2 debug build's type information (matched to the GameCube layouts by tools/ps2sym.py); ours, named from usage and marked as such; and placeholders xNN (offset in hex, meaning unknown). Vendor names keep the vendor's spelling, so the tree mixes conventions on purpose. Constants are the PS2 build's enums, imported as declared, and the pG flag bits are read through the XxxFlagChk/On/Off macros of include/global.h with the PS2 bit names. #line directives reproduce the vendor's line numbers in the assert strings. docs/naming.md has the full account and the counts.

Contributing

CONTRIBUTING.md: build, the three verification checks, the rules (bytes never change, no instruction-emitting asm, naming), and how to propose a rename with evidence.

The reconstructed game and SDK source is the intellectual property of its respective owners (Capcom, Nintendo, CRI Middleware) and is published for research and preservation only. The build scripts, tools and documentation written for this project are released under CC0 (LICENSE).

re4 (adonis-singh/re4)

Searching Database…

350 ·GitHub
Re4
Что это такое?Полная побайтово точная декомпиляция Resident Evil 4 для GameCube — отладочной сборки G4BE08, обоих дисков — восстановленная в виде читаемого кода C/C++, из которого собираются в точности оригинальные бинарники.
То есть я получу настоящий исходный код игры?Да — около 571 тысячи строк на C/C++ (635 файлов .cpp и 380 файлов .c плюс 417 заголовочных файлов), покрывающих всю игру: главный исполняемый файл DOL и все 114 оверлеев REL.
Как его собрать?На Linux с Python 3 и ninja: при первом запуске конфигурации скачиваются компиляторы и инструменты, а каждая сборка завершается автоматической проверкой результата по sha1.
Мне нужна своя копия игры, чтобы это собрать?Да — ваши собственные образы двух отладочных дисков: диск 1 для main.dol и большинства REL, диск 2 для четырёх REL островных уровней. В репозитории нет никаких ассетов; оригиналы читаются из ваших образов на этапе конфигурации.
С этим я смогу поиграть в игру?Само по себе нет — сборка лишь воспроизводит оригинальные файлы main.dol и REL, чтобы сверить исходники с вашими дисками; здесь нет порта игры на ПК и никаких новых возможностей.
Кому принадлежит код — могу ли я использовать его в своём проекте?Восстановленные исходники игры и SDK принадлежат Capcom, Nintendo и CRI Middleware и публикуются только для исследований и сохранения. Собственные скрипты сборки, инструменты и документация проекта — под CC0.
Почему за основу взята отладочная сборка, а не розничная версия игры?В прототипе G4BE08 есть файлы символов Bio4.sym, в которых названа каждая функция, поэтому декомпиляция получает настоящие имена Capcom с C++-манглированием вместо догадок; строки assert даже сохраняют оригинальные имена файлов.
Какими компиляторами собрана оригинальная игра?SN Systems ProDG 3.9.3 (GCC 2.95.3 «SN BUILD») для кода игры и Metrowerks CodeWarrior для middleware CRI и библиотек Nintendo SDK — совпадение требует компиляции этими же сборками, поэтому configure их скачивает.
Есть ли в проекте что-то помимо исходников на C/C++?Да — motionexport.py экспортирует анимации игры в glTF/BVH с помощью самого кода игры, с проверкой по игре, запущенной в Dolphin, а в docs/ описаны архитектура движка, техники достижения совпадения и полный исследовательский журнал.
What are similar projects?Petari, th08, awesome-decomp-games, PS2Recomp, wowdecomp, OpenCE, SkyRecomp, bgfx
Which topics is it in?game-preservation, decompilation, assembly, decompiler, binary-analysis, game-engine, low-level, game-development, compiler, game, reverse-engineering, gaming
Creator
adonis-singh
Size
30.5 MB
Stars
350
Updated
CommitOct 02
Age
1mo
Commits · 90 Days