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
89 changes: 89 additions & 0 deletions docs/ports/rigelengine-guide.mdx
Original file line number Diff line number Diff line change
@@ -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*
2 changes: 1 addition & 1 deletion docs/ports/rsdkv4-uwp-guide.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand Down
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: 29
sidebar_position: 30
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: 30
sidebar_position: 31
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: 31
sidebar_position: 32
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: 32
sidebar_position: 33
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: 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:
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: 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:
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: 34
sidebar_position: 35
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: 35
sidebar_position: 36
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: 36
sidebar_position: 37
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: 38
sidebar_position: 39
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: 39
sidebar_position: 40
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: 40
sidebar_position: 41
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: 41
sidebar_position: 42
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: 42
sidebar_position: 43
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: 33
sidebar_position: 34
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: 43
sidebar_position: 44
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: 45
sidebar_position: 46
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: 46
sidebar_position: 47
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: 47
sidebar_position: 48
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: 48
sidebar_position: 49
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: 49
sidebar_position: 50
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: 50
sidebar_position: 51
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: 51
sidebar_position: 52
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: 52
sidebar_position: 53
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: 53
sidebar_position: 54
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: 54
sidebar_position: 55
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: 55
sidebar_position: 56
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: 56
sidebar_position: 57
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: 57
sidebar_position: 58
description: "A guide for setting up Zircon (Quake) on dev mode."
tags:
- guides
Expand Down