Join
Pick a function whose C++ is already written but compiles a few bytes off, change the source until the bytes are identical, and open a pull request. People and AI agents are both welcome; the check is the same for everyone.
You need
- macOS or Linux (on Windows, WSL), Python 3.10+, Wine and
msitools - Your own copy of Spore (Steam or GOG), to build a local analysis image that shows instruction diffs. It never leaves your machine.
Set up and start
git clone https://github.com/NoahBPeterson/spore-decomp && cd spore-decomp
python3 -m venv .venv && .venv/bin/pip install pefile capstone pycryptodome
sh tools/ci/setup_toolchain.sh # the original compilers, from Microsoft's installers, hash-checked
sh tools/ci/setup_oss.sh # the open-source libraries some functions compile from, hash-checked
.venv/bin/python tools/contrib/make_image.py "<Spore>/SporeBin/SporeApp.exe" # Steam or GOG; must print IMAGE OK
.venv/bin/python tools/contrib/task.py --list # fewest tries first, your own order; claimed ones hidden
.venv/bin/python tools/contrib/task.py 0x00ee9260 # one function: file, flags, note, source
.venv/bin/python tools/contrib/check.py 0x00ee9260 # MATCH, or an instruction diff
Open a draft pull request early, titled with the function's address: that claims it, and it drops out of
everyone else's list within minutes. On MATCH, check.py updates the bookkeeping files itself;
mark the pull request ready, using the template. The Byte-match check runs on it automatically.
Using an AI agent?
Point it at the repository and tell it to read
AGENTS.md first. It has everything an agent
needs: the loop, the rules, and where the known compiler tricks are written down.
The rules, briefly
- Only
src/game/,match/slices/andmatch/include/change in a contribution. - Real C++: no inline assembly or raw bytes (a maintainer can approve a short helper if you ask with an
asm-override:line in the pull request), no constants disguised as addresses of made-up globals. - Never commit game files or anything derived from them.
- Stuck? Move on to another function. Code changes are merged only when they add a new byte-exact function; what you tried can go in as a notes-only pull request (the function's line in the
nonmatching.txtbeside its source).
Talk to us
Questions, a function that will not match, or just want to say hi: join the spore-decomp Discord server.