diff --git a/docs/ports/rigelengine-guide.mdx b/docs/ports/rigelengine-guide.mdx new file mode 100644 index 0000000..5eee01f --- /dev/null +++ b/docs/ports/rigelengine-guide.mdx @@ -0,0 +1,89 @@ +--- +title: "Rigel Engine Guide" +sidebar_position: 28 +description: "A guide for setting up and using Rigel Engine on Xbox Dev Mode." +tags: + - guides + - ports + - xbox + - uwp +slug: rigelengine-guide +--- + +# Rigel Engine Guide + +RigelEngine UWP is an Xbox Dev Mode UWP package for **RigelEngine**. + +This package works on **Xbox One** and **Xbox Series S/X**. + +Game data is **not included**. You must provide your own legally obtained **Duke Nukem II** files. + +### Install the RigelEngine UWP App + +- Download the latest `RigelEngine UWP` release. +- Install the `.msix` through the Xbox Device Portal. +- Install the included dependency file. +- Launch the app once so it can create its default LocalState folder. + +### LocalState Game Data Setup + +After installing the MSIX and launching the game once, place your Duke Nukem II files in the app's LocalState folder. + +Example layout: + +```text +LocalState/ + DUKE2/ + NUKEM2.EXE + *.CMP + *.F1 + ... +``` + +The `DUKE2` folder should contain the Duke Nukem II game files. + +### External Storage Setup + +You can also keep the Duke Nukem II game data on an external drive. + +If your files are on an external drive: + +- Connect the external drive to the Xbox. +- Launch Rigel Engine. +- Use the file picker to choose the `DUKE2` folder on your **E:** drive. + +Once selected, RigelEngine should use that external folder as the game data location. + +### Acquiring the Game Data + +For notes on how to acquire the Duke Nukem II game data, read the **Acquiring the game data** section in the main repository README: + +[caorthann-celt/RigelEngineUWP - Acquiring the game data](https://github.com/caorthann-celt/RigelEngineUWP#acquiring-the-game-data) + +### Upscaling Filter Notes + +The **Pixel-perfect** upscaling filter uses integer scaling. + +RigelEngine's corrected 4:3 output needs enough vertical resolution for this mode to work properly. On Xbox, that means Pixel-perfect scaling is practical at: + +- `1440p` +- `2160p` + +It is not practical at `1080p`. + +If your display is set to `1080p`, use **Sharp Bilinear** instead. + +### Recommended Display Setup + +### Troubleshooting + +If the game does not launch or cannot find the data files: + +- Make sure you launched the app once before copying files into LocalState. +- Check that the folder is named exactly `DUKE2`. +- Check that the required Duke Nukem II data files are also inside the same folder. +- If using external storage, reselect the `DUKE2` folder with the file picker. + +--- + +*Contributor: MewLew* diff --git a/docs/ports/rsdkv4-uwp-guide.mdx b/docs/ports/rsdkv4-uwp-guide.mdx index b220947..3a0d281 100644 --- a/docs/ports/rsdkv4-uwp-guide.mdx +++ b/docs/ports/rsdkv4-uwp-guide.mdx @@ -1,6 +1,6 @@ --- title: "RSDKv4 UWP Guide" -sidebar_position: 28 +sidebar_position: 29 description: "A guide for setting up RSDKv4 UWP on Xbox Dev Mode." tags: - guides diff --git a/docs/ports/sdlpop-guide.mdx b/docs/ports/sdlpop-guide.mdx index 2f925e2..73e4b59 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: 29 +sidebar_position: 30 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 4400849..c9c62b9 100644 --- a/docs/ports/sm64coopdx-guide.mdx +++ b/docs/ports/sm64coopdx-guide.mdx @@ -1,6 +1,6 @@ --- title: "sm64coopdx Guide" -sidebar_position: 30 +sidebar_position: 31 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 e5470e0..de3345e 100644 --- a/docs/ports/snake-guide.mdx +++ b/docs/ports/snake-guide.mdx @@ -1,6 +1,6 @@ --- title: "Snake Guide" -sidebar_position: 31 +sidebar_position: 32 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 ffa32e1..0887510 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: 32 +sidebar_position: 33 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 c7356a0..ab3f9e5 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: 37 +sidebar_position: 38 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 d3561af..282d4ed 100644 --- a/docs/ports/sonic-unleashed-recompiled-guide.mdx +++ b/docs/ports/sonic-unleashed-recompiled-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 44 +sidebar_position: 45 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 dd3f3c6..6622f12 100644 --- a/docs/ports/sonic1decomp-guide.mdx +++ b/docs/ports/sonic1decomp-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic 1 Decompilation Guide" -sidebar_position: 34 +sidebar_position: 35 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 84824eb..c3a4668 100644 --- a/docs/ports/sonic2decomp-guide.mdx +++ b/docs/ports/sonic2decomp-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic 2 Decompilation Guide" -sidebar_position: 35 +sidebar_position: 36 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 f14b6ab..2e6fb5e 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: 36 +sidebar_position: 37 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 9419f8b..c6e88bd 100644 --- a/docs/ports/soniccd-guide.mdx +++ b/docs/ports/soniccd-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic CD (Decompilation) Guide" -sidebar_position: 38 +sidebar_position: 39 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 629e478..b1e1996 100644 --- a/docs/ports/sonicmania-guide.mdx +++ b/docs/ports/sonicmania-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Mania Guide" -sidebar_position: 39 +sidebar_position: 40 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 bdc1542..1f70fb1 100644 --- a/docs/ports/sonicrealms-guide.mdx +++ b/docs/ports/sonicrealms-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Realms Guide" -sidebar_position: 40 +sidebar_position: 41 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 860ce15..b031351 100644 --- a/docs/ports/sonicringracers-guide.mdx +++ b/docs/ports/sonicringracers-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Ring Racers Guide" -sidebar_position: 41 +sidebar_position: 42 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 7001c0a..4922a79 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: 42 +sidebar_position: 43 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 dec527a..cadff0c 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: 33 +sidebar_position: 34 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 2413ce3..f4a4681 100644 --- a/docs/ports/sonictimetwisted-guide.mdx +++ b/docs/ports/sonictimetwisted-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Time Twisted Guide" -sidebar_position: 43 +sidebar_position: 44 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 c994f10..1fa23bc 100644 --- a/docs/ports/spacecadetpinball-guide.mdx +++ b/docs/ports/spacecadetpinball-guide.mdx @@ -1,6 +1,6 @@ --- title: "SpaceCadetPinball Guide" -sidebar_position: 45 +sidebar_position: 46 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 3678332..32c5c69 100644 --- a/docs/ports/spelunky-guide.mdx +++ b/docs/ports/spelunky-guide.mdx @@ -1,6 +1,6 @@ --- title: "Spelunky Classic HD Guide" -sidebar_position: 46 +sidebar_position: 47 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 2ae06f2..431faa5 100644 --- a/docs/ports/spookydimensions-guide.mdx +++ b/docs/ports/spookydimensions-guide.mdx @@ -1,6 +1,6 @@ --- title: "Spooky Dimensions Guide" -sidebar_position: 47 +sidebar_position: 48 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 144ec64..2c2c320 100644 --- a/docs/ports/starfox64-guide.mdx +++ b/docs/ports/starfox64-guide.mdx @@ -1,6 +1,6 @@ --- title: "Starfox 64: Recompiled Guide" -sidebar_position: 48 +sidebar_position: 49 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 47558b5..8e74184 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: 49 +sidebar_position: 50 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 0cc75a2..55cf086 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: 50 +sidebar_position: 51 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 2aa8bab..2f22bce 100644 --- a/docs/ports/supertuxkart-guide.mdx +++ b/docs/ports/supertuxkart-guide.mdx @@ -1,6 +1,6 @@ --- title: "SuperTuxKart Guide" -sidebar_position: 51 +sidebar_position: 52 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 abf9582..a444a17 100644 --- a/docs/ports/tailsadventure-guide.mdx +++ b/docs/ports/tailsadventure-guide.mdx @@ -1,6 +1,6 @@ --- title: "Tails Adventure Remake Guide" -sidebar_position: 52 +sidebar_position: 53 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 c7df015..dfcc5f0 100644 --- a/docs/ports/trogdor-guide.mdx +++ b/docs/ports/trogdor-guide.mdx @@ -1,6 +1,6 @@ --- title: "Trogdor Reburninated Guide" -sidebar_position: 53 +sidebar_position: 54 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 c36e44d..443068b 100644 --- a/docs/ports/vvvvvv-guide.mdx +++ b/docs/ports/vvvvvv-guide.mdx @@ -1,6 +1,6 @@ --- title: "VVVVVV (V6) Guide" -sidebar_position: 54 +sidebar_position: 55 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 60800c3..19f1ec9 100644 --- a/docs/ports/zelda3-guide.mdx +++ b/docs/ports/zelda3-guide.mdx @@ -1,6 +1,6 @@ --- title: "Zelda 3 Guide" -sidebar_position: 55 +sidebar_position: 56 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 476e25f..73eff00 100644 --- a/docs/ports/zelda64-guide.mdx +++ b/docs/ports/zelda64-guide.mdx @@ -1,6 +1,6 @@ --- title: "Zelda 64 Recompiled Guide" -sidebar_position: 56 +sidebar_position: 57 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 74a17d7..62112cd 100644 --- a/docs/ports/zircon-guide.mdx +++ b/docs/ports/zircon-guide.mdx @@ -1,6 +1,6 @@ --- title: "Zircon (Quake) Guide" -sidebar_position: 57 +sidebar_position: 58 description: "A guide for setting up Zircon (Quake) on dev mode." tags: - guides