Guides

Practical guides for building, porting, modifying, debugging, and releasing recomp projects.

These guides are for people who want to work on a port.

If you only want to play a finished port, start with that port's release page instead. If you are new to static recompilation, read Start here first.

Each guide is meant to answer one practical question.

• Build a toolchain. Build the framework before trying a game.
• Port a game. Start a native port from a legally supplied game file.
• Write a mod. Package an optional change without rewriting the player's game file.
• Translate a game. Replace text and verify it in-game.
• Add widescreen. Expand the visible area while keeping the faithful path intact.
• Debug a divergence. Find the first point where native and reference behavior disagree.
• Set up co-simulation. Compare a recomp build against an oracle.
• Release a port. Package a release without shipping files that do not belong there.

When a guide needs a game file or BIOS, use legally obtained files. This site does not provide them.