mirror of
https://github.com/Druthulu/BFM-decomp
synced 2026-09-29 15:18:24 -04:00
Drew T
6345b5012a
- SETUP.md §6.7: the binary-agnostic toolchain (make build BINARY=<alias>, the required --vram-base/--exe/--symbols flags, BFM_BINARY for asm-differ, and the future-binary path convention config/splat.<bin>.yaml / build/<bin>/ etc.) - matching-cookbook.md §9.7: the reusable refactor pattern for Gen2 (required params/ no defaults, --vram-base scalar vs window, transitional-default + leaf-first technique, the negative control, the progress.py regex lockstep gotcha) - psyq-worklist.md: per-library recipe updated with the now-required flags - README.md: status -> 52 REAL / 959 LINKED / ~50% byte-identical / Gen2 underway (binary-agnostic toolchain) - MILESTONE (all green): EXE rebuilds 143dbb89 with AND without SDK objects; report 52/959/7/50.24%; wrong --vram-base -> cae22f7e (negative control); expected/ refreshed
29 lines
2.8 KiB
Markdown
29 lines
2.8 KiB
Markdown
# BFM-decomp
|
|
|
|
A matching decompilation of **Brave Fencer Musashi** (PlayStation, SLUS-00726, USA 1998) — the first public decompilation effort for this game.
|
|
|
|
## What "matching" means
|
|
|
|
The goal is C source code that, compiled with the original-era toolchain (PsyQ 4.x / GCC 2.7.2-family + ASPSX via maspsx), produces a byte-for-byte identical `SLUS_007.26` and, eventually, byte-identical overlay binaries. SHA1 checksums are the ground truth; "functionally equivalent" does not count.
|
|
|
|
## No ROM content
|
|
|
|
This repository contains **no game assets, no disassembly output, and no ROM-derived data** — only source code, build configuration, symbol names/addresses, hashes, and documentation. To build or contribute you must provide your own dump of the game disc (4-track BIN/CUE, redump layout). See `.gitignore` for the firewall.
|
|
|
|
## Project status
|
|
|
|
**Gen1 (foundation) complete — the matching pipeline is proven end-to-end.** `make extract && make build && make check` rebuilds `SLUS_007.26` **byte-for-byte identical** (SHA1 `143dbb89…`) from C + assembly, reproducibly across many sessions.
|
|
|
|
- **Compiler pinned by evidence:** `gcc-2.7.2-psx -O2 -G0 -mips1 -mcpu=3000` + `maspsx --aspsx-version=2.56 --expand-div`.
|
|
- **52 functions hand-matched** to byte-identical machine code — including the LZSS streaming decompressor — with a decomp-permuter + matching-cookbook "flywheel" to accelerate the next.
|
|
- **959 PsyQ SDK functions linked byte-identical** (libcd, libgs, libgte, libspu/libsnd, libgpu, libc2, libmcrd, libapi/libcard, libetc) straight from the real PsyQ 4.0 libraries instead of re-decompiling them — bringing byte-identical-from-source coverage of the EXE to **~50%**.
|
|
- **File-loader / overlay system reverse-engineered**, with the resident engine blob + location overlays' load addresses **proven byte-identical against a live PCSX-Redux RAM dump**.
|
|
|
|
About half the EXE is still `INCLUDE_ASM` stubs (correct bytes, not yet C), and the bulk of the game lives in compressed overlays inside the `.CD` archives — **Gen2** (overlays & engine at scale) is underway: the build toolchain is now **binary-agnostic** (one parameterized pipeline builds any binary, proven a byte-exact no-op on the EXE), ready to stand up the overlays. Current phase and detailed progress live in `phase-ends/` (newest `PhaseEnd_*.md` = current state); methodology, rules, and the full roadmap are in `PROJECT_CONTEXT.md`; environment setup in `docs/SETUP.md`.
|
|
|
|
This project is developed primarily by Claude Code driving Ghidra through an MCP server; see `CLAUDE.md`.
|
|
|
|
## License
|
|
|
|
Private repository for now. **AGPL-3.0 is planned at public release**, modeled on [sotn-decomp](https://github.com/Xeeynamo/sotn-decomp). `tools/brave-CUE/` is CUE's BRAVE extractor (GPL, source included) and retains its own license.
|