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
8 changes: 4 additions & 4 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ jobs:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
fetch-depth: 0
- uses: actions/setup-node@v4
- uses: actions/setup-node@v6
with:
node-version: 25
cache: npm
Expand All @@ -27,7 +27,7 @@ jobs:
run: npm run build

- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
uses: actions/upload-pages-artifact@v5
with:
path: build

Expand All @@ -49,4 +49,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@v5
4 changes: 2 additions & 2 deletions .github/workflows/pr-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ jobs:
name: Test Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
fetch-depth: 0
- uses: actions/setup-node@v4
- uses: actions/setup-node@v6
with:
node-version: 25
cache: npm
Expand Down
43 changes: 20 additions & 23 deletions docs/apps/boxedwine-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,31 +14,31 @@ import AtAGlance from '@site/src/components/AtAGlance';

# Installing and Using BoxedWine on Xbox (Developer Mode)

This guide explains how to install and run BoxedWine, a Windows application emulator, on an Xbox Series S/X console in Developer Mode. BoxedWine allows you to run 32-bit Windows applications and games. This guide is based on a YouTube tutorial by ReviveMe (https://www.youtube.com/@ReviveMe).
This guide explains how to install and run BoxedWine, a Windows application emulator, on an Xbox Series S/X console in Developer Mode. BoxedWine allows you to run 16-bit and 32-bit Windows applications and games (per the upstream port targeting Xbox Series Developer Mode). This guide is based on a YouTube tutorial by ReviveMe (https://www.youtube.com/@ReviveMe).

<AtAGlance
title="BoxedWine (32-bit Windows apps)"
summary="Runs 32-bit Windows apps via Wine; NTFS USB strongly recommended."
title="BoxedWine (16/32-bit Windows apps)"
summary="Runs 32-bit Windows apps via Wine, NTFS USB strongly recommended."
testedOn="03/09/2025"
rows={[
{ label: 'Dev Mode', value: 'Required' },
{ label: 'Storage', value: 'NTFS USB for app zips; internal is limited' },
{ label: 'User folder', value: 'ZIPs live on USB; app data stored internally' },
{ label: 'Difficulty', value: 'Intermediate 20–30 minutes' },
{ label: 'Storage', value: 'NTFS USB for app zips, internal is limited' },
{ label: 'User folder', value: 'ZIPs live on USB, app data stored internally' },
{ label: 'Difficulty', value: 'Intermediate - 20–30 minutes' },
{ label: 'BIOS/keys', value: 'None' },
{ label: 'Controllers', value: 'Xbox gamepad; UI is cursor-driven' },
{ label: 'Controllers', value: 'Xbox gamepad, UI is cursor-driven' },
]}
works={[
'Installs via Device Portal with dependencies',
'Runs zipped 32-bit apps from USB',
'Runs zipped 16/32-bit apps from USB',
'Game type improves performance/stability',
]}
issues={[
'All app files must be zipped together',
'Wrong NTFS permissions block USB access',
'64-bit apps are unsupported',
]}
notes="Zip each 32-bit app with all needed DLLs; format USB NTFS and set permissions before install."
notes="Zip each 32-bit app with all needed DLLs, format USB NTFS and set permissions before install."
/>

## Prerequisites
Expand All @@ -57,11 +57,9 @@ The installation process is divided into three main parts:

### Part 1: Downloading and Preparing Files (on your PC)

1. **Download BoxedWine:**
* Open a web browser and go to the "Xbox Dev Store" website.
* Navigate to the section labeled "Emulators".
* Locate "BoxedWine". The description should mention "Runs 32-bit apps and games..."
* Click the "Download" button. This will download a file named `boxwine.zip`.
1. **Download BoxedWine from Emulation Revival:**
* Open [BoxedWine on Emulation Revival Store](https://emulationrevival.github.io/xbox-dev-mode/experimental-apps.html#boxedwine).
* Click **Download**. You should get a ZIP named like `Boxedwine-UWP-*.zip` (exact version in the filename).

2. **Prepare your 32-bit Application (Example: Space Cadet Pinball):**
* This guide uses "Space Cadet Pinball" as an example, but you can use any 32-bit Windows application.
Expand All @@ -76,10 +74,10 @@ The installation process is divided into three main parts:
* Copy the .zip file containing your 32-bit application *into* this newly created folder.
* Safely eject the external drive from your PC.

4. **Extract the BoxedWine .zip File:**
* On your PC, locate the `boxwine.zip` file you downloaded.
* Right-click on the file and choose "Extract All..." (or use the equivalent extraction option provided by your .zip utility). Extract the contents to a new folder (e.g., a folder also named "boxwine"). *Do not attempt to install directly from the .zip archive.*
* After extraction, you should find files including `boxwine.msixbundle` and a `Dependencies` folder within the extracted folder.
4. **Extract the BoxedWine ZIP:**
* On your PC, locate the downloaded `Boxedwine-UWP-*.zip`.
* Extract it to a new folder (keep the path simple, e.g. `Boxedwine-UWP`). Do not install straight from the ZIP in Device Portal.
* Inside the extracted folder you should have the main **`.msixbundle`** and a **`Dependencies`** folder (with an `x64` subfolder of `.appx` files). Exact names can change by release, use the `.msixbundle` at the root of the extract.

### Part 2: Installing BoxedWine on Your Xbox (Using Remote Access)

Expand All @@ -103,20 +101,19 @@ The installation process is divided into three main parts:
3. **Install BoxedWine:**
* Once you are in the Xbox Device Portal (in your web browser), locate the "My games & apps" section.
* Click the "Add" button.
* Click "Choose file" (or a similarly labeled button) and navigate to the extracted `boxwine` folder on your PC (where you extracted `boxwine.zip`).
* Select the `boxwine.msixbundle` file and click "Open".
* Click "Choose file" (or a similarly labeled button) and open the **`.msixbundle`** from your extracted `Boxedwine-UWP-*` folder (the file at the root of the extract, not inside `Dependencies`).
* Click "Next".

4. **Install Dependencies:**
* The portal will prompt you to "Choose any necessary dependencies".
* Click "Choose file" again.
* Navigate to the `Dependencies` folder *inside* the extracted `boxwine` folder, and then go into the `x64` folder.
* Go to `Dependencies\x64` inside that same extracted folder.

:::danger
You must add *all five* dependency files, and you must do it *one by one*. Select each file individually and click "Open" for each one.
Add **every** `.appx` in `Dependencies\x64`, **one file per prompt** (repeat **Choose file** until each package is listed). The count can change by release. Missing one will break install.
:::

* After all five dependencies have been added, click "Start".
* After all dependencies are added, click "Start".

5. **Wait for Installation to Complete:**
* The installation process will take some time. Wait until you see the message "Package successfully registered".
Expand Down
12 changes: 6 additions & 6 deletions docs/apps/gzdoom-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ This guide explains how to set up GZDoom, a source port of the Doom engine, on a

<AtAGlance
title="GZDoom (Doom engine)"
summary="USB or internal; keep WADs flat and set app type to Game."
summary="USB or internal, keep WADs flat and set app type to Game."
testedOn="03/09/2025"
rows={[
{ label: 'Dev Mode', value: 'Required' },
{ label: 'Storage', value: 'USB NTFS recommended; LocalState works for internal' },
{ label: 'Storage', value: 'USB NTFS recommended, LocalState works for internal' },
{ label: 'User folder', value: 'USB:\\GZDoom\\Games/Mods or LocalState with Mods folder' },
{ label: 'Difficulty', value: 'Easy about 10–15 minutes' },
{ label: 'Difficulty', value: 'Easy - about 10–15 minutes' },
{ label: 'BIOS/keys', value: 'None' },
{ label: 'Controllers', value: 'Xbox gamepad' },
]}
Expand All @@ -38,7 +38,7 @@ This guide explains how to set up GZDoom, a source port of the Doom engine, on a
'Missing NTFS permissions on USB prevent access',
'Forgetting to set app type to Game can hurt performance',
]}
notes="Place WADs/mods flat (no deep nesting); set app type to Game after install."
notes="Place WADs/mods flat (no deep nesting), set app type to Game after install."
/>

## External Drive Setup
Expand All @@ -57,7 +57,7 @@ This method uses a USB drive for storing game files and mods.

### 2. Initial GZDoom Launch and Game Selection

1. **Install GZDoom:** Install the GZDoom application through the Xbox Dev Portal (instructions for accessing the Dev Portal are assumed to be known).
1. **Install GZDoom:** Download **`zdoom_*_x64.msixbundle`** from [Emulators - GZDoom on Emulation Revival Store](https://emulationrevival.github.io/xbox-dev-mode/emulators.html#gzdoom) (or the [GZDoom UWP releases](https://github.com/aerisarn/gzdoom-uwp/releases) the store mirrors). Sideload the **`.msixbundle`** through Device Portal, add dependency packages only if that specific release includes a `Dependencies` folder or separate `.appx` files.
2. **Launch GZDoom:** Launch GZDoom on your Xbox.
3. **Navigate and select your Games folder:** You'll be prompted to select a folder. Navigate to your external drive and select the *Games* folder you created (e.g., `E:\GZDoom\Games`).

Expand Down Expand Up @@ -149,7 +149,7 @@ This method uses the Xbox's internal storage.

5. **Save and Reupload:** Save your modified `gzdoom_portable.ini` to your PC, then using the **Dev Portal**, upload and replace the `gzdoom_portable.ini` back into the `LocalState` folder on your Xbox.

6. **Launch and Play:** Launch GZDoom; your mods should be loaded.
6. **Launch and Play:** Launch GZDoom, your mods should be loaded.

## Notes and Tips

Expand Down
19 changes: 9 additions & 10 deletions docs/apps/launchpass-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ LaunchPass is a Frontend that is capable of launching ROMs in most Emulators on

<AtAGlance
title="LaunchPass (Frontend)"
summary="Frontend for emulators; NTFS USB mandatory for LaunchBox assets."
summary="Frontend for emulators, NTFS USB mandatory for LaunchBox assets."
testedOn="11/14/2024"
rows={[
{ label: 'Dev Mode', value: 'Required' },
{ label: 'Storage', value: 'NTFS USB required for LaunchBox install and ROM paths' },
{ label: 'User folder', value: 'LaunchBox installed to USB (e.g., E:\\LaunchBox)' },
{ label: 'Difficulty', value: 'Intermediate 20–30 minutes' },
{ label: 'Difficulty', value: 'Intermediate - 20–30 minutes' },
{ label: 'BIOS/keys', value: 'Depends on emulators configured' },
{ label: 'Controllers', value: 'Xbox gamepad; set app type to App (per guide) for best UX' },
{ label: 'Controllers', value: 'Xbox gamepad, set app type to App (per guide) for best UX' },
]}
works={[
'Installs LaunchPass via Device Portal',
Expand All @@ -36,9 +36,9 @@ LaunchPass is a Frontend that is capable of launching ROMs in most Emulators on
issues={[
'Wrong NTFS permissions block USB access',
'Forgetting to set correct emulator paths breaks launching',
'Needs full LaunchBox folder on USB; internal storage is limited',
'Needs full LaunchBox folder on USB, internal storage is limited',
]}
notes="Install LaunchBox to NTFS USB before wiring emulators; double-check app/game type per instructions."
notes="Install LaunchBox to NTFS USB before wiring emulators, double-check app/game type per instructions."
/>
## Requirements Checklist

Expand All @@ -53,9 +53,8 @@ You will need LaunchBox to use LaunchPass.

## Setting up LaunchPass on Xbox

1. On your computer, download the latest version of LaunchPass (see download instructions below).
2. Download the latest version of Launchpass.
3. You'll get the .MSIX file (LaunchPass)
1. On your PC, open [LaunchPass on Emulation Revival Store](https://emulationrevival.github.io/xbox-dev-mode/frontends.html#launchpass) and download **LaunchPass** (`LaunchPass_*_x64.msixbundle` from the releases mirror), then download **LaunchPass - Dependency files** (`Dependencies_x64.zip`).
2. Extract `Dependencies_x64.zip` so you have a folder of **`x64` `.appx`** dependency packages (install these through Device Portal when prompted, one file at a time).

## Transfer the Files to Xbox

Expand All @@ -67,8 +66,8 @@ You will need LaunchBox to use LaunchPass.

1. In the Device Portal, go to My Games & Apps.
2. Click Add, then select Choose File.
3. Upload the LaunchPass .MsixBundles file
4. Click Next and follow the prompts to install.
3. Select the **`LaunchPass_*.msixbundle`**, click **Next**, then add **each** dependency **`.appx`** from your extracted **`Dependencies_x64`** folder until the wizard has them all listed.
4. Click **Start** and wait until you see **Package successfully registered**.
5. Go to Dev Mode on your Xbox then Select LaunchPass and click Guide button on your controller > View Details
Turn LaunchPass Game to App to be able to use Launchpass properly.

Expand Down
16 changes: 8 additions & 8 deletions docs/apps/razeuwp-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ This guide explains how to set up Raze, a source port for Build engine games (li

<AtAGlance
title="RazeUWP (Build engine)"
summary="Build-engine port; USB recommended for games/mods with prebuilt ini."
summary="Build-engine port, USB recommended for games/mods with prebuilt ini."
testedOn="03/09/2025"
rows={[
{ label: 'Dev Mode', value: 'Required' },
{ label: 'Storage', value: 'NTFS USB recommended; LocalState works with zip upload' },
{ label: 'User folder', value: 'USB:\\Raze for external; LocalState for internal' },
{ label: 'Difficulty', value: 'Intermediate 20–30 minutes' },
{ label: 'BIOS/keys', value: 'None; needs original game data (GRP/RFF etc.)' },
{ label: 'Storage', value: 'NTFS USB recommended, LocalState works with zip upload' },
{ label: 'User folder', value: 'USB:\\Raze for external, LocalState for internal' },
{ label: 'Difficulty', value: 'Intermediate - 20–30 minutes' },
{ label: 'BIOS/keys', value: 'None, needs original game data (GRP/RFF etc.)' },
{ label: 'Controllers', value: 'Xbox gamepad' },
]}
works={[
Expand All @@ -38,15 +38,15 @@ This guide explains how to set up Raze, a source port for Build engine games (li
'Wrong NTFS permissions block USB access',
'Forgetting to change save_dir for internal setup causes save errors',
]}
notes="Use the premade folder and keep game files in the expected per-title subfolders; verify NTFS permissions."
notes="Use the premade folder and keep game files in the expected per-title subfolders, verify NTFS permissions."
/>

## Prerequisites

:::info
- **Premade USB Folder:** Download the premade USB folder from this Discord link: [https://discord.com/channels/1024833470020722760/1223422209431834684](https://discord.com/channels/1024833470020722760/1223422209431834684). This folder contains a pre-structured `Raze` folder and a preconfigured `raze_portable.ini` file.
- **Game Files:** You will need the original game files for the games you want to play (e.g., `DUKE3D.GRP`, `BLOOD.RFF`). These are *not* included in the premade folder.
- **Raze:** You'll need to install the Raze application via the Xbox Dev Portal (instructions for accessing the Dev Portal are assumed to be known).
- **Raze:** Install **`raze_*_x64.msixbundle`** from [Emulators - Raze on Emulation Revival Store](https://emulationrevival.github.io/xbox-dev-mode/emulators.html#raze) or [Raze-uwp releases](https://github.com/aerisarn/Raze-uwp/releases) via Device Portal (typically a single bundle).
- **(Optional) Mod Files:** If you intend to use mods, you should have them downloaded and ready to go.
:::

Expand Down Expand Up @@ -112,7 +112,7 @@ This method uses a USB drive to store game files, mods, and the Raze configurati

5. **Save and Reupload:** Save your modified `raze_portable.ini` to your PC, then using the **Dev Portal**, upload and replace the `raze_portable.ini` back into the `LocalState` folder on your Xbox.

6. **Launch and Play:** Launch Raze; your mods should be loaded for the specified game.
6. **Launch and Play:** Launch Raze, your mods should be loaded for the specified game.

## Internal Setup

Expand Down
Loading
Loading