Files
BFM-decomp/decomp-architect/templates/README.skeleton.md
T
Drew T 9235800fb7 tools+docs(phase-33.5): task 11 — kit part 2: the firewall pack (templates/gitignore.decomp extracted byte-for-byte from the wiki fence — gitignore_template_check now runs in tools-health; firewall.txt with purge:/glob:/required:/pending:/fixture: rules; audit_public.template.py generalised from the repo's audit with its sources in the config, refusing zero sources; firewall-fixture/ = 16 synthetic bytes + sha1, the planted negative control), no-rom.template.yml, the docs/.run READMEs, ops-setup.decomp.md, bootstrap.template.sh (skeleton), CLAUDE.decomp-overlay.md (the four fail-safes + session-start extras), pa-overlays.md (7 fenced blocks: DIGEST, the 🛑 checkpoint block, the PhaseEnd narrative axis, effort rows, cookbook entry shape + triage table, wave-playbook skeleton, settings/mcp), the LICENSE/NOTICE/README/CONTRIBUTING skeletons, .clang-format + make-format.snippet.mk; tools/MANIFEST.md (325 tool files by ladder phase from one read-only survey, coverage 325/325, as Phase-N tasks); tools/kit_lint.py (fence-aware leak grep, the PLACEHOLDERS set-diff, in-memory compile / bash -n / JSON+YAML, the gitignore diff, TODO counts, coverage; --selftest = the R39 control) wired into tools-health; decomp-architect/README.md in doc_links DEFAULT; SETUP row; PLACEHOLDERS Used-in cells reconciled; make tools-health OK on this tree (detached run, .run/P33.5/tools_health_t11.log); story-timeline regenerated by the report step; log + checkpoint (NEXT = task 12, Max)
2026-09-07 19:22:51 -06:00

3.0 KiB

{{PROJECT_NAME}}

A matching decompilation of {{GAME_TITLE}} ({{PLATFORM}}, {{GAME_SERIAL}}): C source that, compiled with the original era's toolchain and linked in the original order, reproduces every shipped binary byte for byte, verified by a hash check inside every build.

{{PROJECT_GOALS}}

Status

Progress numbers are generated by tools/progress.py and appear here once Phase 5 wires it (TODO(phase-5)).

Building from your own copy of the game

This repository contains no byte of the game: no executable, no disc or cartridge data, no disassembly listing, no memory image, no vendor SDK. To build, you need your own legally obtained copy.

  1. TODO(phase-1): stage your dump under disks/ (ignored by git) and run the extractor; it verifies your extraction against the committed manifest of hashes.
  2. TODO(phase-3): make build reproduces each binary and checks its hash; the clean fleet verification is in docs/ops-setup.md.
  3. TODO(phase-9): the fresh-clone proof — a stranger with their own copy can extract, build and verify from this README alone.

The no-ROM policy

Nothing derived from the game enters git — from the first commit, whether the repository is public or private. The .gitignore is the firewall; tools/audit_public.py (its sources in config/firewall.txt) is the gate, run in CI on every push; a pasted listing of the target's instructions counts too. See docs/wiki/The-ROM-firewall.md (TODO: created when the wiki is set up) and src/NOTICE.md.

How this project is made

{{AI_DISCLOSURE}}

The standard it holds itself to: a function is "matched" only when the whole binary still hashes with it compiled from source; names and types are evidence-based, never guessed (an address-named placeholder is honest); every outward message to another project is written by a person; the project makes no automated requests to community services. The record — the phase syntheses, the decision log, the cookbook of byte-proven idioms — is what makes the work auditable.

Repository visibility

{{PUBLIC_OR_PRIVATE}}

Acknowledgements

Prior community work this project builds on or was checked against: {{COMMUNITY_WORK}}. The governance and method come from ProjectArchitect 2.0 and the decomp-architect kit distilled from a finished matching decompilation.

License

The project's own work — the tooling, the build system, the documentation — is licensed under {{LICENSE_CHOICE}} (LICENSE). No license is asserted over the reimplemented sources under src/ (src/NOTICE.md). Third-party components keep their own licenses (THIRD_PARTY.md). {{GAME_TITLE}} is the property of its rights holder.

Contributing

See CONTRIBUTING.md: bring your own copy of the game, never commit anything derived from it, and read the AI-use conduct section before your first pull request.