ShadowRecomp README

README проекта с github.com/FoxWorkshop/ShadowRecomp. Одним файлом markdown: 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)

Ищем в базе…

Что это такое?Это неофициальный порт версии Shadow the Hedgehog (2005) для Xbox под ПК. Оригинальный код x86 статически перекомпилирован в C++, а порт работает на Windows и Linux.
Это отдельная игра, или мне всё равно нужен оригинал?Программа работает самостоятельно, но файлы игры нужно взять из вашей законно приобретённой копии для Xbox. Проект не содержит игровых ресурсов.
Как запустить игру?Скачайте сборку только со страницы Releases проекта на GitHub и запустите её. Встроенный установщик проведёт вас через установку из ваших собственных файлов игры и выполнит проверки целостности. Чтобы повторить этот шаг позже, запустите игру с --install в терминале.
Какое железо и система нужны?Нужен процессор уровня Sandy Bridge (2011) или новее и видеокарта с поддержкой Direct3D 12.0 (Shader Model 6) или Vulkan 1.2 (AMD и Nvidia с 2012 года, Intel с 2015 года). Также нужны Windows 10 1909+ или современный дистрибутив Linux и 2.4 GiB места на диске.
Есть ли в самой игре известные пробелы?Да. В версии для Xbox не хватает нескольких звуковых эффектов, поэтому для их исправления нужен мод SFX Restoration. Некоторые строки интерфейса и пробелы входят в оригинальную игру, и моды HD GUI могут их скрывать.
Можно ли запустить её на macOS или на телефоне?Официально нет. У мейнтейнеров есть только компьютеры с Windows и Linux, они приветствуют вклад для macOS, а мобильные версии потребовали бы отдельного форка.
Что порт улучшает по сравнению с оригинальной версией для Xbox?Добавлено меню настроек для ПК, которое работает с геймпадом, а также поддержка 16:9, 16:10 и ультраширокого формата с настраиваемым выравниванием интерфейса. Высокая частота кадров доступна как опция, и многие баги, которые проявляются при высокой частоте кадров, исправлены. Эффект свечения переработан, лимит звуковых эффектов увеличен, артефакты по краям исправлены, а заставки можно пропускать в любой момент.
Что такое XboxRecomp2?Это основной рекомпилятор, который преобразует исходный код x86 игры в совместимый C++. Он вдохновлён XenonRecomp, который использовался для создания Sonic Unleashed Recompiled.
Автор
FoxWorkshop
Размер
3.6 MB
Звёзды
377
Возраст
1 мес
Коммиты · 90 дней