Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/hedge-dev/UnleashedRecomp/llms.txt

Use this file to discover all available pages before exploring further.

Unleashed Recompiled supports controllers and keyboards out of the box. The [Input] section of config.toml holds settings for camera behaviour, vibration, and controller icon display. The [Bindings] section maps every virtual controller button to a keyboard key. Several [System] settings that affect gameplay behaviour are also documented here. Controller settings are fully accessible from the in-game Options Menu. Keyboard bindings, however, must currently be changed by editing config.toml directly, as in-game action remapping is planned for a future update.
Using a controller is strongly recommended for the best experience. Keyboard support is functional but keyboard binding customisation requires manual editing of config.toml until the Action Remapping feature is added in a future update.

Input Settings

The [Input] section controls camera behaviour, vibration, and how the game detects and displays controller input.
SettingTypeDefaultDescription
HorizontalCameraenumNormalHorizontal camera rotation direction. Normal pans right when moving right; Reverse inverts this.
VerticalCameraenumNormalVertical camera rotation direction. Normal pans up when moving up; Reverse inverts this.
VibrationbooltrueEnable or disable controller rumble/vibration.
AllowBackgroundInputboolfalseWhen true, the game continues to read controller input even when the window does not have focus.
ControllerIconsenumAutoWhich button icons to display in-game. Valid values: Auto (detects your connected controller), Xbox, PlayStation.

Example

[Input]
HorizontalCamera = "Normal"
VerticalCamera = "Reverse"
Vibration = true
AllowBackgroundInput = false
ControllerIcons = "Auto"

Keyboard Bindings

The [Bindings] section maps each virtual Xbox 360 controller button to a keyboard key. The table below lists every bindable action with its config.toml key name, the PlayStation equivalent button name (for reference), and the default keyboard key.
The default keyboard layout is based on Devil’s Details’ keyboard layout for Sonic Generations (2011).
config.toml KeyXbox ButtonPlayStation ButtonDefault Key
Key_AACross (×)S
Key_BBCircle (○)D
Key_XXSquare (□)A
Key_YYTriangle (△)W
Key_DPadUpD-Pad UpD-Pad Up(Unbound)
Key_DPadDownD-Pad DownD-Pad Down(Unbound)
Key_DPadLeftD-Pad LeftD-Pad Left(Unbound)
Key_DPadRightD-Pad RightD-Pad Right(Unbound)
Key_StartStartStart / OptionsRETURN
Key_BackBackSelect / ShareBACKSPACE
Key_LeftTriggerLeft TriggerL21
Key_RightTriggerRight TriggerR23
Key_LeftBumperLeft BumperL1Q
Key_RightBumperRight BumperR1E
Key_LeftStickUpLeft Stick UpLeft Stick UpUP
Key_LeftStickDownLeft Stick DownLeft Stick DownDOWN
Key_LeftStickLeftLeft Stick LeftLeft Stick LeftLEFT
Key_LeftStickRightLeft Stick RightLeft Stick RightRIGHT
Key_RightStickUpRight Stick UpRight Stick Up(Unbound)
Key_RightStickDownRight Stick DownRight Stick Down(Unbound)
Key_RightStickLeftRight Stick LeftRight Stick Left(Unbound)
Key_RightStickRightRight Stick RightRight Stick Right(Unbound)

Changing Bindings

Open config.toml in a text editor while the game is closed and edit the [Bindings] section. Each value is a string containing the key name:
[Bindings]
Key_A = "S"
Key_B = "D"
Key_X = "A"
Key_Y = "W"
Key_DPadUp = "???"
Key_DPadDown = "???"
Key_DPadLeft = "???"
Key_DPadRight = "???"
Key_Start = "RETURN"
Key_Back = "BACKSPACE"
Key_LeftTrigger = "1"
Key_RightTrigger = "3"
Key_LeftBumper = "Q"
Key_RightBumper = "E"
Key_LeftStickUp = "UP"
Key_LeftStickDown = "DOWN"
Key_LeftStickLeft = "LEFT"
Key_LeftStickRight = "RIGHT"
Key_RightStickUp = "???"
Key_RightStickDown = "???"
Key_RightStickLeft = "???"
Key_RightStickRight = "???"

Valid Key Names

Key name strings correspond to SDL scancode names. The following are some commonly used values:
KeyValue
Letter keysAZ
Number row19, 0
Arrow keysUP, DOWN, LEFT, RIGHT
Enter / ReturnRETURN
BackspaceBACKSPACE
Space barSPACE
TabTAB
EscapeESCAPE
Function keysF1F24
Numpad keysKP 0KP 9, KP ENTER, KP PLUS, KP MINUS, KP MULTIPLY, KP DIVIDE
Unbound???
For the full list of recognised key name strings, refer to the SDL scancode enum template in the source code.

System / Gameplay Settings

These settings live in the [System] section and affect gameplay behaviour.
SettingTypeDefaultDescription
LanguageenumEnglishLanguage for all in-game text and menus. Valid values: English, Japanese, German, French, Spanish, Italian.
HintsbooltrueShow hint rings and other contextual hints during stages and boss fights. Disable to reduce on-screen guidance.
ControlTutorialbooltrueShow button prompt tutorials during gameplay that teach the player how to use certain moves. Disable if you are already familiar with the controls.
AchievementNotificationsbooltrueDisplay an achievement notification overlay when an achievement is unlocked.
TimeOfDayTransitionenumXboxStyle of the day/night transformation cutscene in towns. Xbox plays the full video and artificially extends loading time so it completes. PlayStation ends the cutscene as soon as loading is done, matching the PS3 version’s behaviour.

Example

[System]
Language = "English"
Hints = true
ControlTutorial = false
AchievementNotifications = true
TimeOfDayTransition = "PlayStation"

Build docs developers (and LLMs) love