Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions docs/ports/rsdkv4-uwp-guide.mdx
Original file line number Diff line number Diff line change
@@ -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*
2 changes: 1 addition & 1 deletion docs/ports/sdlpop-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sm64coopdx-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/snake-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/soh-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sonic-adventure-blast2-uwp-guide.mdx
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sonic-unleashed-recompiled-guide.mdx
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sonic1decomp-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sonic2decomp-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sonic3air-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/soniccd-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sonicmania-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sonicrealms-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sonicringracers-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sonicroboblast2-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sonicsms-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/sonictimetwisted-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/spacecadetpinball-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/spelunky-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/spookydimensions-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/starfox64-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/super-mario-bros-remastered-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/super-mario-world-remastered-plus-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/supertuxkart-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/tailsadventure-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/trogdor-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/vvvvvv-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/zelda3-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/zelda64-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/zircon-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down