ShadowRecomp README

The project's README from github.com/FoxWorkshop/ShadowRecomp. As one markdown file: README.md.

Happy 21st Birthday, Shadow The Hedgehog

Download · Requirements · Features · Known Issues · Controls · FAQ · Building · Credits


Shadow Recompiled is an unofficial PC port of the original Xbox version of Shadow the Hedgehog (2005) created through the process of static recompilation. The port supports Windows and Linux.

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 Shadow Recompiled.

XboxRecomp2 (previously XboxRecomp) is the main recompiler used for converting the game's original x86 code into compatible C++. The development of that recompiler was directly inspired by XenonRecomp, which was used to create Sonic Unleashed Recompiled.

Minimum System Requirements

Features

Easy to Use Installer

A built-in installer will guide you through the game installation process, performing many integrity checks to ensure the process goes as smoothly as possible.

Options Menu

A new options menu for PC has been added, replacing the game's original settings. Get access to many quality of life features and graphics options directly in-game with navigation that is fully compatible with a controller.

Widescreen and Ultrawide Support

Aspect ratios for 16:9 and 16:10, as well as ultrawide displays (such as 21:9 or even wider) are supported with options to adjust the alignment of the UI.

High Frame Rate Support

Support for high frame rate has been added as an available option. Many glitches that normally occur at higher frame rates have been fixed and are included as part of the recompilation. Cutscenes have also an option to play at unlocked frame rate.

Enhancements

Extra care and attention was taken to make the experience the best as possible:

other fixes:

Achievements

Achievements have been implemented to the game, they can be checked from the pause menu; a full new menu has been added.

You will be rewarded with achievements as you progress through the game.

[!NOTE] Achievements cannot be used with platforms such as Steam or RetroAchievements.

Mod Support

The game includes a mod loader compatible with SA Mod Manager.

The mod format uses the same standard as the one used by Sonic Adventure mods.

[!NOTE] Code modding is currently not possible and is planned for a future update. As a workaround for the time being, some codes have been directly embedded into the game and can be accessed through SA Mod Manager's Codes tab.

Known Issues

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

Controls

Default keyboard controls:

Keymap

Hotkey Action
Alt+Enter Toggle fullscreen/windowed mode
Ctrl+1 Keyboard controls port 1
Ctrl+2 Keyboard controls port 2
Ctrl+3 Keyboard controls port 3
Ctrl+4 Keyboard controls port 4
F1 Toggle profiler
F8 Toggle HUD

FAQ

Do you have a website?

Shadow Recompiled does not have an official website.

Please link here when directing anyone to the project.

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

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

Can I install the game using a GameCube / PlayStation 2 version?

You cannot use the files from the GameCube or PlayStation 2 version of the game.
Supporting these files would require an entirely new recompilation to handle all the differences.

Where are save data & configs?

Inside, saves are in save/ and settings in config.toml.

You can also create portable.txt beside the .exe to keep everything in your game folder.

How do I update?

Copy the files from a new release over your existing install.

How do I run the installer again?

Launch the game with --install. In a console/terminal window.

You'll only need this if you changed the game files; and want to revert to a stock setup.

Why does some of the UI have visible lines or gaps?

This is a vanilla game issue. Higher resolutions unfortunately make this issue easier to see.

Why are some sound effects missing

The Xbox version of the game has several missing sound effects. See details here if interested.

You will need to use a SFX Restoration mod to fix these defects.

What other platforms will be supported?

We only have Windows + Linux machines.
We'd happily accept community contribution for macOS.

But folks who want to support platforms that require more significant modifications (e.g. touchscreen on mobile); should make a fork.

Known Issues

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

Building

Check out the building instructions here.

Credits

Shadow Recompiled

Tester Thanks

Special Thanks

ShadowRecomp (FoxWorkshop/ShadowRecomp)

Searching Database…

What is this?It is an unofficial PC port of the Xbox version of Shadow the Hedgehog (2005). The original x86 code is statically recompiled into C++, and the port runs on Windows and Linux.
Is it a standalone game, or do I still need the original?It runs as a standalone program, but you must supply the files from your own legally acquired Xbox copy. The project ships no game assets.
How do I get it running?Download a build only from the project's Releases page on GitHub and launch it. The built-in installer walks you through installing from your own game files and runs integrity checks. Run the game with --install in a terminal to repeat that step later.
What hardware and system do I need?You need a CPU at Sandy Bridge (2011) level or newer and a GPU with Direct3D 12.0 (Shader Model 6) or Vulkan 1.2 (AMD and Nvidia from 2012, Intel from 2015). It also needs Windows 10 1909+ or a modern Linux distro, plus 2.4 GiB of storage.
Are there known gaps in the game itself?Yes. The Xbox release has several missing sound effects, so you need an SFX Restoration mod to fix them. Some UI lines and gaps are vanilla, and HD GUI mods can hide them.
Can I run it on macOS or on a phone?Not officially. The maintainers only have Windows and Linux machines, they welcome macOS contributions, and mobile versions would need a separate fork.
What does the port improve over the original Xbox game?It adds a PC options menu that works with a controller, plus 16:9, 16:10 and ultrawide support with adjustable UI alignment. High frame rate is an option, and many glitches that appear at higher frame rates are fixed. Bloom is overhauled, sound effect limits are raised, edge artifacts are fixed, and cutscenes can always be skipped.
What is XboxRecomp2?It is the main recompiler that converts the game's original x86 code into compatible C++. It was inspired by XenonRecomp, which was used to create Sonic Unleashed Recompiled.
Size
3.6 MB
Stars
377
Age
1mo
Commits · 90 Days