MarathonRecomp README

The project's README from github.com/sonicnext-dev/MarathonRecomp. As one markdown file: README.md.


Marathon Recompiled is an unofficial PC port of the Xbox 360 version of Sonic the Hedgehog (2006) created through the process of static recompilation. The port offers Windows, Linux, and macOS support.

This project does not include any game assets. You must provide the files from your own legally acquired copy of the game to install or build Marathon Recompiled.

XenonRecomp and XenosRecomp are the main recompilers used for converting the game's original PowerPC code and Xenos shaders into compatible C++ and HLSL code respectively. The development of these recompilers was directly inspired by N64: Recompiled, which was used to create Zelda 64: Recompiled.

Table of Contents

Minimum System Requirements

How to Install

  1. You must have access to the following:

    • For dumping from a real Xbox 360:
      • Xbox 360 (modifications not necessary)
      • Xbox 360 Storage Device (either an Xbox 360 hard drive or an external USB storage device)
      • Xbox 360 Hard Drive Transfer Cable or a compatible SATA to USB adapter (only required for dumping from an Xbox 360 hard drive)
    • For dumping on your PC:
    • Sonic the Hedgehog (2006) for Xbox 360
      • Retail Disc or Digital Copy.
      • All available DLC are optional.

[!TIP] If you do not have the Xbox 360 Hard Drive Transfer Cable, please ensure that you purchase the correct revision of it for your console.

The latest revision works with both original Xbox 360 and Xbox 360 S|E hard drives, but the first revision only works with original Xbox 360 hard drives.

To know which is which, the first revision cable is gray, whereas the latest revision (which supports any Xbox 360 hard drive) is black.

  1. Before proceeding with the installation, make sure to follow the guide on how to acquire the game files from your Xbox 360.

    • Xbox 360 Hard Drive Dumping Guide
    • Xbox 360 USB Dumping Guide
    • OmniDrive Disc Dumping Guide
  2. Download the latest release of Marathon Recompiled and extract it to where you'd like the game to be installed.

  3. Run the executable and you will be guided through the installation process. You will be asked to provide the files you acquired in the previous step. When presented with options for how to do this:

    • Add Files will only allow you to provide containers or images dumped from an Xbox 360. These often come in the form of very large files without associated extensions. Don't worry if you're not aware of what's inside of them, the installer will automatically detect what type of content is inside the container.

    • Add Folder will only allow you to provide a directory with the game's raw files corresponding to the piece of content that is requested. It will NOT scan your folder for compatible content!

[!NOTE] Please note that it is not possible to complete the installation if your files have been modified. In case of other problems such as black screens or crashes, do not try to reinstall the game as it is not possible for the process to result in an invalid installation.

Known Issues

Before reporting any issues, check if they are listed here.

Original Game Bugs

Game bugs present on the original hardware are intentionally preserved and will not be fixed apart from a few minor visual patches that do not affect gameplay. Please do not report issues for these bugs and verify that the issue does not occur on original hardware before reporting. Bug reports for issues found in the original game will be rejected. Bugs that only happen in Marathon Recompiled must be accompanied by footage captured on original Xbox 360 hardware showing that the bug does not happen there.

Marathon Recompiled contains many patches for original game bugs and other annoyances that can be optionally enabled in the configuration file (see below) or by accessing the debug settings.

Debug settings access combination

On the title screen press the following sequence on the D-Pad or arrow keys:

  • Up, Down, Left, Right

A jingle will play, and a new section will reveal itself in the Options menu.

File Picker Unavailable on Steam Deck in Game Mode

Due to some restrictions of how the desktop environment on the Steam Deck works whilst in Game Mode, please note that you may need to at least first boot into Desktop Mode to be able to use the file picker to provide the game files.

Simply booting at least once in Desktop Mode will enable the Deck to use the file picker when going back to Game Mode. You can complete the entire installation process while in Desktop Mode to save yourself the trouble of browsing through Game Mode if necessary.

FAQ

Do you have a website?

Marathon Recompiled does not have an official website.

Please link here when directing anyone to the project.

[!CAUTION] Do not download builds of Marathon Recompiled from anywhere but our Releases page.

We will never distribute builds on other websites, via Discord servers or via third-party update tools.

Why does the installer say my files are invalid?

The installer may display this error for several reasons. Please check the following to ensure your files are valid:

What are the keyboard and mouse bindings?

Gamepad Keyboard Mouse
A Space
B Escape
X Left Shift Left Click
Y E
D-Pad Up Up Arrow Wheel Up
D-Pad Down Down Arrow Wheel Down
D-Pad Left Left Arrow X1
D-Pad Right Right Arrow X2
Start Return
Back Backspace
Left Trigger Q Middle Click
Right Trigger F Right Click
Left Shoulder
Right Shoulder
Left Stick Click
Left Stick Up W
Left Stick Down S
Left Stick Left A
Left Stick Right D
Right Stick Click
Right Stick Up
Right Stick Down
Right Stick Left
Right Stick Right

You can change the keyboard bindings by editing config.toml located in the configuration directory, although using a controller is encouraged until Action Remapping is added in a future update.

Refer to the left column of this enum template for a list of valid keys, and this one for a list of valid mouse buttons.

Where is the save data and configuration file stored?

The save data and configuration files are stored at the following locations:

You will find the save data under the save folder. The configuration file is named config.toml.

I want to update the game. How can I avoid losing my save data? Do I need to reinstall the game?

Updating the game can be done by simply copying and replacing the files from a release on top of your existing installation. Your save data and configuration will not be lost. You won't need to reinstall the game, as the game files will always remain the same across versions of Marathon Recompiled.

How can I force the game to store the save data and configuration in the installation folder?

You can make the game ignore the default configuration paths and force it to save everything in the installation directory by creating an empty portable.txt file. You are directly responsible for the safekeeping of your save data and configuration if you choose this option.

How can I force the game to run the installation again?

While it's unlikely you'll need to do this unless you've modified your game files by accident, you can force the installer to run again by using the launch argument: --install.

How can I force the game to run under X11 or Wayland?

Use either of the following arguments to force SDL to run under the video driver you want:

The second argument will be passed directly to SDL as a hint to try to initialize the game with your preferred option.

Where is the game data for the Flatpak version installed?

Given it is not possible to run the game where the Flatpak is stored, the game data will be installed to ~/.var/app/io.github.sonicnext_dev.marathonrecomp/data. The Flatpak build will only recognize this directory as valid. Feel free to reuse this data directory with a native Linux build if you wish to switch in the future.

If you wish to move this data to another location, you can do so by creating a symlink from this directory to the one where you'll migrate your installation to.

[!WARNING] Using external frame rate limiters or performance overlays may degrade performance or have negative consequences.

Can I install the game with a PlayStation 3 copy?

You cannot use the files from the PlayStation 3 version of the game. Supporting these files would require an entirely new recompilation, as they have proprietary formatting that only works on PS3 and the code for these formats is only present in that version. All significant differences present in the PS3 version of the game have been included in this project as options.

Why is the game detecting my PlayStation controller as an Xbox controller?

If you're using a third-party input translation layer (such as DS4Windows or Steam Input), it is recommended that you disable these for full controller support.

What other platforms will be supported?

This project does not plan to support any more platforms other than Windows, Linux and macOS at the moment. Any contributors who wish to support more platforms should do so through a fork.

Building

Check out the building instructions here.

Credits

Marathon Recompiled

Special Thanks

MarathonRecomp (sonicnext-dev/MarathonRecomp)

Searching Database…

What is this?An unofficial PC port of the Xbox 360 version of Sonic the Hedgehog (2006). It was built by static recompilation, which converts the original game code into code that runs natively on PC.
Is it an emulator or a native port?Not an emulator. The original PowerPC game code and Xenos shaders are recompiled into C++ and HLSL, so the game runs as a native PC build.
How do I get it running?Download the latest release from the GitHub Releases page, extract it, and run the executable. The installer then asks for your game files: 'Add Files' takes Xbox 360 container or image dumps, and 'Add Folder' takes an already extracted directory of raw game files.
Do I need to own the game?Yes. The project contains no game assets, so you must supply files from your own legally acquired copy of the game (retail disc or digital copy).
Any install pitfalls?Yes. Installation fails if your files are modified, compressed (.zip, .7z, .rar), or from mismatched regions. PS3 copies are not supported. On Steam Deck, you may need to boot into Desktop Mode once so the file picker works in Game Mode.
Which systems and hardware does it need?Windows 10 (1909 or newer), a modern Linux distro such as Ubuntu 26.04 LTS, or macOS 15.0 or newer. You need 8 GB of RAM, 6 GiB of storage, a 64-bit CPU with AVX (x86 or ARMv8), and a GPU with Direct3D 12.0, Vulkan 1.2, or Metal 3.
What was Marathon Recompiled inspired by?The recompilers were directly inspired by N64: Recompiled, the project that was used to create Zelda 64: Recompiled. The two projects share the same general approach to recompilation.
Can I keep my saves when updating to a new release?Yes. Copy and replace the files from the new release over your existing installation. Save data and config are kept, and the game files stay the same across versions, so you don't need to reinstall.
Where are save files and config stored?By default, on Windows they go in the APPDATA MarathonRecomp folder, on Linux in the XDG config folder (Flatpak uses a path under ~/.var/app), and on macOS in ~/Library/Application Support/MarathonRecomp/. The config file is named config.toml.
Size
6.6 MB
Stars
947
Age
1y
Commits · 90 Days