From 0afdff4430317d7d9c1f5f2a91d2e97add848642 Mon Sep 17 00:00:00 2001 From: Mew-Lew <167646123+Mew-Lew@users.noreply.github.com> Date: Sat, 23 May 2026 20:45:42 +0100 Subject: [PATCH] Add RSDKv4 guide and fix A-Z --- docs/ports/rsdkv4-uwp-guide.mdx | 104 ++++++++++++++++++ docs/ports/sdlpop-guide.mdx | 2 +- docs/ports/sm64coopdx-guide.mdx | 2 +- docs/ports/snake-guide.mdx | 2 +- docs/ports/soh-guide.mdx | 2 +- .../sonic-adventure-blast2-uwp-guide.mdx | 2 +- .../sonic-unleashed-recompiled-guide.mdx | 2 +- docs/ports/sonic1decomp-guide.mdx | 2 +- docs/ports/sonic2decomp-guide.mdx | 2 +- docs/ports/sonic3air-guide.mdx | 2 +- docs/ports/soniccd-guide.mdx | 2 +- docs/ports/sonicmania-guide.mdx | 2 +- docs/ports/sonicrealms-guide.mdx | 2 +- docs/ports/sonicringracers-guide.mdx | 2 +- docs/ports/sonicroboblast2-guide.mdx | 2 +- docs/ports/sonicsms-guide.mdx | 2 +- docs/ports/sonictimetwisted-guide.mdx | 2 +- docs/ports/spacecadetpinball-guide.mdx | 2 +- docs/ports/spelunky-guide.mdx | 2 +- docs/ports/spookydimensions-guide.mdx | 2 +- docs/ports/starfox64-guide.mdx | 2 +- .../super-mario-bros-remastered-guide.mdx | 2 +- ...uper-mario-world-remastered-plus-guide.mdx | 2 +- docs/ports/supertuxkart-guide.mdx | 2 +- docs/ports/tailsadventure-guide.mdx | 2 +- docs/ports/trogdor-guide.mdx | 2 +- docs/ports/vvvvvv-guide.mdx | 2 +- docs/ports/zelda3-guide.mdx | 2 +- docs/ports/zelda64-guide.mdx | 2 +- docs/ports/zircon-guide.mdx | 2 +- 30 files changed, 133 insertions(+), 29 deletions(-) create mode 100644 docs/ports/rsdkv4-uwp-guide.mdx diff --git a/docs/ports/rsdkv4-uwp-guide.mdx b/docs/ports/rsdkv4-uwp-guide.mdx new file mode 100644 index 0000000..4bfb7cf --- /dev/null +++ b/docs/ports/rsdkv4-uwp-guide.mdx @@ -0,0 +1,104 @@ +--- +title: "RSDKv4 UWP Guide" +sidebar_position: 27 +description: "A guide for setting up RSDKv4 UWP on Xbox Dev Mode." +tags: + - guides + - ports + - xbox + - uwp +slug: rsdkv4-uwp-guide +--- + +# RSDKv4 UWP Guide + +RSDKv4 UWP is an Xbox Dev Mode UWP build of RSDKv4 with a launcher for **Sonic 1** and **Sonic 2**. + +Game data is **not included**. You must provide your own legally obtained `Data.rsdk` files. + +### Install the RSDKv4 UWP App + +- Download the latest `RSDKv4 UWP` release. +- Install the `.msix` through the Xbox Device Portal. +- Install the included dependency file. + +### Default Folder Setup + +If you are using the app's local storage, launch the app once so it can create its default folders. Then place your game data in the following layout: + +```text +LocalState/ + sonic1/ + Data.rsdk + sonic2/ + Data.rsdk +``` + +Folder names should be lowercase: + +- `sonic1` +- `sonic2` + +### External Storage Setup + +You can also load game data from an external drive. + +Create the following folder layout on the external storage device: + +```text +rsdkv4/ + sonic1/ + Data.rsdk + sonic2/ + Data.rsdk +``` + +Then launch the app and press **Y** in the launcher to select the external storage root. + +### Script Mods + +For mods that use text scripts, you need to add the matching decompiled scripts from: + +[RSDKModding/RSDKv4-Script-Decompilation](https://github.com/RSDKModding/RSDKv4-Script-Decompilation) + +Expected layout: + +```text +rsdkv4/ + sonic1/ + Data.rsdk + Scripts/ + ... + sonic2/ + Data.rsdk + Scripts/ + ... +``` + +Use `Scripts` with a capital **S**. + +Text script mods require the matching decompiled script files to be present. Bytecode only mods do not need the `Scripts` folder. + +### Launcher Controls + +- Press **Y** in the launcher to select an external storage root. +- Press **View** on a game to edit **Dev Menu** and **Language** options. +- Select either **Sonic 1** or **Sonic 2** from the launcher to start the game. + + +### Troubleshooting + +If the app doesn't launch: + +- On Series S, make sure Xbox resolution is set to 1440p or lower. + +If a game does not appear or launch: + +- Check that `Data.rsdk` is inside the correct game folder. +- Make sure your folder names are lowercase: `sonic1` and `sonic2`. +- If using external storage, press **Y** again and reselect the external storage root. +- Remove or regenerate `settings.ini` if the launcher settings appear broken. + +--- + +*Contributor: MewLew* diff --git a/docs/ports/sdlpop-guide.mdx b/docs/ports/sdlpop-guide.mdx index e33b80f..52f99ea 100644 --- a/docs/ports/sdlpop-guide.mdx +++ b/docs/ports/sdlpop-guide.mdx @@ -1,6 +1,6 @@ --- title: "SDLPOP (Prince of Persia) Guide" -sidebar_position: 27 +sidebar_position: 28 description: "A guide for setting up SDLPOP (Prince of Persia) on dev mode." tags: - guides diff --git a/docs/ports/sm64coopdx-guide.mdx b/docs/ports/sm64coopdx-guide.mdx index 7ad8eb1..097d2aa 100644 --- a/docs/ports/sm64coopdx-guide.mdx +++ b/docs/ports/sm64coopdx-guide.mdx @@ -1,6 +1,6 @@ --- title: "sm64coopdx Guide" -sidebar_position: 28 +sidebar_position: 29 description: "A guide for setting up sm64coopdx on dev mode." tags: - guides diff --git a/docs/ports/snake-guide.mdx b/docs/ports/snake-guide.mdx index 7420bae..d0f3012 100644 --- a/docs/ports/snake-guide.mdx +++ b/docs/ports/snake-guide.mdx @@ -1,6 +1,6 @@ --- title: "Snake Guide" -sidebar_position: 29 +sidebar_position: 30 description: "A guide for setting up Snake on dev mode." tags: - guides diff --git a/docs/ports/soh-guide.mdx b/docs/ports/soh-guide.mdx index 2e1e940..01bc344 100644 --- a/docs/ports/soh-guide.mdx +++ b/docs/ports/soh-guide.mdx @@ -1,6 +1,6 @@ --- title: "SOH (Ship of Harkinian) Foxtrot UWP Edition Guide" -sidebar_position: 30 +sidebar_position: 31 description: "A guide for setting up SOH (Ship of Harkinian) Foxtrot UWP Edition on dev mode." tags: - guides diff --git a/docs/ports/sonic-adventure-blast2-uwp-guide.mdx b/docs/ports/sonic-adventure-blast2-uwp-guide.mdx index 1edb795..4ae2ecb 100644 --- a/docs/ports/sonic-adventure-blast2-uwp-guide.mdx +++ b/docs/ports/sonic-adventure-blast2-uwp-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 35 +sidebar_position: 36 title: Sonic Adventure Blast 2 UWP Setup Guide description: Complete guide for installing and setting up Sonic Adventure Blast 2 UWP on Xbox tags: diff --git a/docs/ports/sonic-unleashed-recompiled-guide.mdx b/docs/ports/sonic-unleashed-recompiled-guide.mdx index 62599bd..ca4d606 100644 --- a/docs/ports/sonic-unleashed-recompiled-guide.mdx +++ b/docs/ports/sonic-unleashed-recompiled-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 42 +sidebar_position: 43 title: Sonic Unleashed Recompiled UWP Setup Guide description: Complete guide for installing and setting up Sonic Unleashed Recompiled UWP on Xbox tags: diff --git a/docs/ports/sonic1decomp-guide.mdx b/docs/ports/sonic1decomp-guide.mdx index 5a2ac8a..ed927e3 100644 --- a/docs/ports/sonic1decomp-guide.mdx +++ b/docs/ports/sonic1decomp-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic 1 Decompilation Guide" -sidebar_position: 32 +sidebar_position: 33 description: "A guide for setting up Sonic 1 Decompilation on dev mode." tags: - guides diff --git a/docs/ports/sonic2decomp-guide.mdx b/docs/ports/sonic2decomp-guide.mdx index e76aec1..a8b4966 100644 --- a/docs/ports/sonic2decomp-guide.mdx +++ b/docs/ports/sonic2decomp-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic 2 Decompilation Guide" -sidebar_position: 33 +sidebar_position: 34 description: "A guide for setting up Sonic 2 Decompilation on dev mode." tags: - guides diff --git a/docs/ports/sonic3air-guide.mdx b/docs/ports/sonic3air-guide.mdx index 7e7265d..ed7716b 100644 --- a/docs/ports/sonic3air-guide.mdx +++ b/docs/ports/sonic3air-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic 3 A.I.R. Guide" -sidebar_position: 34 +sidebar_position: 35 description: "A guide for setting up Sonic 3 A.I.R on dev mode." tags: - guides diff --git a/docs/ports/soniccd-guide.mdx b/docs/ports/soniccd-guide.mdx index 87fd8f4..dc9d3f7 100644 --- a/docs/ports/soniccd-guide.mdx +++ b/docs/ports/soniccd-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic CD (Decompilation) Guide" -sidebar_position: 36 +sidebar_position: 37 description: "A guide for setting up Sonic CD (Decompilation) on dev mode." tags: - guides diff --git a/docs/ports/sonicmania-guide.mdx b/docs/ports/sonicmania-guide.mdx index 9c79442..213b80d 100644 --- a/docs/ports/sonicmania-guide.mdx +++ b/docs/ports/sonicmania-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Mania Guide" -sidebar_position: 37 +sidebar_position: 38 description: "A guide for setting up Sonic Mania on dev mode." tags: - guides diff --git a/docs/ports/sonicrealms-guide.mdx b/docs/ports/sonicrealms-guide.mdx index c455374..586c5b0 100644 --- a/docs/ports/sonicrealms-guide.mdx +++ b/docs/ports/sonicrealms-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Realms Guide" -sidebar_position: 38 +sidebar_position: 39 description: "A guide for setting up Sonic Realms on dev mode." tags: - guides diff --git a/docs/ports/sonicringracers-guide.mdx b/docs/ports/sonicringracers-guide.mdx index 1ae9e4b..f37eb13 100644 --- a/docs/ports/sonicringracers-guide.mdx +++ b/docs/ports/sonicringracers-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Ring Racers Guide" -sidebar_position: 39 +sidebar_position: 40 description: "A guide for setting up Sonic Ring Racers on dev mode." tags: - guides diff --git a/docs/ports/sonicroboblast2-guide.mdx b/docs/ports/sonicroboblast2-guide.mdx index 4c77eb7..df75d9a 100644 --- a/docs/ports/sonicroboblast2-guide.mdx +++ b/docs/ports/sonicroboblast2-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Robo Blast 2 Guide" -sidebar_position: 40 +sidebar_position: 41 description: "A guide for setting up Sonic Robo Blast 2 on dev mode." tags: - guides diff --git a/docs/ports/sonicsms-guide.mdx b/docs/ports/sonicsms-guide.mdx index 4095cae..5fc960d 100644 --- a/docs/ports/sonicsms-guide.mdx +++ b/docs/ports/sonicsms-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic 1 & 2 SMS remakes Guide" -sidebar_position: 31 +sidebar_position: 32 description: "A guide for setting up Sonic 1 & 2 SMS remakes on dev mode." tags: - guides diff --git a/docs/ports/sonictimetwisted-guide.mdx b/docs/ports/sonictimetwisted-guide.mdx index 60286fa..b173d9b 100644 --- a/docs/ports/sonictimetwisted-guide.mdx +++ b/docs/ports/sonictimetwisted-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Time Twisted Guide" -sidebar_position: 41 +sidebar_position: 42 description: "A guide for setting up Sonic Time Twisted on dev mode." tags: - guides diff --git a/docs/ports/spacecadetpinball-guide.mdx b/docs/ports/spacecadetpinball-guide.mdx index 55faa54..14e04f2 100644 --- a/docs/ports/spacecadetpinball-guide.mdx +++ b/docs/ports/spacecadetpinball-guide.mdx @@ -1,6 +1,6 @@ --- title: "SpaceCadetPinball Guide" -sidebar_position: 43 +sidebar_position: 44 description: "A guide for setting up SpaceCadetPinball on dev mode." tags: - guides diff --git a/docs/ports/spelunky-guide.mdx b/docs/ports/spelunky-guide.mdx index 3c249ae..048fc70 100644 --- a/docs/ports/spelunky-guide.mdx +++ b/docs/ports/spelunky-guide.mdx @@ -1,6 +1,6 @@ --- title: "Spelunky Classic HD Guide" -sidebar_position: 44 +sidebar_position: 45 description: "A guide for setting up Spelunky Classic HD on dev mode." tags: - guides diff --git a/docs/ports/spookydimensions-guide.mdx b/docs/ports/spookydimensions-guide.mdx index 748b6f0..044ea1e 100644 --- a/docs/ports/spookydimensions-guide.mdx +++ b/docs/ports/spookydimensions-guide.mdx @@ -1,6 +1,6 @@ --- title: "Spooky Dimensions Guide" -sidebar_position: 45 +sidebar_position: 46 description: "A guide for setting up Spooky Dimensions on dev mode." tags: - guides diff --git a/docs/ports/starfox64-guide.mdx b/docs/ports/starfox64-guide.mdx index 09619ac..a7c9bb1 100644 --- a/docs/ports/starfox64-guide.mdx +++ b/docs/ports/starfox64-guide.mdx @@ -1,6 +1,6 @@ --- title: "Starfox 64: Recompiled Guide" -sidebar_position: 46 +sidebar_position: 47 description: "A guide for setting up Starfox 64: Recompiled on dev mode." tags: - guides diff --git a/docs/ports/super-mario-bros-remastered-guide.mdx b/docs/ports/super-mario-bros-remastered-guide.mdx index ecc9d68..f7c2a55 100644 --- a/docs/ports/super-mario-bros-remastered-guide.mdx +++ b/docs/ports/super-mario-bros-remastered-guide.mdx @@ -1,6 +1,6 @@ --- title: "Super Mario Bros. Remastered Guide" -sidebar_position: 47 +sidebar_position: 48 description: "A guide for setting up Super Mario Bros. Remastered on Xbox Dev Mode." tags: - guides diff --git a/docs/ports/super-mario-world-remastered-plus-guide.mdx b/docs/ports/super-mario-world-remastered-plus-guide.mdx index 82e3101..3587878 100644 --- a/docs/ports/super-mario-world-remastered-plus-guide.mdx +++ b/docs/ports/super-mario-world-remastered-plus-guide.mdx @@ -1,6 +1,6 @@ --- title: "Super Mario World Remastered Plus Guide" -sidebar_position: 48 +sidebar_position: 49 description: "A guide for setting up Super Mario World Remastered Plus on Xbox Dev Mode." tags: - guides diff --git a/docs/ports/supertuxkart-guide.mdx b/docs/ports/supertuxkart-guide.mdx index c82621d..2a6500e 100644 --- a/docs/ports/supertuxkart-guide.mdx +++ b/docs/ports/supertuxkart-guide.mdx @@ -1,6 +1,6 @@ --- title: "SuperTuxKart Guide" -sidebar_position: 49 +sidebar_position: 50 description: "A guide for setting up SuperTuxKart on dev mode." tags: - guides diff --git a/docs/ports/tailsadventure-guide.mdx b/docs/ports/tailsadventure-guide.mdx index ac7d0a5..ce343de 100644 --- a/docs/ports/tailsadventure-guide.mdx +++ b/docs/ports/tailsadventure-guide.mdx @@ -1,6 +1,6 @@ --- title: "Tails Adventure Remake Guide" -sidebar_position: 50 +sidebar_position: 51 description: "A guide for setting up Tails Adventure Remake on dev mode." tags: - guides diff --git a/docs/ports/trogdor-guide.mdx b/docs/ports/trogdor-guide.mdx index 8e7c055..49a2c33 100644 --- a/docs/ports/trogdor-guide.mdx +++ b/docs/ports/trogdor-guide.mdx @@ -1,6 +1,6 @@ --- title: "Trogdor Reburninated Guide" -sidebar_position: 51 +sidebar_position: 52 description: "A guide for setting up Trogdor Reburninated on dev mode." tags: - guides diff --git a/docs/ports/vvvvvv-guide.mdx b/docs/ports/vvvvvv-guide.mdx index 32c97f9..0a79cf8 100644 --- a/docs/ports/vvvvvv-guide.mdx +++ b/docs/ports/vvvvvv-guide.mdx @@ -1,6 +1,6 @@ --- title: "VVVVVV (V6) Guide" -sidebar_position: 52 +sidebar_position: 53 description: "A guide for setting up VVVVVV (V6) on dev mode." tags: - guides diff --git a/docs/ports/zelda3-guide.mdx b/docs/ports/zelda3-guide.mdx index 548b47f..6f9a311 100644 --- a/docs/ports/zelda3-guide.mdx +++ b/docs/ports/zelda3-guide.mdx @@ -1,6 +1,6 @@ --- title: "Zelda 3 Guide" -sidebar_position: 53 +sidebar_position: 54 description: "A guide for setting up Zelda 3 on dev mode." tags: - guides diff --git a/docs/ports/zelda64-guide.mdx b/docs/ports/zelda64-guide.mdx index 1a099c9..739dc0b 100644 --- a/docs/ports/zelda64-guide.mdx +++ b/docs/ports/zelda64-guide.mdx @@ -1,6 +1,6 @@ --- title: "Zelda 64 Recompiled Guide" -sidebar_position: 54 +sidebar_position: 55 description: "A guide for setting up Zelda 64 Recompiled on dev mode." tags: - guides diff --git a/docs/ports/zircon-guide.mdx b/docs/ports/zircon-guide.mdx index ba4a29d..5f1340e 100644 --- a/docs/ports/zircon-guide.mdx +++ b/docs/ports/zircon-guide.mdx @@ -1,6 +1,6 @@ --- title: "Zircon (Quake) Guide" -sidebar_position: 55 +sidebar_position: 56 description: "A guide for setting up Zircon (Quake) on dev mode." tags: - guides