From 0fe970add1e9256c697fcfd6ae1bfe9d2318b390 Mon Sep 17 00:00:00 2001 From: SternXD Date: Sun, 10 May 2026 14:17:04 -0400 Subject: [PATCH] docs: Add all guides from EmulationRevival site Co-authored-by: MewLew <167646123+Mew-Lew@users.noreply.github.com> --- docs/development/compiling-dolphin-guide.mdx | 1 + docs/development/compiling-mesa-guide.mdx | 3 +- docs/development/compiling-xbsx2-guide.mdx | 3 +- docs/development/compiling-xenia-guide.mdx | 3 +- docs/development/index.mdx | 21 ++- docs/{apps => emulation}/boxedwine-guide.mdx | 5 +- docs/emulation/dolphin-guide.mdx | 5 +- docs/emulation/flycast-guide.mdx | 5 +- docs/emulation/index.mdx | 28 +++- docs/emulation/ppsspp-guide.mdx | 5 +- docs/emulation/retroarch-guide.mdx | 5 +- docs/emulation/segamodel3-g920-guide.mdx | 43 ++++++ docs/emulation/segamodel3-guide.mdx | 40 +++++ docs/emulation/xbsx2-guide.mdx | 5 +- .../chonkystation3-guide.mdx | 3 +- docs/experimental/hedgephysics-guide.mdx | 32 ++++ docs/experimental/index.mdx | 24 +++ .../panda3ds-guide.mdx | 7 +- docs/experimental/sm64hd-guide.mdx | 35 +++++ .../touchhle-guide.mdx | 3 +- docs/faq.mdx | 1 + docs/frontends/index.mdx | 18 +++ docs/{apps => frontends}/launchpass-guide.mdx | 8 +- docs/helpful-links/index.mdx | 18 ++- .../visual-studio-2022-setup.mdx | 1 + .../visual-studio-2026-setup.mdx | 1 + .../worleydls-uwp-porting-notes.mdx | 3 +- docs/helpful-links/xbox-uwp-development.mdx | 3 +- docs/intro.mdx | 1 + docs/ports/castlevania-guide.mdx | 34 ++++ docs/ports/celeste-guide.mdx | 32 ++++ docs/ports/celeste64-guide.mdx | 27 ++++ docs/ports/chronodivide-guide.mdx | 40 +++++ docs/ports/darkplaces-guide.mdx | 65 ++++++++ docs/ports/descent3-guide.mdx | 43 ++++++ docs/ports/devilutionx-guide.mdx | 51 ++++++ docs/ports/dhewm3-guide.mdx | 48 ++++++ docs/ports/doom3do-guide.mdx | 42 +++++ docs/ports/dxxrebirth-guide.mdx | 61 ++++++++ docs/{apps => ports}/gzdoom-guide.mdx | 7 +- docs/ports/index.mdx | 18 +++ docs/ports/inferno-guide.mdx | 40 +++++ docs/ports/ioquake3-guide.mdx | 48 ++++++ docs/ports/jazz2-guide.mdx | 65 ++++++++ docs/ports/jkdf2-guide.mdx | 59 +++++++ docs/ports/maze-guide.mdx | 34 ++++ docs/ports/mine-guide.mdx | 32 ++++ docs/ports/nzp-guide.mdx | 63 ++++++++ docs/ports/openbor-guide.mdx | 33 ++++ docs/ports/openlara-guide.mdx | 97 ++++++++++++ docs/ports/opentyrian-guide.mdx | 48 ++++++ docs/ports/perfectdark-guide.mdx | 38 +++++ docs/{apps => ports}/razeuwp-guide.mdx | 7 +- docs/ports/relichunters-guide.mdx | 28 ++++ docs/ports/sdlpop-guide.mdx | 26 ++++ docs/ports/sm64coopdx-guide.mdx | 103 +++++++++++++ docs/ports/snake-guide.mdx | 37 +++++ docs/ports/soh-guide.mdx | 58 +++++++ .../sonic-adventure-blast2-uwp-guide.mdx} | 7 +- .../sonic-unleashed-recompiled-guide.mdx} | 7 +- docs/ports/sonic1decomp-guide.mdx | 52 +++++++ docs/ports/sonic2decomp-guide.mdx | 52 +++++++ docs/ports/sonic3air-guide.mdx | 42 +++++ docs/ports/soniccd-guide.mdx | 45 ++++++ docs/ports/sonicmania-guide.mdx | 87 +++++++++++ docs/ports/sonicrealms-guide.mdx | 27 ++++ docs/ports/sonicringracers-guide.mdx | 51 ++++++ docs/ports/sonicroboblast2-guide.mdx | 63 ++++++++ docs/ports/sonicsms-guide.mdx | 33 ++++ docs/ports/sonictimetwisted-guide.mdx | 29 ++++ docs/ports/spacecadetpinball-guide.mdx | 76 +++++++++ docs/ports/spelunky-guide.mdx | 39 +++++ docs/ports/spookydimensions-guide.mdx | 34 ++++ docs/ports/starfox64-guide.mdx | 65 ++++++++ docs/ports/supertuxkart-guide.mdx | 56 +++++++ docs/ports/tailsadventure-guide.mdx | 145 ++++++++++++++++++ docs/ports/trogdor-guide.mdx | 27 ++++ docs/ports/vvvvvv-guide.mdx | 35 +++++ docs/ports/zelda3-guide.mdx | 36 +++++ docs/ports/zelda64-guide.mdx | 42 +++++ docs/ports/zircon-guide.mdx | 56 +++++++ docs/xbox-setup/index.mdx | 19 +++ docs/xbox-setup/xbox-developer-mode-setup.mdx | 3 +- package.json | 2 +- sidebars.js | 53 ++----- 85 files changed, 2702 insertions(+), 95 deletions(-) rename docs/{apps => emulation}/boxedwine-guide.mdx (98%) create mode 100644 docs/emulation/segamodel3-g920-guide.mdx create mode 100644 docs/emulation/segamodel3-guide.mdx rename docs/{emulation => experimental}/chonkystation3-guide.mdx (99%) create mode 100644 docs/experimental/hedgephysics-guide.mdx create mode 100644 docs/experimental/index.mdx rename docs/{emulation => experimental}/panda3ds-guide.mdx (98%) create mode 100644 docs/experimental/sm64hd-guide.mdx rename docs/{emulation => experimental}/touchhle-guide.mdx (99%) create mode 100644 docs/frontends/index.mdx rename docs/{apps => frontends}/launchpass-guide.mdx (98%) create mode 100644 docs/ports/castlevania-guide.mdx create mode 100644 docs/ports/celeste-guide.mdx create mode 100644 docs/ports/celeste64-guide.mdx create mode 100644 docs/ports/chronodivide-guide.mdx create mode 100644 docs/ports/darkplaces-guide.mdx create mode 100644 docs/ports/descent3-guide.mdx create mode 100644 docs/ports/devilutionx-guide.mdx create mode 100644 docs/ports/dhewm3-guide.mdx create mode 100644 docs/ports/doom3do-guide.mdx create mode 100644 docs/ports/dxxrebirth-guide.mdx rename docs/{apps => ports}/gzdoom-guide.mdx (98%) create mode 100644 docs/ports/index.mdx create mode 100644 docs/ports/inferno-guide.mdx create mode 100644 docs/ports/ioquake3-guide.mdx create mode 100644 docs/ports/jazz2-guide.mdx create mode 100644 docs/ports/jkdf2-guide.mdx create mode 100644 docs/ports/maze-guide.mdx create mode 100644 docs/ports/mine-guide.mdx create mode 100644 docs/ports/nzp-guide.mdx create mode 100644 docs/ports/openbor-guide.mdx create mode 100644 docs/ports/openlara-guide.mdx create mode 100644 docs/ports/opentyrian-guide.mdx create mode 100644 docs/ports/perfectdark-guide.mdx rename docs/{apps => ports}/razeuwp-guide.mdx (98%) create mode 100644 docs/ports/relichunters-guide.mdx create mode 100644 docs/ports/sdlpop-guide.mdx create mode 100644 docs/ports/sm64coopdx-guide.mdx create mode 100644 docs/ports/snake-guide.mdx create mode 100644 docs/ports/soh-guide.mdx rename docs/{apps/sonic-adventure-blast2-uwp.mdx => ports/sonic-adventure-blast2-uwp-guide.mdx} (98%) rename docs/{apps/sonic-unleashed-recompiled.mdx => ports/sonic-unleashed-recompiled-guide.mdx} (99%) create mode 100644 docs/ports/sonic1decomp-guide.mdx create mode 100644 docs/ports/sonic2decomp-guide.mdx create mode 100644 docs/ports/sonic3air-guide.mdx create mode 100644 docs/ports/soniccd-guide.mdx create mode 100644 docs/ports/sonicmania-guide.mdx create mode 100644 docs/ports/sonicrealms-guide.mdx create mode 100644 docs/ports/sonicringracers-guide.mdx create mode 100644 docs/ports/sonicroboblast2-guide.mdx create mode 100644 docs/ports/sonicsms-guide.mdx create mode 100644 docs/ports/sonictimetwisted-guide.mdx create mode 100644 docs/ports/spacecadetpinball-guide.mdx create mode 100644 docs/ports/spelunky-guide.mdx create mode 100644 docs/ports/spookydimensions-guide.mdx create mode 100644 docs/ports/starfox64-guide.mdx create mode 100644 docs/ports/supertuxkart-guide.mdx create mode 100644 docs/ports/tailsadventure-guide.mdx create mode 100644 docs/ports/trogdor-guide.mdx create mode 100644 docs/ports/vvvvvv-guide.mdx create mode 100644 docs/ports/zelda3-guide.mdx create mode 100644 docs/ports/zelda64-guide.mdx create mode 100644 docs/ports/zircon-guide.mdx create mode 100644 docs/xbox-setup/index.mdx diff --git a/docs/development/compiling-dolphin-guide.mdx b/docs/development/compiling-dolphin-guide.mdx index d98fdd5..5ee7070 100644 --- a/docs/development/compiling-dolphin-guide.mdx +++ b/docs/development/compiling-dolphin-guide.mdx @@ -2,6 +2,7 @@ sidebar_position: 2 title: Building DolphinUWP from Source - Stern & SirMangler description: Complete guide for building DolphinUWP from source for Xbox deployment +slug: compiling-dolphin-guide --- # Building DolphinUWP from Source - Stern & SirMangler diff --git a/docs/development/compiling-mesa-guide.mdx b/docs/development/compiling-mesa-guide.mdx index f96e7a5..1c54d44 100644 --- a/docs/development/compiling-mesa-guide.mdx +++ b/docs/development/compiling-mesa-guide.mdx @@ -1,7 +1,8 @@ --- -sidebar_position: 4 +sidebar_position: 3 title: How to Compile Mesa for UWP description: Complete guide for compiling Mesa graphics library for Universal Windows Platform +slug: compiling-mesa-guide --- # How to Compile Mesa for UWP diff --git a/docs/development/compiling-xbsx2-guide.mdx b/docs/development/compiling-xbsx2-guide.mdx index 7be2b5e..2df9fde 100644 --- a/docs/development/compiling-xbsx2-guide.mdx +++ b/docs/development/compiling-xbsx2-guide.mdx @@ -1,7 +1,8 @@ --- -sidebar_position: 1 +sidebar_position: 4 title: Building XBSX2 from Source - Stern description: Complete guide for compiling XBSX2 for Xbox deployment +slug: compiling-xbsx2-guide --- # Guide to Build XBSX2 diff --git a/docs/development/compiling-xenia-guide.mdx b/docs/development/compiling-xenia-guide.mdx index 8db0527..0ccf64f 100644 --- a/docs/development/compiling-xenia-guide.mdx +++ b/docs/development/compiling-xenia-guide.mdx @@ -1,7 +1,8 @@ --- -sidebar_position: 3 +sidebar_position: 5 title: Building Xenia Canary (UWP) from Source - Stern & SirMangler description: Complete guide for building Xenia Canary UWP from source for Xbox deployment +slug: compiling-xenia-guide --- # Building Xenia Canary (UWP) from Source - Stern & SirMangler diff --git a/docs/development/index.mdx b/docs/development/index.mdx index c787b48..4de918b 100644 --- a/docs/development/index.mdx +++ b/docs/development/index.mdx @@ -1,18 +1,27 @@ +--- +title: Development Guides +sidebar_position: 1 +description: Compiling emulators and development tooling for Xbox Developer Mode UWP workflows. +slug: /development +--- + # Development Guides This section contains guides for compiling and developing emulators and applications for Xbox Developer Mode. -## Compiling Emulators +## Compiling emulators -- **[Compiling XBSX2](./compiling-xbsx2-guide)** - Build the PS2 emulator from source -- **[Compiling Dolphin](./compiling-dolphin-guide)** - Build the GameCube/Wii emulator from source -- **[Compiling Xenia](./compiling-xenia-guide)** - Build the Xbox 360 emulator from source -- **[Compiling Mesa](./compiling-mesa-guide)** - Build graphics drivers for better compatibility +- **[Compiling XBSX2](/docs/development/compiling-xbsx2-guide)** - Build the PS2 emulator from source +- **[Compiling Dolphin](/docs/development/compiling-dolphin-guide)** - Build the GameCube/Wii emulator from source +- **[Compiling Xenia](/docs/development/compiling-xenia-guide)** - Build the Xbox 360 emulator from source +- **[Compiling Mesa](/docs/development/compiling-mesa-guide)** - Build graphics drivers for better compatibility -## Development Tools +## Development tools These guides will help you set up your development environment and compile emulators that may offer better performance or features than pre-compiled versions. +End-user setup for **community native ports and experimental UWP apps** (installed MSIX, data files, USB layout) is in the sidebar under **Experimental UWP (community)** and **Native ports & engines (community)**. + ## Prerequisites Before compiling emulators, ensure you have: diff --git a/docs/apps/boxedwine-guide.mdx b/docs/emulation/boxedwine-guide.mdx similarity index 98% rename from docs/apps/boxedwine-guide.mdx rename to docs/emulation/boxedwine-guide.mdx index 0bb1a83..b1008cc 100644 --- a/docs/apps/boxedwine-guide.mdx +++ b/docs/emulation/boxedwine-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 2 title: BoxedWine UWP Setup Guide description: Complete guide for installing and using BoxedWine Windows emulator on Xbox tags: @@ -8,6 +8,7 @@ tags: - uwp - windows - xbox +slug: boxedwine-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -24,7 +25,7 @@ This guide explains how to install and run BoxedWine, a Windows application emul { 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: 'Difficulty', value: 'Intermediate - 20-30 minutes' }, { label: 'BIOS/keys', value: 'None' }, { label: 'Controllers', value: 'Xbox gamepad, UI is cursor-driven' }, ]} diff --git a/docs/emulation/dolphin-guide.mdx b/docs/emulation/dolphin-guide.mdx index 389b999..a8ffd8b 100644 --- a/docs/emulation/dolphin-guide.mdx +++ b/docs/emulation/dolphin-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 title: Dolphin UWP Guide description: Comprehensive guide for setting up and using Dolphin UWP on Xbox tags: @@ -8,6 +8,7 @@ tags: - gamecube - wii - uwp +slug: dolphin-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -24,7 +25,7 @@ This guide provides comprehensive instructions for setting up and using Dolphin { label: 'Dev Mode', value: 'Required (Retail not supported)' }, { label: 'Storage', value: 'USB NTFS recommended, internal storage limited and risky to clean' }, { label: 'User folder', value: 'USB:\\Dolphin (preferred) or LocalFolder\\[FULLNAME]\\LocalCache\\Dolphin' }, - { label: 'Difficulty', value: 'Intermediate - about 20–30 minutes (USB method)' }, + { label: 'Difficulty', value: 'Intermediate - about 20-30 minutes (USB method)' }, { label: 'BIOS/keys', value: 'None required, optional Wii NAND for menu' }, { label: 'Controllers', value: 'Xbox gamepad, custom mappings best synced from PC' }, ]} diff --git a/docs/emulation/flycast-guide.mdx b/docs/emulation/flycast-guide.mdx index cf5ac94..68692fa 100644 --- a/docs/emulation/flycast-guide.mdx +++ b/docs/emulation/flycast-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 8 +sidebar_position: 4 title: Flycast Guide description: Complete guide for setting up and using Flycast Dreamcast/NAOMI emulator on Xbox tags: @@ -8,6 +8,7 @@ tags: - dreamcast - naomi - uwp +slug: flycast-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -22,7 +23,7 @@ import AtAGlance from '@site/src/components/AtAGlance'; { label: 'Dev Mode', value: 'Required (Retail not supported)' }, { label: 'Storage', value: 'USB NTFS recommended for ROMs/BIOS, textures must be internal' }, { label: 'User folder', value: 'LocalAppData\\Flycast\\LocalState (Data\\textures for packs)' }, - { label: 'Difficulty', value: 'Intermediate - about 15–20 minutes' }, + { label: 'Difficulty', value: 'Intermediate - about 15-20 minutes' }, { label: 'BIOS/keys', value: 'dc_boot optional but recommended for compatibility' }, { label: 'Controllers', value: 'Xbox gamepad, set app type to Game' }, ]} diff --git a/docs/emulation/index.mdx b/docs/emulation/index.mdx index aae74e8..1cfc4cd 100644 --- a/docs/emulation/index.mdx +++ b/docs/emulation/index.mdx @@ -1,29 +1,43 @@ --- title: Emulation Guides +sidebar_position: 1 description: Overview of Xbox Developer Mode emulation guides with setup prerequisites. -slug: /emulation tags: - emulation - xbox - dev-mode +slug: /emulation --- # Emulation Guides Welcome to the comprehensive emulation guides for Xbox Developer Mode! This section contains detailed guides for setting up and configuring various emulators to run classic games on your Xbox console. -## Available Emulators +## Available emulators - **[XBSX2 (PS2)](/docs/emulation/xbsx2-guide)** - PlayStation 2 emulator with excellent compatibility - **[Dolphin (GC/Wii)](/docs/emulation/dolphin-guide)** - GameCube and Wii emulator - **[PPSSPP (PSP)](/docs/emulation/ppsspp-guide)** - PlayStation Portable emulator - **[RetroArch](/docs/emulation/retroarch-guide)** - Multi-system emulator with many cores - **[Flycast](/docs/emulation/flycast-guide)** - Dreamcast and Naomi emulator -- **[TouchHLE](/docs/emulation/touchhle-guide)** - iOS emulator for classic iPhone/iPad apps -- **[ChonkyStation3](/docs/emulation/chonkystation3-guide)** - PlayStation 3 emulator (experimental) -- **[Panda3DS](/docs/emulation/panda3ds-guide)** - Nintendo 3DS emulator +- **[BoxedWine (Wine on Xbox)](/docs/emulation/boxedwine-guide)** - running some Windows `.exe` payloads under a Wine-based UWP host + +## Experimental console emulators + +These builds are unfinished or unstable. Full walkthroughs are under **Experimental UWP (community)** in the sidebar. + +- **[ChonkyStation3 (PS3)](/docs/experimental/chonkystation3-guide)** - proof-of-concept PS3 UWP emulator +- **[Panda3DS (3DS)](/docs/experimental/panda3ds-guide)** - 3DS UWP emulator (early) +- **[TouchHLE](/docs/experimental/touchhle-guide)** - early iOS app compatibility layer / emulator + +## Arcade & specialty setups + +- **[Sega Model 3 (Supermodel)](/docs/emulation/segamodel3-guide)** - Model 3 arcade +- **[Sega Model 3 (G920-focused)](/docs/emulation/segamodel3-g920-guide)** - Supermodel with steering-wheel notes + +GZDoom, Raze, OpenBOR, Sonic fan ports, and other native ports and source engines live under **Native ports & engines (community)** in the sidebar. That list is long, so use your browser or the site search when you need a specific title. -## Getting Started +## Getting started Before setting up any emulator, make sure you have: @@ -33,6 +47,6 @@ Before setting up any emulator, make sure you have: Each guide contains detailed installation instructions, configuration steps, and troubleshooting tips. -## Need Help? +## Need help? If you encounter issues, check the [FAQ](/docs/faq) or [report issues](https://github.com/SternXD/devmodewiki/issues) on GitHub. diff --git a/docs/emulation/ppsspp-guide.mdx b/docs/emulation/ppsspp-guide.mdx index c3f5f08..23594b8 100644 --- a/docs/emulation/ppsspp-guide.mdx +++ b/docs/emulation/ppsspp-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 4 +sidebar_position: 5 title: PPSSPP Setup Guide description: Complete guide for setting up PPSSPP PSP emulator on Xbox for both external USB and internal storage tags: @@ -8,6 +8,7 @@ tags: - ppsspp - uwp - xbox +slug: ppsspp-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -26,7 +27,7 @@ If you have not prepared your USB for emulators yet (NTFS format and correct per { label: 'Dev Mode', value: 'Required (Retail not supported)' }, { label: 'Storage', value: 'USB NTFS recommended, internal LocalState works but slower' }, { label: 'User folder', value: 'USB:\\PSP (Create or Choose a PSP folder) or LocalAppData\\PPSSPP\\LocalState\\PSP' }, - { label: 'Difficulty', value: 'Easy - about 10–15 minutes' }, + { label: 'Difficulty', value: 'Easy - about 10-15 minutes' }, { label: 'BIOS/keys', value: 'None needed, use PSP ISOs/CSOs/CHDs' }, { label: 'Controllers', value: 'Xbox gamepad, remap in-app' }, ]} diff --git a/docs/emulation/retroarch-guide.mdx b/docs/emulation/retroarch-guide.mdx index c6b6880..bb98f83 100644 --- a/docs/emulation/retroarch-guide.mdx +++ b/docs/emulation/retroarch-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 5 +sidebar_position: 6 title: RetroArch Setup Guide (Mesa/Angle for Xbox) description: Complete guide for installing and setting up RetroArch on Xbox Developer Mode tags: @@ -7,6 +7,7 @@ tags: - retroarch - uwp - xbox +slug: retroarch-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -23,7 +24,7 @@ This guide provides instructions for installing and setting up RetroArch (Mesa f { label: 'Dev Mode', value: 'Required (Retail not supported)' }, { label: 'Storage', value: 'USB NTFS recommended, internal LocalState/D: works for all-local setups' }, { label: 'User folders', value: 'Set via Settings > Directory, BIOS in LocalState\\system' }, - { label: 'Difficulty', value: 'Intermediate - 20–30 minutes initial setup' }, + { label: 'Difficulty', value: 'Intermediate - 20-30 minutes initial setup' }, { label: 'BIOS/keys', value: 'Per-core BIOS in system directory as needed' }, { label: 'Controllers', value: 'Xbox gamepad, set App type to Game for best performance' }, ]} diff --git a/docs/emulation/segamodel3-g920-guide.mdx b/docs/emulation/segamodel3-g920-guide.mdx new file mode 100644 index 0000000..59090ad --- /dev/null +++ b/docs/emulation/segamodel3-g920-guide.mdx @@ -0,0 +1,43 @@ +--- +title: "Sega Model 3 G920 Guide" +sidebar_position: 7 +description: "A guide for setting up Sega Model 3 G920 on dev mode." +tags: + - guides + - emulation + - xbox +slug: segamodel3-g920-guide +--- + + +### Requirements: +- Xbox Series X/S. +- External USB. +- Logitech G920. +- `Microsoft.VCLibs.x64.14.00.appx` dependency file. + +### Prepare Game Files +1. Create a folder named `Sega Model 3` on your USB drive under the `Games` directory. +2. Place your games in this folder. Ensure the files are in **ZIP format**. +3. Connect the USB drive to your Xbox. + +### Launch the Emulator +1. Disconnect your Xbox controller now or wheel inputs will not work. +2. Open the emulator using your Logitech G920. +3. A file explorer will appear. Navigate to your `Games` folder, then `Sega Model 3`, and select a game to play. + +### Enable Widescreen & Customize Controls +1. Access the **Xbox Device Portal** again. +2. Go to **File Explorer** > **Development Files** > **Windows Apps**. +3. Find the `Sega Model 3` folder, open the `Config` folder, and download the `Supermodel.ini` file. +4. Open the `.ini` file in **Notepad**: + - To enable widescreen: + Find `Widescreen = false`, change it to `true`. + - To customize controls: + Edit the **Xbox Controller ↔ Supermodel Input ID-Tags** in the file. +5. Save the file, then upload it back to the **Config** folder via the Xbox Device Portal, replacing the original file. + +### Additional Notes: +- Use the `.ini` file to further customize settings like graphics, controls, and more. +- If you encounter issues, revisit the portal to make adjustments. +- This build is compatible with the Logitech G920 and is configured for racing games only. diff --git a/docs/emulation/segamodel3-guide.mdx b/docs/emulation/segamodel3-guide.mdx new file mode 100644 index 0000000..4bcef89 --- /dev/null +++ b/docs/emulation/segamodel3-guide.mdx @@ -0,0 +1,40 @@ +--- +title: "Sega Model 3 Guide" +sidebar_position: 8 +description: "A guide for setting up Sega Model 3 on dev mode." +tags: + - guides + - emulation + - xbox +slug: segamodel3-guide +--- + + +### Requirements: +- Xbox Series X/S. +- External USB. +- `Microsoft.VCLibs.x64.14.00.appx` dependency file. + +### Prepare Game Files +1. Create a folder named `Sega Model 3` on your USB drive under the `Games` directory. +2. Place your games in this folder. Ensure the files are in **ZIP format**. +3. Connect the USB drive to your Xbox. + +### Launch the Emulator +1. Open the emulator. +2. A file explorer will appear. Navigate to your `Games` folder, then `Sega Model 3`, and select a game to play. + +### Enable Widescreen & Customize Controls +1. Access the **Xbox Device Portal** again. +2. Go to **File Explorer** > **Development Files** > **Windows Apps**. +3. Find the `Sega Model 3` folder, open the `Config` folder, and download the `Supermodel.ini` file. +4. Open the `.ini` file in **Notepad**: + - To enable widescreen: + Find `Widescreen = false`, change it to `true`. + - To customize controls: + Edit the **Xbox Controller ↔ Supermodel Input ID-Tags** in the file. +5. Save the file, then upload it back to the **Config** folder via the Xbox Device Portal, replacing the original file. + +### Additional Notes: +- Use the `.ini` file to further customize settings like graphics, controls, and more. +- If you encounter issues, revisit the portal to make adjustments. diff --git a/docs/emulation/xbsx2-guide.mdx b/docs/emulation/xbsx2-guide.mdx index 270fc65..e7c37f1 100644 --- a/docs/emulation/xbsx2-guide.mdx +++ b/docs/emulation/xbsx2-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 7 +sidebar_position: 9 title: XBSX2 PS2 Emulator Setup Guide description: Complete guide for installing and setting up XBSX2 PS2 emulator on Xbox Series X/S tags: @@ -9,6 +9,7 @@ tags: - pcsx2 - uwp - xbox +slug: xbsx2-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -32,7 +33,7 @@ XBSX2 is an emulator that allows you to play PlayStation 2 (PS2) games on your X { label: 'Dev Mode', value: 'Required (Retail not supported)' }, { label: 'Storage', value: 'USB NTFS recommended, internal LocalState/D: works but limited' }, { label: 'User folder', value: 'Store BIOS/games on USB, LocalState/D: usable if needed' }, - { label: 'Difficulty', value: 'Intermediate - about 20–30 minutes' }, + { label: 'Difficulty', value: 'Intermediate - about 20-30 minutes' }, { label: 'BIOS/keys', value: 'PS2 BIOS required to boot games' }, { label: 'Controllers', value: 'Xbox gamepad, supports custom mappings' }, ]} diff --git a/docs/emulation/chonkystation3-guide.mdx b/docs/experimental/chonkystation3-guide.mdx similarity index 99% rename from docs/emulation/chonkystation3-guide.mdx rename to docs/experimental/chonkystation3-guide.mdx index ae0e81c..d1f225e 100644 --- a/docs/emulation/chonkystation3-guide.mdx +++ b/docs/experimental/chonkystation3-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 2 title: ChonkyStation 3 UWP (Proof of Concept) Guide description: Complete guide for installing and running ChonkyStation 3 UWP PS3 emulator on Xbox tags: @@ -8,6 +8,7 @@ tags: - chonkystation3 - uwp - experimental +slug: chonkystation3-guide --- import AtAGlance from '@site/src/components/AtAGlance'; diff --git a/docs/experimental/hedgephysics-guide.mdx b/docs/experimental/hedgephysics-guide.mdx new file mode 100644 index 0000000..37ccae3 --- /dev/null +++ b/docs/experimental/hedgephysics-guide.mdx @@ -0,0 +1,32 @@ +--- +title: "Hedge Physics Guide" +sidebar_position: 3 +description: "A guide for setting up Hedge Physics on dev mode." +tags: + - guides + - experimental + - xbox +slug: hedgephysics-guide +--- + + +### Install Hedge Physics: +1. Extract the attached `HedgePhysics 1.2.3.0.zip` file. +2. Install the `HedgePhysics_1.2.3.0_x64.appxbundle` via the dev portal. + - Include the 2 dependencies. +3. Launch **HedgePhysics**, and you're ready to play! + +### Controls +- **Left Stick**: Movement +- **A**: Jump +- **B**: Spin Dash +- **Start/Menu**: Pause + +### Additional Notes +- **A** (Jump) is temperamental; input may not always register. +- This is a development build, not a complete game. + +--- + +*Contributor: MewLew* + diff --git a/docs/experimental/index.mdx b/docs/experimental/index.mdx new file mode 100644 index 0000000..49ab9bc --- /dev/null +++ b/docs/experimental/index.mdx @@ -0,0 +1,24 @@ +--- +title: Experimental Ports +description: Unfinished or unstable UWP builds (PS3 / 3DS emulators and other experimental packaged apps on Xbox Developer Mode). +sidebar_position: 1 +tags: + - experimental + - uwp + - community +slug: /experimental +--- + +# Experimental Ports + +Guides here cover **early, proof-of-concept, or inconsistently maintained** packaged apps. Expect crashes, missing features, and updates that break older installs. Prefer the **[Emulation guides](/docs/emulation)** section for Dolphin, RetroArch, XBSX2, and other more mature setups. + +## In this section + +- **[ChonkyStation 3](/docs/experimental/chonkystation3-guide)** - PS3 UWP POC +- **[Panda3DS](/docs/experimental/panda3ds-guide)** - 3DS UWP (early) +- **[Hedgephysics](/docs/experimental/hedgephysics-guide)** - experimental build notes +- **[SM64 HD](/docs/experimental/sm64hd-guide)** - experimental build notes +- **[TouchHLE](/docs/experimental/touchhle-guide)** - early iOS app compatibility on Xbox / UWP + +If something here stops working after a wiki or packaging update, check the **[FAQ](/docs/faq)** or open an **[issue](https://github.com/SternXD/devmodewiki/issues)**. diff --git a/docs/emulation/panda3ds-guide.mdx b/docs/experimental/panda3ds-guide.mdx similarity index 98% rename from docs/emulation/panda3ds-guide.mdx rename to docs/experimental/panda3ds-guide.mdx index d006766..1f8d48b 100644 --- a/docs/emulation/panda3ds-guide.mdx +++ b/docs/experimental/panda3ds-guide.mdx @@ -1,13 +1,14 @@ --- -sidebar_position: 3 +sidebar_position: 4 title: Panda3DS UWP Setup Guide description: Complete guide for installing and setting up Panda3DS Nintendo 3DS emulator on Xbox tags: - - emulation + - experimental - 3ds - panda3ds - uwp - xbox +slug: panda3ds-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -24,7 +25,7 @@ This guide provides instructions for installing and setting up Panda3DS, a Ninte { label: 'Dev Mode', value: 'Required (Retail not supported)' }, { label: 'Storage', value: 'USB NTFS recommended, LocalState works' }, { label: 'User folder', value: 'USB root or E:\\Panda3DS, LocalState or LocalState\\Panda3DS' }, - { label: 'Difficulty', value: 'Easy - about 10–15 minutes' }, + { label: 'Difficulty', value: 'Easy - about 10-15 minutes' }, { label: 'BIOS/keys', value: 'Decrypted 3DS/CIA files required, no BIOS needed' }, { label: 'Controllers', value: 'Xbox gamepad' }, ]} diff --git a/docs/experimental/sm64hd-guide.mdx b/docs/experimental/sm64hd-guide.mdx new file mode 100644 index 0000000..36d87d3 --- /dev/null +++ b/docs/experimental/sm64hd-guide.mdx @@ -0,0 +1,35 @@ +--- +title: "SM64HD Fan Remake (Super Mario 64) Guide" +sidebar_position: 5 +description: "A guide for setting up SM64HD Fan Remake (Super Mario 64) on dev mode." +tags: + - guides + - experimental + - xbox +slug: sm64hd-guide +--- + + +> This project was a continuation of the Super Mario 64 HD Remake developed in the Unity Engine. However, it has been archived due to years of inactivity and the advancements of the SM64 Decompilation Project. If you're interested in reviving or building upon it, feel free to fork the repository. + +### Install SM64HD Remake: +1. Install the `SuperMario64HD_1.0.1.0_x64_Master.appx` via the dev portal. + - Include the `Microsoft.VCLibs.x64.14.00.appx` dependancy. +2. Launch **SuperMario64HD**, and you're ready to play! + +### Controls +- **Left Stick (Up/Down/Left/Right)**: Movement +- **A**: Jump +- **X**: Strike +- **RB**: Crouch +- **Start**: Pause +- **Right Stick (Up/Down/Left/Right)**: Camera controls (Move In/Out/Left/Right) + +### Additional Notes +- This project includes only one level, as it was discontinued years ago. We hope this inspires someone to port the full SM64 decompilation in the future. +- **Right Stick Left/Right** is inverted, and there is no option to change this. + +--- + +*Contributor: MewLew* + diff --git a/docs/emulation/touchhle-guide.mdx b/docs/experimental/touchhle-guide.mdx similarity index 99% rename from docs/emulation/touchhle-guide.mdx rename to docs/experimental/touchhle-guide.mdx index c327f9c..c0294bf 100644 --- a/docs/emulation/touchhle-guide.mdx +++ b/docs/experimental/touchhle-guide.mdx @@ -9,6 +9,7 @@ tags: - uwp - xbox updated: 12/11/2025 +slug: touchhle-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -25,7 +26,7 @@ This guide provides instructions for installing and setting up TouchHLE, an emul { label: 'Dev Mode', value: 'Required (Retail not supported)' }, { label: 'Storage', value: 'External NTFS USB required (root holds assets and app.ipa)' }, { label: 'User folder', value: 'USB root with touchHLE_dylibs, touchHLE_fonts, iOS folder' }, - { label: 'Difficulty', value: 'Intermediate - about 20–30 minutes' }, + { label: 'Difficulty', value: 'Intermediate - about 20-30 minutes' }, { label: 'BIOS/keys', value: 'No BIOS, requires decrypted IPA renamed to app.ipa' }, { label: 'Controllers', value: 'Xbox gamepad emulates touch/tilt' }, ]} diff --git a/docs/faq.mdx b/docs/faq.mdx index 19b6ceb..877a58f 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -2,6 +2,7 @@ title: Frequently Asked Questions description: A section on the most frequently asked questions for Dev Mode Wiki. sidebar_position: 2 +slug: faq --- # FAQ diff --git a/docs/frontends/index.mdx b/docs/frontends/index.mdx new file mode 100644 index 0000000..9f1f741 --- /dev/null +++ b/docs/frontends/index.mdx @@ -0,0 +1,18 @@ +--- +title: Frontends +description: Launcher frontends that organize ROMs and hand off to emulators on Xbox Developer Mode; not emulators themselves. +sidebar_position: 1 +tags: + - frontends + - launchers + - uwp +slug: /frontends +--- + +# Frontends + +These guides cover **launcher-style UWP apps** that organize libraries and open games in underlying emulators. Install and emulator setup guides stay under **[Emulation guides](/docs/emulation)**; individual game/engine ports are under **[Native ports & engines (community)](/docs/ports)**. + +## Guides + +- **[LaunchPass](/docs/frontends/launchpass-guide)** - LaunchBox-based frontend for wiring multiple emulators on Xbox diff --git a/docs/apps/launchpass-guide.mdx b/docs/frontends/launchpass-guide.mdx similarity index 98% rename from docs/apps/launchpass-guide.mdx rename to docs/frontends/launchpass-guide.mdx index 412b6c1..9290850 100644 --- a/docs/apps/launchpass-guide.mdx +++ b/docs/frontends/launchpass-guide.mdx @@ -1,13 +1,13 @@ --- -sidebar_position: 3 +sidebar_position: 2 title: LaunchPass Setup Guide description: Complete guide for installing and setting up LaunchPass emulator frontend on Xbox tags: - - apps + - frontends - launchpass - - frontend - uwp - xbox +slug: launchpass-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -24,7 +24,7 @@ LaunchPass is a Frontend that is capable of launching ROMs in most Emulators on { 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' }, ]} diff --git a/docs/helpful-links/index.mdx b/docs/helpful-links/index.mdx index f6d669b..b004c07 100644 --- a/docs/helpful-links/index.mdx +++ b/docs/helpful-links/index.mdx @@ -1,14 +1,22 @@ +--- +title: Helpful Links +sidebar_position: 1 +description: Supporting resources for Xbox Developer Mode UWP development and emulation on console. +slug: /helpful-links +--- + # Helpful Links This section contains useful resources and links for Xbox development and UWP porting. -## Development Resources +## Development resources -- **[Xbox UWP Development](./xbox-uwp-development)** - Guide for developing UWP applications -- **[Visual Studio 2022 Setup](./visual-studio-2022-setup)** - Configure your development environment -- **[WorleyDLS UWP Porting Notes](./worleydls-uwp-porting-notes)** - Notes on porting applications to UWP +- **[Xbox UWP Development](/docs/helpful-links/xbox-uwp-development)** - Guide for developing UWP applications +- **[Visual Studio 2022 Setup](/docs/helpful-links/visual-studio-2022-setup)** - Configure your development environment (2022 channel) +- **[Visual Studio 2026 Setup](/docs/helpful-links/visual-studio-2026-setup)** - Newer toolchain notes where applicable +- **[WorleyDLS UWP Porting Notes](/docs/helpful-links/worleydls-uwp-porting-notes)** - Notes on porting applications to UWP -## External Resources +## External resources These guides contain valuable information for Xbox development, including setup instructions and technical notes that can help with various development tasks. diff --git a/docs/helpful-links/visual-studio-2022-setup.mdx b/docs/helpful-links/visual-studio-2022-setup.mdx index 7728599..b905049 100644 --- a/docs/helpful-links/visual-studio-2022-setup.mdx +++ b/docs/helpful-links/visual-studio-2022-setup.mdx @@ -2,6 +2,7 @@ sidebar_position: 2 title: Installing Visual Studio 2022 Community for UWP Development (Xbox) - Stern description: Complete guide for installing and configuring Visual Studio 2022 Community for Xbox UWP development +slug: visual-studio-2022-setup --- # Installing Visual Studio 2022 Community for UWP Development (Xbox) - Stern diff --git a/docs/helpful-links/visual-studio-2026-setup.mdx b/docs/helpful-links/visual-studio-2026-setup.mdx index 649a54b..35fbe1e 100644 --- a/docs/helpful-links/visual-studio-2026-setup.mdx +++ b/docs/helpful-links/visual-studio-2026-setup.mdx @@ -2,6 +2,7 @@ sidebar_position: 3 title: Installing Visual Studio 2026 Community for UWP Development (Xbox) - Stern description: Complete guide for installing and configuring Visual Studio 2026 Community for Xbox UWP development +slug: visual-studio-2026-setup --- # Installing Visual Studio 2026 Community for UWP Development (Xbox) - Stern diff --git a/docs/helpful-links/worleydls-uwp-porting-notes.mdx b/docs/helpful-links/worleydls-uwp-porting-notes.mdx index c0b96f8..a6683b9 100644 --- a/docs/helpful-links/worleydls-uwp-porting-notes.mdx +++ b/docs/helpful-links/worleydls-uwp-porting-notes.mdx @@ -1,7 +1,8 @@ --- -sidebar_position: 3 +sidebar_position: 4 title: UWP Development Notes and Tips (Xbox) - worleydl description: Comprehensive guide for porting and developing UWP applications for Xbox +slug: worleydls-uwp-porting-notes --- # UWP Development Notes and Tips (Xbox) - [worleydl](https://github.com/worleydl) diff --git a/docs/helpful-links/xbox-uwp-development.mdx b/docs/helpful-links/xbox-uwp-development.mdx index 15053b8..d6b5a67 100644 --- a/docs/helpful-links/xbox-uwp-development.mdx +++ b/docs/helpful-links/xbox-uwp-development.mdx @@ -1,7 +1,8 @@ --- -sidebar_position: 1 +sidebar_position: 5 title: Helpful Links for Xbox UWP Development description: Curated collection of resources for Xbox Universal Windows Platform development +slug: xbox-uwp-development --- # Helpful Links for Xbox UWP Development diff --git a/docs/intro.mdx b/docs/intro.mdx index 65251b6..8829f60 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -1,5 +1,6 @@ --- sidebar_position: 1 +slug: intro --- # Dev Mode Wiki diff --git a/docs/ports/castlevania-guide.mdx b/docs/ports/castlevania-guide.mdx new file mode 100644 index 0000000..f7bbd79 --- /dev/null +++ b/docs/ports/castlevania-guide.mdx @@ -0,0 +1,34 @@ +--- +title: "Castlevania Revamped Guide" +sidebar_position: 2 +description: "A guide for setting up Castlevania Revamped on dev mode." +tags: + - guides + - ports + - xbox +slug: castlevania-guide +--- + + +### Install the Castlevania Revamped App +- Unzip the `CVR.zip` file. +- Install the `CVR_1.0.0.0_x64_Debug.msixbundle` via the dev portal. + - Install all 5 included dependencies. + +### Launch Castlevania Revamped +1. Close the initial pop-up titled **CVR Data Install** to begin downloading the game files - **Do not exit the app**. +2. Move the cursor and select **OK** to close the **sae.nanodata.cloud says** pop-up. +3. Once the download completes, the game will launch automatically. +4. You will need to repeat this process every time you launch the game. + +### Additional Notes +- If an exception error occurs: + - Press the **Start** button and select **Refresh**. +- Use the **Left Stick** to move the cursor to the edge of the screen to hide it. +- Remap the **Secondary Weapon** button to something other than **B**, as **B** also brings up the pause menu +- Keyboard input is supported. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/celeste-guide.mdx b/docs/ports/celeste-guide.mdx new file mode 100644 index 0000000..9b64265 --- /dev/null +++ b/docs/ports/celeste-guide.mdx @@ -0,0 +1,32 @@ +--- +title: "Celeste Classic Guide" +sidebar_position: 3 +description: "A guide for setting up Celeste Classic on dev mode." +tags: + - guides + - ports + - xbox +slug: celeste-guide +--- + + +### Install CelesteClassic-UWP: +1. Install the `CelesteClassic-UWP_1.0.2.0_x64.msixbundle` via the dev portal. + - Include the `Microsoft.VCLibs.x64.14.00.appx` dependancy. +2. Launch **CelesteClassic-UWP**, and you're ready to play! + +### Controls +- **LB**: Save State +- **RB**: Load State +- **Left Stick**: Movement +- **A**: Jump +- **B**: Dash +- **Start/Menu**: Pause + +**Additional notes:** +- The window will always display with borders. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/celeste64-guide.mdx b/docs/ports/celeste64-guide.mdx new file mode 100644 index 0000000..3231bc7 --- /dev/null +++ b/docs/ports/celeste64-guide.mdx @@ -0,0 +1,27 @@ +--- +title: "Celeste 64 Guide" +sidebar_position: 4 +description: "A guide for setting up Celeste 64 on dev mode." +tags: + - guides + - ports + - xbox +slug: celeste64-guide +--- + + +### Prepare the Game Files +- Create a `celeste64` folder on your external drive (`E:\celeste64`). +- Go to the [Celeste64-uwp GitHub repository](https://github.com/worleydl/Celeste64-uwp). +- Click on **Code** and select **Download ZIP**. +- Unzip the downloaded `Celeste64-uwp-uwp-compat.zip` file. +- Copy the entire `Content` folder from the extracted `Celeste64-uwp-uwp-compat` folder to your `E:\celeste64` folder. + +### Install the Celeste 64 App +- Install the `celeste64_uwp` MSIX package via the dev portal. + - Make sure to include the dependency file `Microsoft.VCLibs.x64.14.00.appx`. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/chronodivide-guide.mdx b/docs/ports/chronodivide-guide.mdx new file mode 100644 index 0000000..cc7bd84 --- /dev/null +++ b/docs/ports/chronodivide-guide.mdx @@ -0,0 +1,40 @@ +--- +title: "Red Alert 2: Chrono Divide Guide" +sidebar_position: 5 +description: "A guide for setting up Chrono Divide on dev mode." +tags: + - guides + - ports + - xbox +slug: chronodivide-guide +--- + + +### Install the Chrono Divide App +- Unzip the `ChronoDivide.zip` file. +- Install the `STORE_1.0.12.0_x64_Debug.msixbundle` via the dev portal. + - Install all 5 included dependencies. + +### Launch Chrono Divide +1. Close the first pop-up titled **Chrono Dive Data**. +2. Select **Yes** when prompted to download `EBWebView1.zip`. +3. Wait for the download to complete. +4. After the download finishes, there will be a short delay. Avoid pressing anything during this time. +5. Close the **Download Completed Chrono Dive Data** pop-up. +6. Open the **Dev Portal** and navigate to: + `LocalAppData/STORE/LocalState`. + - Delete the `EBWebView` folder. + - Rename the `EBWebView1` folder to `EBWebView` by removing the `1`. + - If the `EBWebView1.zip` file is still in the `LocalState` folder, you can delete it. +7. Restart **Chrono Divide** to apply the changes. + +### Additional Notes +- This app is a web wrapper, so mods are not supported. +- Enable fullscreen either from the title screen or in the in-game options. +- If the cursor becomes desynced, move the right stick to resync it. +- Keyboard input is supported. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/darkplaces-guide.mdx b/docs/ports/darkplaces-guide.mdx new file mode 100644 index 0000000..6ced4ae --- /dev/null +++ b/docs/ports/darkplaces-guide.mdx @@ -0,0 +1,65 @@ +--- +title: "Darkplaces (Quake) UWP Edition Guide" +sidebar_position: 6 +description: "A guide for setting up Darkplaces (Quake) UWP Edition on dev mode." +tags: + - guides + - ports + - xbox +slug: darkplaces-guide +--- + + +### Requirements +- **Xbox Series S/X**. +- **External Drive** - Required to store your game file and other data. +- **Game (`id1`) file** - You must own a copy of Quake or Quake enhanced to obtain the required data files. + +## Obtaining the `id1` Folder +1. Open your Quake game directory. +2. Locate the `id1` folder. +3. Ensure the folder contains `pak0.pak` and `pak1.pak` files. +4. If a `config.cfg` file is present, delete it. + +### Notes for Enhanced Release Users + +- **Important**: Avoid using the `pak0.pak` file found in the `id1` folder within the `rerelease` directory of the enhanced Quake installation. +- Instead, navigate to the root of the Quake enhanced directory. +- Locate the `id1` folder in the root directory. +- Use the `PAK0.PAK` and `PAK1.PAK` files from this folder for compatibility. + +## Preparing an External Drive +1. Create a folder named `quake` (use lowercase for compatibility). +2. Place the `id1` folder into the `quake` folder. + +## Enabling Mods and Adding `zlib1.dll` + +### Step 1: Add `zlib1.dll` +1. Obtain the `zlib1.dll` file from the attached `.zip` file. +2. Open the **Dev Portal** on your PC. +3. Navigate to: + `DevelopmentFiles > WindowsApps > darkplaces_1.0.1.0_x64__vfvyvkbgajpwg` using the **File Explorer**. +4. Upload the `zlib1.dll` file into this directory. + +### Step 2: Add Mods +- Place any mod files directly into the `id1` folder within your `quake` directory on your external drive. + +### Controls +- A premade configuration is included in the attached `.zip` file with the following controls: + - **Left Stick**: Movement + - **Right Stick**: Camera movement + - **RT**: Shoot + - **A**: Jump + - **LB/RB**: Switch weapons +- Simply copy the `config.cfg` to your `id1` folder. + +### Additional Notes +- Two builds are provided: + - **`darkplaces_1.0.0.0_x64.msixbundle`**: Vsync enabled. + - **`darkplaces_novsync_1.0.1.0_x64.msixbundle`**: Vsync disabled. +- Music is not supported in either build. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/descent3-guide.mdx b/docs/ports/descent3-guide.mdx new file mode 100644 index 0000000..3533991 --- /dev/null +++ b/docs/ports/descent3-guide.mdx @@ -0,0 +1,43 @@ +--- +title: "Descent 3 Guide" +sidebar_position: 7 +description: "A guide for setting up Descent 3 on dev mode." +tags: + - guides + - ports + - xbox +slug: descent3-guide +--- + + +## Important Notes + +* **This open source distribution of Descent 3 DOES NOT CONTAIN GAME ASSETS.** Assets must be acquired separately from an official copy of the game, and copied as described in the next section. +* Functional but slightly chunky virtual mouse. +* Virtual keyboard only shows once per prompt; if you accidentally leave, you might get stuck. +* View Demo will crash the game. +* Multiplayer is hit or miss; if joining remotely to Xbox, you may need to specify IP (discovery seems broken). +* Analog trigger button binds. + +--- + +## Setup + +1. Make sure that you have a copy of Descent 3. You can purchase a copy of Descent 3 from [GOG](https://www.gog.com/game/descent_3_expansion) or [Steam](https://store.steampowered.com/app/273590/Descent_3/). +2. Install Descent 3. + > **Note for Steam users:** If you own Descent 3 on Steam, then it’s recommended that you install the Windows version of the game even if you’re running macOS or Linux, otherwise movies will not work due to [current lack of Ogv support](https://github.com/DescentDevelopers/Descent3/issues/240). You can use either [Steam Play](https://help.steampowered.com/en/faqs/view/08F7-5D56-9654-39AF) or [SteamCMD](https://developer.valvesoftware.com/wiki/SteamCMD#Cross-Platform_Installation) to install the Windows version of the game on macOS or Linux. +3. If your version of Descent 3 is older than v1.4, then [update it to v1.4](http://descent3.com/downloads.php). +4. Find the installation location of Descent 3. Using the Steam client, you can find it from the library page using the `Manage > Browse local files` context menu. +5. Create a new folder named `descent3` on your `E` drive. +6. Copy the following files from your installation of Descent 3 to `E:\descent3`: + * All `.hog` files + * The `missions` folder + * *(Optional)* All `.pld` files + * *(Optional)* The `movies` folder +7. Create the `custom/` folder in `E:\descent3`. +8. Setup your binds in the Joystick/Mouse tab of the controls menu. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/devilutionx-guide.mdx b/docs/ports/devilutionx-guide.mdx new file mode 100644 index 0000000..135e9c7 --- /dev/null +++ b/docs/ports/devilutionx-guide.mdx @@ -0,0 +1,51 @@ +--- +title: "DevilutionX Guide" +sidebar_position: 8 +description: "A guide for setting up DevilutionX on dev mode." +tags: + - guides + - ports + - xbox +slug: devilutionx-guide +--- + + +> **NOTE:** You'll need access to the data from the original game. If you don't have an original CD, you can buy Diablo from [**GoG.com**]() or Battle.net. Alternatively, you can use `spawn.mpq` from the [**shareware**]() [[**2**]]() version, in place of `DIABDAT.MPQ`, to play the shareware portion of the game. + +### Extracting Game Assets + +1. Navigate to your **Diablo Hellfire** installation directory. +2. Locate and copy the following files to your desktop: + - `Diabdat.mpq` + - `Hellfire.mpq` + - `Hfmonk.mpq` + - `Hfmusic.mpq` + - `Hfvoice.mpq` +3. Compress all the files into a single **ZIP** file. + +### Internal Setup + +1. Launch **DevilutionX** to initialize the required folders. + - The app will display a message stating that files are missing. + - Quit the app: + - Press the **Xbox button**, hover over **DevilutionX**, press **Start**, and choose **Quit**. + +2. Upload your **ZIP** file: + - Open the **Dev Portal**. + - Navigate to **File Explorer** > **Local App Data** > **DevilutionX**. + - Go to the **Local State** folder. + - Navigate to the following subdirectories: + - `diasurgical` > `devilution`. + - Click **Choose File**, locate your **ZIP** file, and click **Upload**. + +3. Launch **DevilutionX**, and you're ready to play. + +### Additional Notes +- In the same folder where you uploaded your game files, there is a configuration file named `diablo.ini`. + - You can edit this file with a text editor (e.g., Notepad) to customize controls or settings. + - Once modified, re-upload the file to the same directory. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/dhewm3-guide.mdx b/docs/ports/dhewm3-guide.mdx new file mode 100644 index 0000000..76b1ec4 --- /dev/null +++ b/docs/ports/dhewm3-guide.mdx @@ -0,0 +1,48 @@ +--- +title: "Dhewm 3 Guide" +sidebar_position: 9 +description: "A guide for setting up Dhewm 3 on dev mode." +tags: + - guides + - ports + - xbox +slug: dhewm3-guide +--- + + +### Requirements: +- **Xbox Series S/X**. +- **External Drive** - Required to store your game file and other data. +- **Dependency** - `Microsoft.VCLibs.x64.14.00.appx` +- **Game (`base`) file** - You must own a copy of Doom 3 to obtain the required data files. + +### Obtaining the `base` Folder +1. Open your Doom 3 game directory. +2. Locate the `base` folder. +3. Ensure the folder contains `pak.pk4` files numbered 0 through 8. + +**Important**: The **BFG Edition** data will not work; it must be the **original version**. + +### Preparing an External Drive +1. Create a folder named `d3` (use lowercase for compatibility). +2. Place the `base` folder into the `d3` folder. + +### Resurrection of Evil (ROE) Build Specifics + +For the **Resurrection of Evil** expansion build, in addition to the `base` game files from the original Doom 3, you'll also need the expansion's specific game data files (e.g., `pak000.pk4` from ROE). These files are typically located in a folder named `d3xp`. You must place this `d3xp` folder alongside the `base` folder within your main `d3` directory on the external drive. + +### Additional Notes +- Bind your controls on the first launch: + 1. Navigate to **Options** > **Controls**. + 2. Adjust bindings for **Movement**, **Weapons**, **Attack/Look**, and **Other** as needed. +- **Multiplayer** is functional. +- Using the in-game **Exit Game** option will cause the game to freeze. To quit the game: + 1. Press the **Xbox button**. + 2. Hover over **dhewm3-uwp**. + 3. Press **Start** and select **Quit**. +- **Modding** is not supported. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/doom3do-guide.mdx b/docs/ports/doom3do-guide.mdx new file mode 100644 index 0000000..2b2d23a --- /dev/null +++ b/docs/ports/doom3do-guide.mdx @@ -0,0 +1,42 @@ +--- +title: "BurgerDoom Guide" +sidebar_position: 10 +description: "A guide for setting up BurgerDoom on dev mode." +tags: + - guides + - ports + - xbox +slug: doom3do-guide +--- + +### Preparing Your Game File + +Navigated to your DOOM 3DO `.iso` file, you will need to convert it to the required `.img` format before proceeding with the setup. + +**How to convert your ISO to an IMG:** +For many of these source ports, the underlying disc data is the same, meaning you can often perform a simple file rename. +1. Ensure your operating system is set to show file extensions. +2. Right-click your file, select **Rename**, and change the extension from `.iso` to `.img` (making sure the final file is named exactly `Doom3DO.img`). +3. If renaming doesn't work or the port rejects the file, you can use a free disc image management tool (like ImgBurn for Windows or AnyToISO) to officially convert and extract the `.iso` into a raw `.img` format. + +--- + +### Requirements +* A valid `Doom3DO.img` file. + +### Setup Instructions +You have two options for giving the app the required image file: + +**Option 1: LocalState** +* Place `Doom3DO.img` directly into the app’s **LocalState** folder. + +**Option 2: USB Storage** +1. Copy `Doom3DO.img` to a USB drive. +2. Launch the app and use the built-in file picker to find and click the file. + +Once the image is selected, the game should start normally. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/dxxrebirth-guide.mdx b/docs/ports/dxxrebirth-guide.mdx new file mode 100644 index 0000000..a5c8431 --- /dev/null +++ b/docs/ports/dxxrebirth-guide.mdx @@ -0,0 +1,61 @@ +--- +title: "DXX Rebirth Guide" +sidebar_position: 11 +description: "A guide for setting up DXX Rebirth on dev mode." +tags: + - guides + - ports + - xbox +slug: dxxrebirth-guide +--- + + +### Requirements: +- **Xbox Series S/X**. +- **External Drive** - Required to store your game files and other data. +- **Dependency** - `Microsoft.VCLibs.x64.14.00.appx` +- **Game Assets** - You must own a copy of Decent to obtain the required data files. + +**Note**: If you don't have the original CD, you can purchase Decent from [GoG.com](). + +### Extracting Game Assets + +1. Navigate to your **Decent** installation directory. +2. Locate and copy the following files to your desktop: + - `descent.hog` + - `descent.pig` + +### External Drive Setup + +1. Create a folder named `decent1` (use lowercase for compatibility). +2. Place the `descent.hog` and `descent.pig` files into the `decent1` folder. + +### (Optional) Add Custom MIDI Sound Fonts +1. Launch **DXX Rebirth** once to initialize the `.ini` file. +2. Create a folder named `soundfonts` on your external drive. +3. Place your `.sf2` sound font file in this folder. +4. Rename the sound font file to `default.sf2`. +5. Open the `descent.cfg` file (located in the `descent1` folder) using a text editor like Notepad. +6. Update the following setting: + - `adl_midi_enabled = 1` → `adl_midi_enabled = 0`. +7. Save the file and reconnect the drive to your Xbox. + +### (Optional) Add Custom Soundtracks +1. Create a folder for your custom soundtrack on your external drive. (You can name this folder anything you like.) +2. Transfer your custom soundtrack to this folder. + - High-quality soundtracks from all the Descent releases can be downloaded [**here**](). +3. In **Descent Options** > **Sound & Music** > **Jukebox Options**, select and set the path to your custom soundtrack folder. +4. Change the **Music Type** setting from "Built-in/Add-on Music" to **Jukebox**. +5. For music to play in menus and non-level areas: + - Scroll down and add the path to specific custom tracks for **Main Menu**, **Briefing**, **Credits**, **Escape Sequence**, and **Game Ending** at the bottom of the **Sound & Music Options** menu. +6. Your custom tracks should now play in-game and in non-level areas. + +### Additional Notes +- Bind your controls on the first launch: + - Navigate to **Options** > **Controls** > **Customize Joystick**. +- Multiplayer is supported but requires port forwarding (`42424`) on the host's router for online play. + +--- + +*Contributor: MewLew* + diff --git a/docs/apps/gzdoom-guide.mdx b/docs/ports/gzdoom-guide.mdx similarity index 98% rename from docs/apps/gzdoom-guide.mdx rename to docs/ports/gzdoom-guide.mdx index 60b768d..da37dfc 100644 --- a/docs/apps/gzdoom-guide.mdx +++ b/docs/ports/gzdoom-guide.mdx @@ -1,13 +1,14 @@ --- -sidebar_position: 2 +sidebar_position: 12 title: GZDoom Setup and Modding Guide description: Complete guide for installing and setting up GZDoom Doom engine port on Xbox tags: - - apps + - ports - gzdoom - doom - uwp - xbox +slug: gzdoom-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -24,7 +25,7 @@ This guide explains how to set up GZDoom, a source port of the Doom engine, on a { label: 'Dev Mode', value: 'Required' }, { 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' }, ]} diff --git a/docs/ports/index.mdx b/docs/ports/index.mdx new file mode 100644 index 0000000..8007e75 --- /dev/null +++ b/docs/ports/index.mdx @@ -0,0 +1,18 @@ +--- +title: Native ports & engines +description: Guides for PC/console ports and source-engine builds on Xbox Developer Mode UWP. +sidebar_position: 1 +tags: + - ports + - community + - guides +slug: /ports +--- + +## Before you start + +Most ports expect **[Developer Mode](/docs/xbox-setup/xbox-developer-mode-setup)** and often **external NTFS USB** with **ALL APPLICATION PACKAGES** ACLs, the same groundwork as emulation guides. + +:::tip +The list below the fold in the sidebar is long. Scroll the sidebar, pin frequent guides, or use your browser Find on this page title when you reopen the wiki. +::: \ No newline at end of file diff --git a/docs/ports/inferno-guide.mdx b/docs/ports/inferno-guide.mdx new file mode 100644 index 0000000..584abbe --- /dev/null +++ b/docs/ports/inferno-guide.mdx @@ -0,0 +1,40 @@ +--- +title: "Inferno Guide" +sidebar_position: 13 +description: "A guide for setting up Inferno on dev mode." +tags: + - guides + - ports + - xbox +slug: inferno-guide +--- + + +This is a port of Inferno for UWP. + +--- + +## Setup + +1. Download and extract `external-assets.zip` to `E:\inferno` +2. Place `DESCENT.HOG` and `DESCENT.PIG` under `E:\inferno\d1` +3. Place `DESCENT2.HOG` under `E:\inferno\d2` *(This seems to be required, but note it is not currently playable.)* +4. For music, you can download addons from [DXX-Rebirth](https://www.dxx-rebirth.com/). Place the appropriate `.dxa` file under `E:\inferno\d1`. + > **Note:** An adlib music renderer has been included in the assets package. + +--- + +## Optional + +* Extract custom missions to `E:\inferno\d1\missions` + +--- + +## Notes + +> If running on a 4k display, reduce the render scale to eliminate microstutters in large areas. + +--- + +*Contributor: Worleydl* + diff --git a/docs/ports/ioquake3-guide.mdx b/docs/ports/ioquake3-guide.mdx new file mode 100644 index 0000000..227348a --- /dev/null +++ b/docs/ports/ioquake3-guide.mdx @@ -0,0 +1,48 @@ +--- +title: "ioquake3 Guide" +sidebar_position: 14 +description: "A guide for setting up ioquake3 on dev mode." +tags: + - guides + - ports + - xbox +slug: ioquake3-guide +--- + + +### Requirements +- **Xbox Series S/X**. +- **External Drive** - Required to store your game file and other data. +- **Dependency** - `Microsoft.VCLibs.x64.14.00.appx` +- **Game (`baseq3`) file** - You must own a copy of Quake 3 to obtain the required data files. + +### Obtaining the `baseq3` Folder +1. Open your Quake 3 game directory. +2. Locate the `baseq3` folder. +3. Ensure the folder contains `pak.pk3` files numbered 1 through 8. +4. If a `q3config.cfg` file is present, delete it. The UWP port will generate its own configuration file. + +### Preparing an External Drive +1. Create a folder named `q3a` (use lowercase for compatibility). +2. Place the `baseq3` folder into the `q3a` folder. + +**Modding:** +- Place any mods directly into the `baseq3` folder within your `q3a` directory. + +### Additional Notes +- On launch, press **B** to bypass the CD Key menu. +- Controls: + - **X** acts as the Enter key. + - **Select/View** button serves as the Backspace key. +- Bind your controls on the first launch: + 1. Navigate to **Setup** > **Controls**. + 2. Adjust bindings for **Look**, **Move**, **Shoot**, and **Misc** as needed. +- To bring up the virtual keyboard, press both thumbsticks simultaneously. +- Multiplayer is functional; enable downloads in the options if needed. +- Open the `q3config.cfg` file, generated in your `baseq3` folder after the first launch, using a text editor like Notepad. + - You can tweak stick sensitivity by adjusting the values for `j_yaw` (horizontal sensitivity) and `j_pitch` (vertical sensitivity) to suit your preferences. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/jazz2-guide.mdx b/docs/ports/jazz2-guide.mdx new file mode 100644 index 0000000..09ee3b0 --- /dev/null +++ b/docs/ports/jazz2-guide.mdx @@ -0,0 +1,65 @@ +--- +title: "Jazz² Resurrection Guide" +sidebar_position: 15 +description: "A guide for setting up Jazz² Resurrection on dev mode." +tags: + - guides + - ports + - xbox +slug: jazz2-guide +--- + + +### Requirements +- **Jazz Jackrabbit 2 game files**: You must own a copy of Jazz Jackrabbit 2 to use the required assets. + +### Obtaining the Game Assets + +The following versions of the original game can be used: +- Jazz Jackrabbit 2: Shareware Demo +- Jazz Jackrabbit 2 (v1.20/1.23) +- Jazz Jackrabbit 2: Holiday Hare '98 +- Jazz Jackrabbit 2: The Secret Files +- Jazz Jackrabbit 2: Christmas Chronicles + +If you don't own any of these versions, you can purchase the **Jazz Jackrabbit 2 Collection** from GOG. + +**Extracting Game Assets:** +- For original games: + Extract the `.bin` file using a tool like PowerISO. Locate the `Resource` folder within the extracted files. +- For the GOG version: + Open the game installation folder and use its contents. + +### External Drive Setup +1. On your external drive, if it doesn’t already exist, create a folder named `Games` (e.g., `E:\Games`). +2. In your `Games` folder, create a folder named `Jazz² Resurrection` (you can copy and paste the name for accuracy). +3. Inside the `Jazz² Resurrection` folder, create another folder named `Source` (e.g., `E:\Games\Jazz² Resurrection\Source`). +4. Transfer your assets: + - **For original games**: Copy the contents of the `Resource` folder into the `Source` folder. + - **For the GOG version**: Open the game installation folder and copy everything into the `Source` folder. +5. Launch **Jazz² Resurrection**, and you're ready to play! + +### Internal Drive Setup +1. Launch **Jazz² Resurrection** to initialize the folders, then quit the game: + - Press the **Xbox button**, hover over **Jazz² Resurrection**, press **Start**, and choose **Quit**. +2. Compress the game assets into a `.zip` file: + - **For original games**: Select the contents of the `Resource` folder and compress them into a `.zip` file. + - **For the GOG version**: Open the game installation folder, select everything, and compress it into a `.zip` file. +3. Upload the assets: + - Open the **Dev Portal**. + - Navigate to **File Explorer** > **Local App Data** > **Jazz² Resurrection**. + - Go to the **Local State** folder. + - Click **Create New Folder**, name the folder `Source`, and confirm with **OK**. + - Open the `Source` folder. + - Click **Choose File**, locate your `.zip` file, and **Upload**. + - When prompted, choose yes to **Extract ZIP Contents** into the directory. +4. Launch **Jazz² Resurrection**, and you're ready to play! + +### Additional Notes +- **Xbox One Build**: `Jazz2.msixbundle` +- **Xbox Series S/X Build**: `Jazz2_mesa.msixbundle` + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/jkdf2-guide.mdx b/docs/ports/jkdf2-guide.mdx new file mode 100644 index 0000000..5b70bc4 --- /dev/null +++ b/docs/ports/jkdf2-guide.mdx @@ -0,0 +1,59 @@ +--- +title: "Open JKDF2 Guide" +sidebar_position: 16 +description: "A guide for setting up Open JKDF2 on dev mode." +tags: + - guides + - ports + - xbox +slug: jkdf2-guide +--- + + +### Requirements +- **Xbox Series S/X**. +- **External Drive** - Required to store your game file and other data. +- **Dependency** - `Microsoft.VCLibs.x64.14.00.appx` +- **Game files** - Sourced from the **Jedi Knight Dark Forces 2** PC game. + +> **Known Issues:** +> - Palette is off in Credits screen +> - Mouse projection is not 1:1 +> - Joystick screen is displaying invalid binds + +### Obtaining the Game Files +You will need to obtain the **JKDF2** game, e.g. from Steam or GOG. + +In the root of the game files there are 5 folders: +- **Controls** +- **Episode** +- **Music** +- **Player** +- **Resource** + +### Prepare Your External Drive +1. Create a folder named `df2` in lowercase. +2. Copy your 5 game files folders to your `df2` folder. +(e.g., `E:\df2`) +3. Copy the attached `xbone.ctl` file to the `Controls` folder. + +**Modding:** +1. **Folder Setup**: + - Inside your `df2` folder, create the following subfolders in lowercase: + - `mods`: For game enhancements and modifications. + - `jkgm`: For custom texture files. +2. **Download and Configure Mods**: + - Download the desired mod. + - Follow the mod's instructions carefully to: + - Place the files in the correct folder (`mods` or `jkgm`) + - Adjust any necessary in-game or configuration settings as specified by the mod's documentation. + +### Initial Configuration Setup +1. On the first launch, go to: + **Setup** > **Controls** > **Options** > **Load Configuration**. +2. Select the **Xbone** configuration. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/maze-guide.mdx b/docs/ports/maze-guide.mdx new file mode 100644 index 0000000..036642d --- /dev/null +++ b/docs/ports/maze-guide.mdx @@ -0,0 +1,34 @@ +--- +title: "Maze0x72 Guide" +sidebar_position: 17 +description: "A guide for setting up Maze0x72 on dev mode." +tags: + - guides + - ports + - xbox +slug: maze-guide +--- + + +>The game is very simple, the idea is to find the key that opens the door by exploring the maze. It has 5 possible locations for key spawning, once you got the key, just go to the door to exit the maze. + +### Requirements +- Xbox Series S/X OR Xbox One + +### Install Maze0x72 +1. Install the Maze0x72 via the dev portal. +2. Launch Maze0x72, and you're ready to play! + +### Controls +- **D-PAD** Movement +- **A** to use Sword + +### Additional Notes +- No saves +- Can only quit the game by quitting the app +- I messed up adding the assets for the icon/splashscreen. I'll update that soon + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/mine-guide.mdx b/docs/ports/mine-guide.mdx new file mode 100644 index 0000000..3e29e1d --- /dev/null +++ b/docs/ports/mine-guide.mdx @@ -0,0 +1,32 @@ +--- +title: "Minesweeper 3D Guide" +sidebar_position: 18 +description: "A guide for setting up Minesweeper 3D on dev mode." +tags: + - guides + - ports + - xbox +slug: mine-guide +--- + + +### Requirements +- Xbox Series S/X OR Xbox One + +### Game Features +- Easy/Medium/Hard Modes +- Customize Your Game Mode +(Changing the amount of Rows, Columns and mines) + +## Install Mine Sweeper 3D +1. Install the Mine Sweeper 3D via the dev portal. +2. Launch Mine Sweeper 3D, and you're ready to play! + +### Controls +- **Cursor** Use the Left Stick to Navigate +- **A** to Select + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/nzp-guide.mdx b/docs/ports/nzp-guide.mdx new file mode 100644 index 0000000..e1f320a --- /dev/null +++ b/docs/ports/nzp-guide.mdx @@ -0,0 +1,63 @@ +--- +title: " Nazi Zombies: Portable Guide" +sidebar_position: 19 +description: "A guide for setting up Nazi Zombies: Portable on dev mode." +tags: + - guides + - ports + - xbox +slug: nzp-guide +--- + + +# Nazi Zombies: Portable UWP + +Xbox Dev Mode build of Nazi Zombies: Portable. + +## Install + +1. Open Xbox Device Portal. +2. Go to the app install page. +3. Upload the x64 `.msix` package. +4. Install any x64 dependency package shown with the build, if Device Portal asks for it. +5. Launch NZ:P from Dev Mode. + +First launch can take a little longer while config and cache files are created. + +## Controls + +```text +Start + View/Back Open console +View/Back Close console +A Open the keyboard on text fields +D-pad Navigate menus and server browser +``` + +## Brightness + +Some maps can look darker on Xbox than on PC. + +If a level feels too dark, raise Gamma in Video Settings a bit. + +## Online Play + +Public servers should appear in the server browser. + +To host from Xbox, your router may need this port forwarded to the Xbox: + +```text +UDP 27500 +``` + +If a server kicks you for a map or asset mismatch, try another server. Some public servers are running different files, and desktop NZ:P can hit the same problem. + +## Notes + +Downloaded server files are saved by the game automatically. + +Direct UDP servers are the best choice right now. P2P or relay-style servers may be less reliable. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/openbor-guide.mdx b/docs/ports/openbor-guide.mdx new file mode 100644 index 0000000..da3119a --- /dev/null +++ b/docs/ports/openbor-guide.mdx @@ -0,0 +1,33 @@ +--- +title: "OpenBOR Guide" +sidebar_position: 20 +description: "A guide for setting up OpenBOR on dev mode." +tags: + - ports + - openbor + - xbox +slug: openbor-guide +--- + + +### Requirements +- **External Drive** - Required to store your game files and other data. + +### Preparing Your External Drive +1. Connect your external drive to your PC. +2. At the root of the drive, create a folder named `openbor`. +3. Inside the `openbor` folder, create the following subfolders: + - `Logs` + - `Paks` + - `Saves` + - `Screenshots` +4. Drag and drop your OpenBOR games into the `Paks` folder. + +### Using OpenBOR +1. If you have more than one game in the `Paks` folder, a list will appear. + - To select a game from the list, press the **Start** button on your controller. +2. If you only have one game, it will load automatically. + +**Important Notes:** +- Pressing the **A** button when selecting a game will open the logs, and there is no way to exit this screen. To return, you will need to restart the app. +- This is a **test build**, and some features may have bugs. diff --git a/docs/ports/openlara-guide.mdx b/docs/ports/openlara-guide.mdx new file mode 100644 index 0000000..5b2f8a9 --- /dev/null +++ b/docs/ports/openlara-guide.mdx @@ -0,0 +1,97 @@ +--- +title: "OpenLara Guide" +sidebar_position: 21 +description: "A guide for setting up OpenLara on dev mode." +tags: + - guides + - ports + - xbox +slug: openlara-guide +--- + + +### Extracting Game Assets + +**NOTE:** You can use assets from the original PC or PS1 versions. The original PC version +can be purchased at **[GOG.com]()**. + +### **For PS1 Version** +1. Use a program like **PowerISO** to extract the ISO or BIN file. +2. Copy the following folders to your desktop: + - `PSXDATA` + - `FMV` + - `DELDATA` + +### **For GOG Version** +1. Navigate to the game's installation directory and open the **DOSBOX** folder. +2. Open the `dosbox.conf` file in a text editor like **Notepad**. +3. Scroll to the bottom and add the following under the `[autoexec]` heading: + +``` +mount C . + imgmount d ".\GAME.GOG" -t iso -fs iso + xcopy D:\DATA\ C:\DATA\ + xcopy D:\FMV\ C:\FMV\ +``` +It should look like this: + +``` +[autoexec] +# Lines in this section will be run at startup. +# You can put your MOUNT lines here. +mount C . + imgmount d ".\GAME.GOG" -t iso -fs iso + xcopy D:\DATA\ C:\DATA\ + xcopy D:\FMV\ C:\FMV\ +``` +4. Copy the `GAME.GOG` file from the **Tomb Raider 1** folder and paste it into the **DOSBOX** folder. +5. Run the **DOSBox** application from the same directory. This will extract the `DATA` and `FMV` folders to the **DOSBOX** directory. +6. Copy the extracted `DATA` and `FMV` folders to your desktop. + +### Obtaining Audio Files + +1. **Download Audio Files**: + - Get the **(TR1 also Gold)** file from **[this link](https://opentomb.earvillage.net/)**. + - Extract the ZIP file. + +2. **Transfer Files**: + - Copy the contents of the `pix` folder to: + - `PSXDATA` folder for PS1. + - `DATA` folder for GOG. + - Copy the `audio` folder to your desktop. + +3. **Prepare for Compression**: + - **For PS1**: + - Select the following folders: + - `PSXDATA` + - `FMV` + - `DELDATA` + - `audio` + - Compress all into a single ZIP file. + + - **For GOG**: + - Select the following folders: + - `DATA` + - `FMV` + - `audio` + - Compress all into a single ZIP file. + +### Internal Setup +1. Launch **OpenLara** to initialize the folders. + - The app will force close. +2. Upload your **zip** file: + - Open the Dev Portal. + - Go to **File Explorer** > **Local App Data** > **OpenLara**. + - Navigate to the **Local State** folder. + - Click **Choose File**, locate your `zip` file, and **Upload**. + - When prompted, choose yes to **Extract ZIP Contents** into the directory. +3. Launch **OpenLara** and you're ready to play. + +### Additional notes +- Press **LB** + **A** to enable first person. +- The PS1 assets have crackly FMV audio, but everything else works fine. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/opentyrian-guide.mdx b/docs/ports/opentyrian-guide.mdx new file mode 100644 index 0000000..5f93ea8 --- /dev/null +++ b/docs/ports/opentyrian-guide.mdx @@ -0,0 +1,48 @@ +--- +title: "OpenTyrian 2000 Guide" +sidebar_position: 22 +description: "A guide for setting up OpenTyrian 2000 on dev mode." +tags: + - guides + - ports + - xbox +slug: opentyrian-guide +--- + + +### Internal Setup +1. Launch **OpenTyrian 2000** to initialize the folders. + - The app will force close. +2. Upload the attached `Tyrian 2000.zip` file: + - Open the Dev Portal. + - Go to **File Explorer** > **Local App Data** > **OpenTyrianUWP**. + - Navigate to the **Local State** folder. + - Click **Choose File**, locate your `zip` file, and **Upload**. +3. Launch **OpenTyrian 2000** and you're ready to play. + +### **Fullscreen Setup Instructions** +- Open the **OpenTyrian 2000** option on the title screen. +- Modify these settings: + - **Scaler**: Set to **5x** for maximum screen size. + - **Full Screen**: Switch **Windowed** to **Full Screen: Display 1**. +- Optional: Fine-tune the scaler further to enhance graphic sharpness if desired. +- **Note**: + - These adjustments may need to be reapplied each time you start the app. + - The window will always display with borders. + +### **Controls** +- **LB**: Menu +- **RB**: Pause +- **Left Stick**: Movement +- **A**: Shoot +- **B**: Change Fire +- **X**: Left Sidekick +- **Y**: Right Sidekick + +### Note +The **Tyrian assets** have been officially released as freeware, allowing us to include them for use in this setup. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/perfectdark-guide.mdx b/docs/ports/perfectdark-guide.mdx new file mode 100644 index 0000000..6544656 --- /dev/null +++ b/docs/ports/perfectdark-guide.mdx @@ -0,0 +1,38 @@ +--- +title: "Perfect Dark Guide" +sidebar_position: 23 +description: "A guide for setting up Perfect Dark on dev mode." +tags: + - guides + - ports + - xbox +slug: perfectdark-guide +--- + + +### Prerequisites +* **Perfect Dark ROM:** You must provide your own NTSC Final (US V1.1/Rev 1) ROM. + * **MD5 Checksum:** `e03b088b6ac9e0080440efed07c1e40f` +* **Rename File:** Rename your ROM file to `pd.ntsc-final.z64` before starting. + +### Install the Perfect Dark App +1. Open the **Xbox Device Portal**. +2. Upload and install the `Perfect Dark .msix` package. +3. **Launch the app once** on your Xbox. This initial run is required to generate the necessary folder structure within `LocalState`. +4. Close the app once it has reached the main menu or initialization screen. + +### Upload Game Data +1. In the **Xbox Device Portal**, navigate to the following directory: + * `File Explorer` > `LocalAppData` > `Perfect Dark` > `LocalState` > `Perfect Dark` +2. Upload your renamed ROM (`pd.ntsc-final.z64`) into this folder. +3. Launch the app again to play. + +### Known Issues & Notes +* **Compatibility:** The game is mostly functional, supporting both single-player and split-screen multiplayer. +* **Bugs:** Users may experience minor graphical glitches, gameplay issues, or occasional crashes. +* **Storage:** This setup currently only supports **internal** installations. + +--- + +*Contributor: MewLew* + diff --git a/docs/apps/razeuwp-guide.mdx b/docs/ports/razeuwp-guide.mdx similarity index 98% rename from docs/apps/razeuwp-guide.mdx rename to docs/ports/razeuwp-guide.mdx index 375728b..452f455 100644 --- a/docs/apps/razeuwp-guide.mdx +++ b/docs/ports/razeuwp-guide.mdx @@ -1,13 +1,14 @@ --- -sidebar_position: 4 +sidebar_position: 24 title: RazeUWP Setup Guide description: Complete guide for installing and setting up RazeUWP Build engine port on Xbox tags: - - apps + - ports - raze - build-engine - uwp - xbox +slug: razeuwp-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -24,7 +25,7 @@ This guide explains how to set up Raze, a source port for Build engine games (li { 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: 'Difficulty', value: 'Intermediate - 20-30 minutes' }, { label: 'BIOS/keys', value: 'None, needs original game data (GRP/RFF etc.)' }, { label: 'Controllers', value: 'Xbox gamepad' }, ]} diff --git a/docs/ports/relichunters-guide.mdx b/docs/ports/relichunters-guide.mdx new file mode 100644 index 0000000..ae99e30 --- /dev/null +++ b/docs/ports/relichunters-guide.mdx @@ -0,0 +1,28 @@ +--- +title: "Relic Hunters Zero Guide" +sidebar_position: 25 +description: "A guide for setting up Relic Hunters Zero on dev mode." +tags: + - guides + - ports + - xbox +slug: relichunters-guide +--- + + +### Install Relic Hunters Zero +1. Install the `RelicHuntersZero.appx` via the dev portal. +2. Launch **Relic Hunters Zero**, and you're ready to play! + +### Additional notes +- If the game starts in a bordered window: + 1. Open **Settings** on your Xbox. + 2. Navigate to **General** > **TV & display options**. + 3. Go to **Advanced** > **Video fidelity & overscan**. + 4. Disable the **Apps can add a border** option under **Overscan border**. +- Pressing the **Start** button dims the screen slightly. Pressing it again returns the brightness to normal. This is a known issue with the GMS runner, not the game itself. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/sdlpop-guide.mdx b/docs/ports/sdlpop-guide.mdx new file mode 100644 index 0000000..4cd4a91 --- /dev/null +++ b/docs/ports/sdlpop-guide.mdx @@ -0,0 +1,26 @@ +--- +title: "SDLPOP (Prince of Persia) Guide" +sidebar_position: 26 +description: "A guide for setting up SDLPOP (Prince of Persia) on dev mode." +tags: + - guides + - ports + - xbox +slug: sdlpop-guide +--- + + +### Install SDLPOP: +1. Install the `sdlpop.appx` via the dev portal. +2. Launch **SDLPOP**, and you're ready to play! + +### Additional Notes +- If pressing **A** at the "Press any key to continue" prompt does not work, no controls will function in-game. Quit and restart the game. + - **You may need to restart multiple times until the controls respond correctly.** +- **Quicksave** and **Quickload** options are available from the Start menu. +- **Keyboard input** is fully supported. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/sm64coopdx-guide.mdx b/docs/ports/sm64coopdx-guide.mdx new file mode 100644 index 0000000..9627999 --- /dev/null +++ b/docs/ports/sm64coopdx-guide.mdx @@ -0,0 +1,103 @@ +--- +title: "sm64coopdx Guide" +sidebar_position: 27 +description: "A guide for setting up sm64coopdx on dev mode." +tags: + - guides + - ports + - xbox +slug: sm64coopdx-guide +--- + + +This build is for Xbox Series consoles in Dev Mode. + +### 1. Get the right ROM + +You need a **vanilla US Super Mario 64 ROM** named: + +`baserom.us.z64` + +Expected MD5: + +`20b854b239203baf6c961b850a4a51a2` + +If the ROM name or hash does not match, the game will not load properly. + +### 2. Choose where to put the ROM + +You have two supported options: + +- `LocalState` +- `E:\sm64coopdx` + +#### Option A: LocalState +Use the Xbox Dev Portal file explorer and upload: + +`baserom.us.z64` + +into the app's `LocalState` folder. + +#### Option B: E drive +Create this folder on the Xbox drive: + +`E:\sm64coopdx` + +and place the ROM here: + +`E:\sm64coopdx\baserom.us.z64` + +### 3. First launch + +On first boot, the game will set up its working folders automatically. + +That includes folders like: + +- `mods` +- `dynos` +- `sav` +- `palettes` +- `lang` + +Please **do not manually add extra files before the first launch** apart from the ROM itself. + +The game needs that first boot to finish its own setup cleanly. + +### 4. Active storage path + +Wherever the ROM is found becomes the active root path for the game. + +So if the ROM is in: + +- `LocalState` + then saves, config, mods, DynOS content, and user files will live in `LocalState` + +- `E:\sm64coopdx` + then saves, config, mods, DynOS content, and user files will live in `E:\sm64coopdx` + +### 5. After first launch + +Once the game has booted successfully once, you can then add extra content such as: + +- mods +- DynOS packs +- palettes +- language files + +Add them to the same active root path the game is using. + +### 6. Current status + +- CoopNet works +- Public lobbies work +- Mods work + +If the game does not detect the ROM, the first thing to check is: + +- filename is exactly `baserom.us.z64` +- ROM hash is exactly `20b854b239203baf6c961b850a4a51a2` + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/snake-guide.mdx b/docs/ports/snake-guide.mdx new file mode 100644 index 0000000..67cd045 --- /dev/null +++ b/docs/ports/snake-guide.mdx @@ -0,0 +1,37 @@ +--- +title: "Snake Guide" +sidebar_position: 28 +description: "A guide for setting up Snake on dev mode." +tags: + - guides + - ports + - xbox +slug: snake-guide +--- + + +### Install Snake +1. Extract the attached `Snake.rar` file. +2. Install the `Snake_1.0.0.0_x64.appxbundle` via the dev portal. + - Include the 3 dependencies. +3. Launch **Snake**, and you're ready to play! + +### Controls +- **D-Pad**: Movement +- **X**: Confirm/Accept on the title screen + +### Additional Notes +- **2-Player is Non-Functional**. +- **Cursor Behavior**: + - Move the **Left Stick** to hide the cursor after launching the game. + - Pressing the **Xbox button** will bring the cursor back, and there is no way to hide it again without restarting. +- **Quitting the Game**: + - There is no in-game pause or quit option. To quit: + 1. Press the **Xbox button**. + 2. Hover over **Snake**. + 3. Press **Start** and select **Quit**. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/soh-guide.mdx b/docs/ports/soh-guide.mdx new file mode 100644 index 0000000..c0e354c --- /dev/null +++ b/docs/ports/soh-guide.mdx @@ -0,0 +1,58 @@ +--- +title: "SOH (Ship of Harkinian) Foxtrot UWP Edition Guide" +sidebar_position: 29 +description: "A guide for setting up SOH (Ship of Harkinian) Foxtrot UWP Edition on dev mode." +tags: + - guides + - ports + - xbox +slug: soh-guide +--- + + +### Requirements +- **External Drive** - Required to store your game file and other data. +- **Dependency** - `Microsoft.VCLibs.x64.14.00.appx` +- **Game (`oot.otr`) file** - Generated using the Ship of Harkinian **Foxtrot** desktop program [**here**](). + +### Obtaining the `oot.otr` file +You will need to dump your compatible game and extract the `.n64` file before generating the `oot.otr` file. +Refer to this guide for detailed instructions: + +- **[Rom Dumping Guide]()** + +After obtaining your `.n64` file, use the Ship of Harkinian desktop program to generate the `oot.otr` file. +Follow the guide below for your operating system: + +- **[Windows]()** +- **[Linux]()** +- **[macOS]()** + +### Prepare Your External Drive +- Create a folder named `soh` in lowercase. +- Add your `oot.otr` to this folder. +- Inside the `soh` folder, create the following subfolder: + - `mods` in lowercase (for mods like `.otr` files). + +### Modding +- Add mods to the `mods` folder on your external drive. +- Larger mods can be added internally too: + - Open the **Dev Portal** on your PC. + - Navigate to `LocalAppData > soh > Localstate` using the **File Explorer**. + - Inside the `LocalState` folder, create the following subfolder: + - `mods` in lowercase (for mods like `.otr` files). + - Upload your mod files into the `mods` folder. +- Uploading multiple mods? Compress them as a zip file. + - Click **Choose File** and select your `.zip` mod file. + - Click **Upload**. + - When prompted, choose yes to **Extract ZIP Contents** into the directory. + +### Additional notes +- Mods can be stored in subfolders. +- Check for any specific setting requirements on the mod download page. +- Press the **Select/View** button to open the dev menu, then **X** to change focus. You can hold **X** and press a bumper button to switch between windows. + +--- + +*Contributor: MewLew* + diff --git a/docs/apps/sonic-adventure-blast2-uwp.mdx b/docs/ports/sonic-adventure-blast2-uwp-guide.mdx similarity index 98% rename from docs/apps/sonic-adventure-blast2-uwp.mdx rename to docs/ports/sonic-adventure-blast2-uwp-guide.mdx index 9af120e..41a2f24 100644 --- a/docs/apps/sonic-adventure-blast2-uwp.mdx +++ b/docs/ports/sonic-adventure-blast2-uwp-guide.mdx @@ -1,13 +1,14 @@ --- -sidebar_position: 5 +sidebar_position: 30 title: Sonic Adventure Blast 2 UWP Setup Guide description: Complete guide for installing and setting up Sonic Adventure Blast 2 UWP on Xbox tags: - - apps + - ports - sonic - sab2 - uwp - xbox +slug: sonic-adventure-blast2-uwp-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -28,7 +29,7 @@ This guide provides instructions for installing and setting up the fan-made game { label: 'Dev Mode', value: 'Required' }, { label: 'Storage', value: 'NTFS USB required for Settings/res folders' }, { label: 'User folder', value: 'USB:\\sab2 with Settings and res at root' }, - { label: 'Difficulty', value: 'Intermediate - ~15–20 minutes' }, + { label: 'Difficulty', value: 'Intermediate - ~15-20 minutes' }, { label: 'BIOS/keys', value: 'None' }, { label: 'Controllers', value: 'Xbox gamepad, set app type to Game' }, ]} diff --git a/docs/apps/sonic-unleashed-recompiled.mdx b/docs/ports/sonic-unleashed-recompiled-guide.mdx similarity index 99% rename from docs/apps/sonic-unleashed-recompiled.mdx rename to docs/ports/sonic-unleashed-recompiled-guide.mdx index c82b898..f44f8b8 100644 --- a/docs/apps/sonic-unleashed-recompiled.mdx +++ b/docs/ports/sonic-unleashed-recompiled-guide.mdx @@ -1,13 +1,14 @@ --- -sidebar_position: 6 +sidebar_position: 31 title: Sonic Unleashed Recompiled UWP Setup Guide description: Complete guide for installing and setting up Sonic Unleashed Recompiled UWP on Xbox tags: - - apps + - ports - sonic - unleashed - uwp - xbox +slug: sonic-unleashed-recompiled-guide --- import AtAGlance from '@site/src/components/AtAGlance'; @@ -26,7 +27,7 @@ This guide provides instructions for installing and setting up the "Sonic Unleas { label: 'Dev Mode', value: 'Required' }, { label: 'Storage', value: 'NTFS USB required, must mount as E:\\ on PC' }, { label: 'User folder', value: 'USB:\\unleashed generated by PC installer' }, - { label: 'Difficulty', value: 'Advanced - 30–45 minutes' }, + { label: 'Difficulty', value: 'Advanced - 30-45 minutes' }, { label: 'BIOS/keys', value: 'Uses your own Sonic Unleashed dump, no BIOS' }, { label: 'Controllers', value: 'Xbox gamepad, set app type to Game' }, ]} diff --git a/docs/ports/sonic1decomp-guide.mdx b/docs/ports/sonic1decomp-guide.mdx new file mode 100644 index 0000000..5a2ac8a --- /dev/null +++ b/docs/ports/sonic1decomp-guide.mdx @@ -0,0 +1,52 @@ +--- +title: "Sonic 1 Decompilation Guide" +sidebar_position: 32 +description: "A guide for setting up Sonic 1 Decompilation on dev mode." +tags: + - guides + - ports + - xbox +slug: sonic1decomp-guide +--- + + +### Requirements +- **Game `data.rsdk` file** - You must own a copy of Sonic to obtain the required data files. + +### Obtaining the `data.rsdk` File + +#### PC: +1. Navigate to your Sonic the Hedgehog game installation folder. +2. Locate the `data.rsdk` file within the directory. + +#### Android: +1. Install an APK extractor app on your device. +2. Use the app to extract your installed **Sonic the Hedgehog Classic** APK. +3. Download and install **ZArchiver**. +4. Open ZArchiver and locate the extracted Sonic APK. +5. Select the APK file and choose the **Extract Here** option. +6. Navigate to the extracted **assets** folder and find the `data.rsdk.xmf` file. +7. Rename the file to `data.rsdk` by removing the `.xmf` extension. +8. Your `data.rsdk` file is now ready to use. + +**Important**: The **Sonic Origins** and **Origins Plus** `Sonic1u.rsdk` file is **not compatible** with this port. + +### Internal Setup +1. Launch **Sonic the Hedgehog** to initialize the folders. + - The app will force close. +2. Upload the **data.rsdk** file: + - Open the Dev Portal. + - Go to **File Explorer** > **Local App Data** > **Sonic the Hedgehog**. + - Navigate to the **Local State** folder. + - Click **Choose File**, locate your `data.rsdk` file, and **Upload**. +3. Launch **Sonic the Hedgehog** and you're ready to play. + +### Additional Notes +- You can upload save files (`Sdata.bin`) to the same directory as the `data.rsdk` file. +- If button inputs are not working when the game starts, quit and restart the game. + - Press the **Xbox button**, hover over **Sonic the Hedgehog**, press **Start**, and choose **Quit**. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/sonic2decomp-guide.mdx b/docs/ports/sonic2decomp-guide.mdx new file mode 100644 index 0000000..e76aec1 --- /dev/null +++ b/docs/ports/sonic2decomp-guide.mdx @@ -0,0 +1,52 @@ +--- +title: "Sonic 2 Decompilation Guide" +sidebar_position: 33 +description: "A guide for setting up Sonic 2 Decompilation on dev mode." +tags: + - guides + - ports + - xbox +slug: sonic2decomp-guide +--- + + +### Requirements +- **Game `data.rsdk` file** - You must own a copy of Sonic to obtain the required data files. + +### Obtaining the `data.rsdk` File + +#### PC +1. Navigate to your Sonic the Hedgehog 2 game installation folder. +2. Locate the `data.rsdk` file within the directory. + +#### Android +1. Install an APK extractor app on your device. +2. Use the app to extract your installed **Sonic the Hedgehog 2 Classic** APK. +3. Download and install **ZArchiver**. +4. Open ZArchiver and locate the extracted Sonic APK. +5. Select the APK file and choose the **Extract Here** option. +6. Navigate to the extracted **assets** folder and find the `data.rsdk.xmf` file. +7. Rename the file to `data.rsdk` by removing the `.xmf` extension. +8. Your `data.rsdk` file is now ready to use. + +**Important**: The **Sonic Origins** and **Origins Plus** `Sonic2u.rsdk` file is **not compatible** with this port. + +### Internal Setup +1. Launch **Sonic the Hedgehog 2** to initialize the folders. + - The app will force close. +2. Upload the **data.rsdk** file: + - Open the Dev Portal. + - Go to **File Explorer** > **Local App Data** > **Sonic the Hedgehog 2**. + - Navigate to the **Local State** folder. + - Click **Choose File**, locate your `data.rsdk` file, and **Upload**. +3. Launch **Sonic the Hedgehog 2** and you're ready to play. + +### Additional Notes +- You can upload save files (`Sdata.bin`) to the same directory as the `data.rsdk` file. You can upload save files (`Sdata.bin`) to the same directory as the `data.rsdk` file. +- If button inputs are not working when the game starts, quit and restart the game. + - Press the **Xbox button**, hover over **Sonic the Hedgehog 2**, press **Start**, and choose **Quit**. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/sonic3air-guide.mdx b/docs/ports/sonic3air-guide.mdx new file mode 100644 index 0000000..7e7265d --- /dev/null +++ b/docs/ports/sonic3air-guide.mdx @@ -0,0 +1,42 @@ +--- +title: "Sonic 3 A.I.R. Guide" +sidebar_position: 34 +description: "A guide for setting up Sonic 3 A.I.R on dev mode." +tags: + - guides + - ports + - xbox +slug: sonic3air-guide +--- + + +### 1. Obtain the Game ROM +- Refer to the following documentation for instructions on how to obtain your ROM if you do not have the delisted *Sonic 3 & Knuckles* on Steam: + [Sonic 3 & Knuckles ROM Guide](https://docs.google.com/document/d/1oSud8dJHvdfrYbkGCfllAOp3JuTks7z4K5SwtVkXkx0/edit?usp=sharing) + +### 2. Install the Sonic 3 A.I.R. App +- Install the app package via the Xbox Dev Portal. +- Install the included dependency file. + +### 3. Add the ROM to Xbox +- Once you have obtained your ROM (named `Sonic_Knuckles_wSonic3.bin`), place it in **one** of these locations: + - The app's **LocalState** folder using the Xbox Dev Portal file explorer. + - An external drive at the specific path: `E:\Sonic3AIR`. + +### 4. Launch and Initial Setup +1. Launch the app on your Xbox Series console. +2. On first launch, the game will automatically generate the following folders: + - `data` + - `storage` + - `mods` +3. **Storage Behavior:** - If the ROM is found on your external drive (`E:\Sonic3AIR`), that location becomes the active root for saves, mods, and config files. + - If no ROM is found there, the game defaults to **LocalState**. + +### Additional Notes +- **Remastered Audio:** The audio download is functional and will save to whichever storage root is active. +- **Controller Support:** Full support and rebinding are available in-game. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/soniccd-guide.mdx b/docs/ports/soniccd-guide.mdx new file mode 100644 index 0000000..912fc18 --- /dev/null +++ b/docs/ports/soniccd-guide.mdx @@ -0,0 +1,45 @@ +--- +title: "Sonic CD (Decompilation) Guide" +sidebar_position: 35 +description: "A guide for setting up Sonic CD (Decompilation) on dev mode." +tags: + - guides + - ports + - xbox +slug: soniccd-guide +--- + + +### Requirements +- **Game `data.rsdk` file** - You must own a copy of Sonic CD to obtain the required data files. + +### Obtaining the `data.rsdk` File +1. Open your Sonic CD game directory. +2. Locate the 'data.rsdk` file. + +**Important**: The **Sonic Origins** data file (`SonicCDu.rsdk`) is **not compatible** with this port. You must use the original **Sonic CD** release's `data.rsdk` file. + +### Internal Setup +1. Launch **Sonic CD** to initialize the folders. + - The app will force close. +2. Upload the **data.rsdk** file: + - Open the Dev Portal. + - Go to **File Explorer** > **Local App Data** > **Sonic CD**. + - Navigate to the **Local State** folder. + - Click **Choose File**, locate your `data.rsdk` file, and **Upload**. +3. Launch **Sonic CD** and you're ready to play. + +### Modding +- This port is built on an older version of the **Sonic CD Remake**, so the mod folder/script approach to modding will not work. +- However, you can unpack the `data.rsdk` file, replace the assets directly, and then repack the `rsdk`. This means only mods that replace the original assets will be compatible. +- For convenience, you can use this **[tool](https://gamebanana.com/tools/6957)**. + +### Additional Notes +- You can upload save files (`Sdata.bin`) to the same directory as the `data.rsdk` file. +- If button inputs are not working when the game starts, quit and restart the game. + - Press the **Xbox button**, hover over **Sonic CD**, press **Start**, and choose **Quit**. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/sonicmania-guide.mdx b/docs/ports/sonicmania-guide.mdx new file mode 100644 index 0000000..5aa021a --- /dev/null +++ b/docs/ports/sonicmania-guide.mdx @@ -0,0 +1,87 @@ +--- +title: "Sonic Mania Guide" +sidebar_position: 36 +description: "A guide for setting up Sonic Mania on dev mode." +tags: + - guides + - ports + - xbox +slug: sonicmania-guide +--- + + +### Requirements +- **Sonic Mania game files**: You must own a copy of Sonic Mania to use the required data file. + +**MOBILE PORT DOESN'T WORK!** + +### Install the Sonic Mania App +- Install the `RSDKv5-UWP_1.4.0.0_x64.appx` via the dev portal. + +### External Drive Setup +1. On your external drive, create a folder for Sonic Mania (e.g., `E:\Sonic Mania`). +2. Copy your game files into the Sonic Mania folder. +3. Launch **Sonic Mania**. +4. When prompted to select a **data.rsdk** file: + - Open your Sonic Mania folder. + - Navigate to your **data.rsdk** file and click **Select**. +5. The app will crash; reopen it, and you're ready to play. + +### Internal Setup +1. Launch **Sonic Mania** to initialize the folders. + - When prompted to select a **data.rsdk** file click **Cancel**. The app will go black. + - Press the **Xbox button**, hover over **Sonic Mania**, press **Start**, and choose **Quit**. +2. Upload the **data.rsdk** file: + - Open the Dev Portal. + - Go to **File Explorer** > **Local App Data** > **Sonic Mania**. + - Navigate to the **Local State** folder. + - Click **Choose File**, locate your `data.rsdk` file, and **Upload**. +3. Launch **Sonic Mania** and you're ready to play. + +### Modding +1. **Mod File**: Download your desired mod in `.zip` format. If not zipped, compress it into a `.zip` file. +2. In the Dev Portal, go to: + - **File Explorer** > **Development Files** > **Windows Apps** > **Sonic Mania**. +2. Open the Sonic Mania folder and locate the **Mods** folder. +3. Upload and Extract Mod: + - In the **Mods** folder: + - Click **Choose File** and select your `.zip` mod file. + - Click **Upload**. + - When prompted, choose yes to **Extract ZIP Contents** into the directory. +4. Enable the mod via `modconfig.ini`: + - In the Sonic Mania folder: + - Download/Save the `modconfig.ini` file. + - Open `modconfig.ini` in a text editor (e.g., Notepad). + - Ignore existing lines like `D3D11 Shaders`. + - Add your mod in the format: + `Ultra Ego Shadow=1` +5. Save the file. +6. Re-upload the edited `modconfig.ini`: + - Delete the existing file. + - Upload your new edited file. +7. Launch Sonic Mania and your mods should be applied. + +### Notes +- To disable a mod, change `=1` to `=0` in the `modconfig.ini` file. + +### Enabling the In-Game Dev Menu +1. In the Dev Portal, go to: + - **File Explorer** > **LocalAppData** > **Sonic Mania** > **LocalState**. + - Download the `Settings.ini` file to your computer or phone. +2. Open `Settings.ini` in a text editor (e.g., Notepad). + - Locate the line: `language=0`. + - Add the following lines directly below it: + ``` + enableControllerDebugging=y + devMenu=y + ``` + - Save the changes. +3. Re-upload the edited `Settings.ini` file: + - Delete the existing file. + - Upload your new edited file. +4. In-game, press the **Select/View** button to open the Dev Menu. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/sonicrealms-guide.mdx b/docs/ports/sonicrealms-guide.mdx new file mode 100644 index 0000000..5c36d8b --- /dev/null +++ b/docs/ports/sonicrealms-guide.mdx @@ -0,0 +1,27 @@ +--- +title: "Sonic Realms Guide" +sidebar_position: 37 +description: "A guide for setting up Sonic Realms on dev mode." +tags: + - guides + - ports + - xbox +slug: sonicrealms-guide +--- + + +> Sonic Realms is a **free, open-source 2D Sonic development kit** built using the Unity engine. +> - **Note:** After playing two levels, the game may send you back to the main menu. It's unclear if additional levels can be added, but it's exciting to see this available on UWP! + +For more details on Sonic Realms, visit: [**Sonic Retro Forums**](https://forums.sonicretro.org/index.php?threads/sonic-realms-0-4-0-unity2d-engine.35309/). + +### Install Sonic Realms: +1. Download and extract the `Sonic_Realms.rar`. +2. Install the `Sonic Realms_1.0.0.0_x64.appxbundle` via the dev portal. +3. Include the two required dependencies from the `.rar` when uploading. +4. Launch **Sonic Realms**, and you're ready to play! + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/sonicringracers-guide.mdx b/docs/ports/sonicringracers-guide.mdx new file mode 100644 index 0000000..7a70d53 --- /dev/null +++ b/docs/ports/sonicringracers-guide.mdx @@ -0,0 +1,51 @@ +--- +title: "Sonic Ring Racers Guide" +sidebar_position: 38 +description: "A guide for setting up Sonic Ring Racers on dev mode." +tags: + - guides + - ports + - xbox +slug: sonicringracers-guide +--- + + +### Requirements +- **Xbox Series S/X**. +- **Dependency** - `Microsoft.VCLibs.x64.14.00.appx` +- **External Drive** - Required to store your game assets. +- **Game assets**. + +### Obtaining the Game Assets +1. Go to the Ring Racers **[GitHub](https://github.com/KartKrewDev/RingRacers/releases/tag/v2.3)** releases. +2. Download the `Dr.Robotnik.s-Ring-Racers-Assets.zip`. +3. Extract the contents of the zip file. + +### Preparing an External Drive +1. Create a folder named `ringracers` (use lowercase for compatibility). +2. Place the extracted contents of the `Dr.Robotnik.s-Ring-Racers-Assets.zip` into the `ringracers` folder. + +### Controls +- **A** = Accelerate +- **X** = Brake / Reverse +- **B** = Look Behind +- **Y** = Spin Dash +- **LB** = Reset Position +- **LT** = Use Ring / Insta-Whip +- **RT** = Drift +- **RB** = Z/Skip Text +- **Left Stick** = Steer / Move +- **Start** = Pause / Open Menu + +### Additional Notes +- Vsync is forced on in the OpenGL driver. Enabling in-game Vsync may cause erratic behavior with interpolation, so it's recommended to leave it off. +- Performance can vary depending on the track. Using 1280x800 GL resolution seems to be a good balance for performance. +- Enabling 3D models may reduce the framerate. +- Online play works with dedicated servers. To host your own server, you may need to forward ports to the Xbox. + - Use the software renderer for online play, as Legacy GL is highly unstable on this platform. +- This is not an official project by Kart Krew, so please do not report bugs related to this port to the main repository. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/sonicroboblast2-guide.mdx b/docs/ports/sonicroboblast2-guide.mdx new file mode 100644 index 0000000..47b327a --- /dev/null +++ b/docs/ports/sonicroboblast2-guide.mdx @@ -0,0 +1,63 @@ +--- +title: "Sonic Robo Blast 2 Guide" +sidebar_position: 39 +description: "A guide for setting up Sonic Robo Blast 2 on dev mode." +tags: + - guides + - ports + - xbox +slug: sonicroboblast2-guide +--- + + +### External Drive Setup +1. On your external drive, create a folder for Sonic Robo Blast 2 (e.g., `E:\SRB2`). +2. Inside the `SRB2` folder, create the following subfolder: + - `addons` (for mods like `.pk3` files). +3. Launch SRB2, and when prompted to choose a folder: + - Navigate to your USB drive. + - Select the `SRB2` folder you created earlier. +4. That's it! Enjoy. + +**Modding:** +1. Copy your mods into the `addons` folder (e.g., `E:\SRB2\addons`). +2. Launch SRB2: + - Select **ADDONS** on the title screen. + - Open your `addons` folder. + - Choose which mods to load. + +### Internal Storage Setup +1. Launch SRB2, and when prompted to choose a folder: + - Press B to exit the file explorer. +2. That's it! Enjoy. + +**Modding:** +1. Open the **Dev Portal** on your PC. +2. Navigate to `LocalAppData > SRB2 > Localstate` using the **File Explorer**. +3. Upload your mods into the `addons` folder. +4. Launch SRB2: + - Select **ADDONS** on the title screen. + - Open your `addons` folder. + - Choose which mods to load. + +### Enabling Multiplayer +1. Download the `ms-fix.txt` file **[here]()**. +2. Copy this file into your `addons` folder. +2. Launch SRB2: + - Select **ADDONS** on the title screen. + - Open your `addons` folder. + - Choose the `ms-fix.txt` file. + +### Disclaimer +Hosting and joining servers may not always work. Using the **ms-fix.txt** mod allows testing this feature. + +### Activating 3D Models +- Select **OPTIONS** on the title screen or in the pause menu. + - Choose **VIDEO OPTIONS...** + - Scroll to the bottom and under the **RENDERER** heading choose **OPENGL OPTIONS...** + - Under the **3D MODELS** heading, switch **MODELS** to **ON** and press **B** to exit. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/sonicsms-guide.mdx b/docs/ports/sonicsms-guide.mdx new file mode 100644 index 0000000..46d0fad --- /dev/null +++ b/docs/ports/sonicsms-guide.mdx @@ -0,0 +1,33 @@ +--- +title: "Sonic 1 & 2 SMS remakes Guide" +sidebar_position: 40 +description: "A guide for setting up Sonic 1 & 2 SMS remakes on dev mode." +tags: + - guides + - ports + - xbox +slug: sonicsms-guide +--- + + +### Install Sonic 1 SMS Remake +1. Install the `Sonic1SMSRemake.appx` via the dev portal. +2. Launch **Sonic 1 SMS Remake**, and you're ready to play! + +### Install Sonic 2 SMS Remake +1. Install the `Sonic2SMSRemake.appx` via the dev portal. +2. Launch **Sonic 2 SMS Remake**, and you're ready to play! + +#### Additional info +- If the game starts in a bordered window: + 1. Open **Settings** on your Xbox. + 2. Navigate to **General** > **TV & display options**. + 3. Go to **Advanced** > **Video fidelity & overscan**. + 4. Disable the **Apps can add a border** option under **Overscan border**. +- In Sonic 2 SMS Remake, pressing the **Start** button dims the screen slightly. Pressing it again returns the brightness to normal. This is a known issue with the GMS runner, not the game itself. +- Sonic 2 SMS Remake, the **Competition** mode has been removed as it does not function correctly on the Xbox. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/sonictimetwisted-guide.mdx b/docs/ports/sonictimetwisted-guide.mdx new file mode 100644 index 0000000..60286fa --- /dev/null +++ b/docs/ports/sonictimetwisted-guide.mdx @@ -0,0 +1,29 @@ +--- +title: "Sonic Time Twisted Guide" +sidebar_position: 41 +description: "A guide for setting up Sonic Time Twisted on dev mode." +tags: + - guides + - ports + - xbox +slug: sonictimetwisted-guide +--- + + +### Install Sonic Time Twisted +1. Install the `Sonic Time Twisted [Unofficial] (v1.1.2.0).appx` via the dev portal. +2. Launch **Sonic Time Twisted**, and you're ready to play! + +### Additional notes +- If the game starts in a bordered window: + 1. Open **Settings** on your Xbox. + 2. Navigate to **General** > **TV & display options**. + 3. Go to **Advanced** > **Video fidelity & overscan**. + 4. Disable the **Apps can add a border** option under **Overscan border**. +- Pressing the **Start** button dims the screen slightly. Pressing it again returns the brightness to normal. This is a known issue with the GMS runner, not the game itself. +- Enable rumble functionality under **Options > Map Gamepad**. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/spacecadetpinball-guide.mdx b/docs/ports/spacecadetpinball-guide.mdx new file mode 100644 index 0000000..3acdcd9 --- /dev/null +++ b/docs/ports/spacecadetpinball-guide.mdx @@ -0,0 +1,76 @@ +--- +title: "SpaceCadetPinball Guide" +sidebar_position: 42 +description: "A guide for setting up SpaceCadetPinball on dev mode." +tags: + - guides + - ports + - xbox +slug: spacecadetpinball-guide +--- + + +### 1. Install the Space Cadet Pinball UWP App + +Install the `.msixbundle` and the included dependency file using the Xbox Device Portal. + +### 2. Add the Game Data + +This release does **not** include the original Space Cadet Pinball data files. + +You will need to provide your own: + +- `*.DAT` +- `*.WAV` +- `*.MID` + +Place the game data in **one** of the following locations: + +- The app’s **LocalState** folder using the Xbox Device Portal file explorer. +- An external drive using this exact path: + +`E:\Pinball3D\` + +### 3. Set Up LocalState + +If you want to use internal storage, you may need to launch the game once first. This allows the app to create its **LocalState** folder. + +After launching it once, close the app. Then use the Xbox Device Portal file explorer to copy the game data into: + +`LocalState\SpaceCadetPinball\` + +### 4. Launch Space Cadet Pinball + +1. Launch the app from Xbox Dev Mode. +2. The game will check for the required data files. +3. If the files are found, the game will start normally. +4. If the files are missing, the app will show a startup error explaining where the files need to be placed. + +### Controls + +- **Left Trigger**: Left flipper +- **Right Trigger**: Right flipper +- **A**: Plunger / launch ball +- **Y**: New game +- **Start**: Pause +- **View / Back**: Toggle top menu + +### Saving + +Settings, control remaps, and highscores are saved automatically. + +Save data is stored in the app’s LocalState folder as: + +`imgui_pb.ini` + +This file stores: + +- graphics and UI settings +- audio settings +- control remaps +- highscores + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/spelunky-guide.mdx b/docs/ports/spelunky-guide.mdx new file mode 100644 index 0000000..757da98 --- /dev/null +++ b/docs/ports/spelunky-guide.mdx @@ -0,0 +1,39 @@ +--- +title: "Spelunky Classic HD Guide" +sidebar_position: 43 +description: "A guide for setting up Spelunky Classic HD on dev mode." +tags: + - guides + - ports + - xbox +slug: spelunky-guide +--- + + +### Install Spelunky Classic HD: +1. Install the `Spelunky_Classic_HD.appx` via the dev portal. +2. Launch **Spelunky Classic HD**, and you're ready to play! + +### Controls +- **Left Stick**: Move Left & Right +- **A**: Jump +- **B**: Action +- **X**: Switch Weapon +- **LT**: Run +- **LB**: Bomb +- **RT**: Purchase +- **RB**: Rope +- **Start/Menu**: Start/Pause + +### Additional notes +- If the game starts in a bordered window: + 1. Open **Settings** on your Xbox. + 2. Navigate to **General** > **TV & display options**. + 3. Go to **Advanced** > **Video fidelity & overscan**. + 4. Disable the **Apps can add a border** option under **Overscan border**. +- Pressing the **Start** button dims the screen slightly. Pressing **B** returns the brightness to normal. This is a known issue with the GMS runner, not the game itself. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/spookydimensions-guide.mdx b/docs/ports/spookydimensions-guide.mdx new file mode 100644 index 0000000..7ed513a --- /dev/null +++ b/docs/ports/spookydimensions-guide.mdx @@ -0,0 +1,34 @@ +--- +title: "Spooky Dimensions Guide" +sidebar_position: 44 +description: "A guide for setting up Spooky Dimensions on dev mode." +tags: + - guides + - ports + - xbox +slug: spookydimensions-guide +--- + + +### Install Spooky Dimensions : +1. Install the `SpookyDimensions.appx` via the dev portal. +2. Launch **Spooky Dimensions**, and you're ready to play! + +### Controls +- **Left Stick**: Movement +- **Right Stick**: Push up to Fire + +### Additional Notes +- **2-Player Co-op Supported**: + - Connect a second controller to your Xbox. + - Select **Co-op Campaign** on the title screen. +- **Quitting the Game**: + - There is no in-game pause or quit option. To quit: + 1. Press the **Xbox button**. + 2. Hover over **Spooky Dimensions**. + 3. Press **Start** and select **Quit**. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/starfox64-guide.mdx b/docs/ports/starfox64-guide.mdx new file mode 100644 index 0000000..cf53ff3 --- /dev/null +++ b/docs/ports/starfox64-guide.mdx @@ -0,0 +1,65 @@ +--- +title: "Starfox 64: Recompiled Guide" +sidebar_position: 45 +description: "A guide for setting up Starfox 64: Recompiled on dev mode." +tags: + - guides + - ports + - xbox +slug: starfox64-guide +--- + + +### Install the Starfox 64: Recompiled App +- Install the `StarFox64Recompiled` MSIX package via the dev portal. +- Install any included dependencies if the package provides them. +- This build requires a **US v1.1 Star Fox 64 N64 ROM**. +- Rename the ROM to: + + `sf64.n64.us.1.1` + +### Internal Storage Setup +1. Install and launch the game once. +2. Close the app after the first launch. +3. Open the Xbox Dev Portal. +4. Go to: + + `User Folders \ LocalAppData \ sf64_1.0.3.0_x64__52ywkb2d5ycg6 \ AC \ StarFox64Recompiled \` + +5. Upload the renamed ROM into the `StarFox64Recompiled` folder: + + `sf64.n64.us.1.1` + +6. Launch the game again. + +### External Drive Setup +1. Place your **US v1.1 Star Fox 64 N64 ROM** on an external drive. +2. Launch the app. +3. Choose **Select ROM** when prompted. +4. Select the ROM from your external drive. +5. The app will automatically copy the ROM to internal storage. + +### Saves and Mods +- Saves are stored internally in: + + `LocalState\AC\StarFox64Recompiled` + +- Mods are also stored internally in: + + `LocalState\AC\StarFox64Recompiled` + +- Mods must use the `.nrm` format. + +### Additional Notes +- The ROM must be the **US v1.1** version of Star Fox 64. +- External ROM loading is only used to import the ROM. +- After import, the ROM is copied to internal storage. +- Saves and mods always remain in internal LocalState storage. +- If the game does not detect the ROM, confirm the filename is exactly: + + `sf64.n64.us.1.1` + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/supertuxkart-guide.mdx b/docs/ports/supertuxkart-guide.mdx new file mode 100644 index 0000000..d4dae42 --- /dev/null +++ b/docs/ports/supertuxkart-guide.mdx @@ -0,0 +1,56 @@ +--- +title: "SuperTuxKart Guide" +sidebar_position: 46 +description: "A guide for setting up SuperTuxKart on dev mode." +tags: + - guides + - ports + - xbox +slug: supertuxkart-guide +--- + + +# SuperTuxKart UWP + +This build is intended for Xbox Series consoles through Xbox Dev Mode. + +### Install the SuperTuxKart UWP App +- Install the `SuperTuxKart` MSIX package through the Xbox Dev Portal. +- Install all included dependencies when prompted. +- The package is around 750 MB, so installation may take a minute or two depending on your network speed. + +### Launch SuperTuxKart UWP +1. Start the app from your Xbox Dev Mode installed apps list. +2. Wait for the game to finish loading. +3. Configure your controller bindings if needed. +4. For best results, check the graphics settings before playing addon tracks. + +### Features +- UWP port working on Xbox Series consoles. +- Controller support and button rebinding are working. +- Split screen multiplayer is supported. +- Xbox users can join public online servers. +- Keyboard input is supported where available. +- Config files, downloaded addons, generated files and caches are stored in the app's `LocalState` folder. + +### Performance Notes +- The build has been tested at 1440p and can maintain a fairly consistent 60 FPS. +- Some addon tracks use heavier detail and may reduce performance. +- If performance drops, reduce the render resolution in the graphics options. +- If weather effects cause drops, set particle effects to **Important Only** in the custom graphics settings. +- Do not enable texture compression in the custom graphics settings, as it currently causes visible banding in some skyboxes. + +### Networking +- Xbox users can join existing public servers. +- Xbox users cannot reliably host public or private servers because of console, router and NAT limitations. +- For the best public online setup, run a normal 24/7 SuperTuxKart server on a PC with the correct ports forwarded. Xbox players can then join that server whenever they like. + +### Storage +- Packaged game data is read from the installed app package. +- Writable data is stored in UWP `LocalState`. +- `LocalState` is used for config files, downloaded addons, generated files and caches. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/tailsadventure-guide.mdx b/docs/ports/tailsadventure-guide.mdx new file mode 100644 index 0000000..7081789 --- /dev/null +++ b/docs/ports/tailsadventure-guide.mdx @@ -0,0 +1,145 @@ +--- +title: "Tails Adventure Remake Guide" +sidebar_position: 47 +description: "A guide for setting up Tails Adventure Remake on dev mode." +tags: + - guides + - ports + - xbox +slug: tailsadventure-guide +--- + + +### Install the Tails Adventure Remake App + +- Install the included `.msixbundle` via the Xbox Dev Portal. + +## Internal Storage Setup + +Use this method if you want to store save data, runtime files and mods inside the app's Xbox Dev Mode **LocalState** folder. + +### Internal Storage Location + +The game stores internal files here: + +`LocalState\tails-adventure` + +Typical Xbox Dev Mode path: + +`Q:\Users\UserMgr0\AppData\Local\Packages\\LocalState\tails-adventure` + +### Internal Setup Steps + +1. Launch the game once first so the `LocalState\tails-adventure` folder is created. +2. Open the Xbox Dev Portal. +3. Go to the app's file explorer. +4. Open the app's `LocalState` folder. +5. Open or create this folder: + +`tails-adventure` + +6. Place your mod folders directly inside: + +`LocalState\tails-adventure` + +7. Add or edit `mods.ini` in the same folder. + +### Internal Storage Example + +`LocalState\tails-adventure\` +`mods.ini` +`Pinkails over Tails V2\` +`Another Mod Folder\` + +## External USB Drive Setup + +Use this method if you want to store mods on an external USB drive instead of inside the app's LocalState folder. + +### External Storage Location + +The game checks this external path: + +`E:\TailsAdventureRemake\mods` + +### External Setup Steps + +1. Create this folder structure on the external drive: + +`E:\TailsAdventureRemake\mods` + +2. Place your mod folders inside the `mods` folder. +3. Add or edit `mods.ini` inside the same `mods` folder. + +### External Storage Example + +`E:\TailsAdventureRemake\mods\` +`mods.ini` +`Pinkails over Tails V2\` +`Another Mod Folder\` + +## mods.ini Setup + +`mods.ini` controls which mods are enabled. + +The file uses a simple `Mod Folder Name=Value` format. + +Use: + +`1` to enable a mod. +`0` to disable a mod. + +Example: + +```ini +; Tails Adventure Remake mods config +; 1=true (enabled), 0=false (disabled) +; Edit values below and relaunch the game. + +Pinkails over Tails V2=1 +Another Mod Folder=0 +``` + +The mod name on the left must exactly match the mod folder name. + +Correct: + +`Folder: Pinkails over Tails V2` +`mods.ini: Pinkails over Tails V2=1` + +Incorrect: + +`Folder: Pinkails over Tails V2` +`mods.ini: Pinkails over tails v2=1` + +## Enabling a Mod + +To enable a mod, set its value to `1`: + +```ini +Pinkails over Tails V2=1 +``` + +## Disabling a Mod + +To disable a mod, set its value to `0`: + +```ini +Pinkails over Tails V2=0 +``` + +## Additional Notes + +- Internal storage users must launch the game once first so the LocalState folder is created. +- External USB users must use the exact path: + +`E:\TailsAdventureRemake\mods` + +- The game checks internal storage first, then checks the external USB path. +- If `mods.ini` does not exist and the selected mod root is writable, the game will create one automatically. +- If a mod does not load, check that the mod folder name and the `mods.ini` entry match exactly. +- After editing `mods.ini`, relaunch the game. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/trogdor-guide.mdx b/docs/ports/trogdor-guide.mdx new file mode 100644 index 0000000..0ab0a6c --- /dev/null +++ b/docs/ports/trogdor-guide.mdx @@ -0,0 +1,27 @@ +--- +title: "Trogdor Reburninated Guide" +sidebar_position: 48 +description: "A guide for setting up Trogdor Reburninated on dev mode." +tags: + - guides + - ports + - xbox +slug: trogdor-guide +--- + + +### Install Trogdor-Reburninated +1. Install the `Trogdor-Reburninated-UWP_2.0.0.0_x64.appx` via the dev portal. +2. Launch **Trogdor-Reburninated**, and you're ready to play! + +### Additional notes +- Change the game to full screen: + - Press the **Select/View** button on the title screen to open **Options**. + - Navigate to **Cosmetic Settings** > **Screen Scaling**. + - Select **Full Screen**. + - Restart the game for the changes to take effect. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/vvvvvv-guide.mdx b/docs/ports/vvvvvv-guide.mdx new file mode 100644 index 0000000..6fb398f --- /dev/null +++ b/docs/ports/vvvvvv-guide.mdx @@ -0,0 +1,35 @@ +--- +title: "VVVVVV (V6) Guide" +sidebar_position: 49 +description: "A guide for setting up VVVVVV (V6) on dev mode." +tags: + - guides + - ports + - xbox +slug: vvvvvv-guide +--- + + +> The provided `.appx` is precompiled with assets from the **VVVVVV Make and Play Edition**, with explicit permission from Terry Cavanagh. +> +> The **VVVVVV Make and Play Edition** is a completely free, official version of **VVVVVV** that includes player levels, and the tools to create levels of your own! It does not include the original levels from the game. + +### Install VVVVVV UWP: +1. Install the `VVVVVV-v2.3.6.0.appx` via the dev portal. + - Include the `Microsoft.VCLibs.x64.14.00.appx` dependancy. +2. Launch **VVVVVV UWP**, and you're ready to play! + +### Controls +- **Left Stick**: Movement +- **A**: Flip +- **Y**: Enter +- **B**: Menu +- **RB**: Restart + +### Additional Notes +- Open **Graphic Options** and set **Scaling Mode** to **Stretch** for full-screen gameplay. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/zelda3-guide.mdx b/docs/ports/zelda3-guide.mdx new file mode 100644 index 0000000..d88c425 --- /dev/null +++ b/docs/ports/zelda3-guide.mdx @@ -0,0 +1,36 @@ +--- +title: "Zelda 3 Guide" +sidebar_position: 50 +description: "A guide for setting up Zelda 3 on dev mode." +tags: + - guides + - ports + - xbox +slug: zelda3-guide +--- + + +### Requirements +- a `zelda3.sfc` USA ROM file (for asset extraction step only) with SHA256 hash `66871d66be19ad2c34c927d6b14cd8eb6fc3181965b6e517cb361f7316009cfb` +- `Microsoft.VCLibs.x64.14.00.appx` dependency file + +### Extract Assets +- Download the zelda3 project by clicking "Code > Download ZIP" on the **[Github]()** page +- Extract the ZIP to your hard drive +- Place the USA rom named zelda3.sfc in the root directory +- Double-click `extract_assets.bat` in the main directory to create zelda3_assets.dat in that same directory + +### Internal Setup +1. Launch **Zelda 3** to initialize the folders. + - The app will force close. +2. Upload the `zelda3_assets.dat` and the `config.ini` file: + - Open the Dev Portal. + - Go to **File Explorer** > **Local App Data** > **Zelda3**. + - Navigate to the **Local State** folder. + - Click **Choose File**, locate your `zelda3_assets.dat` file, and **Upload**. +3. Launch **Zelda 3** and you're ready to play. + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/zelda64-guide.mdx b/docs/ports/zelda64-guide.mdx new file mode 100644 index 0000000..a2591d1 --- /dev/null +++ b/docs/ports/zelda64-guide.mdx @@ -0,0 +1,42 @@ +--- +title: "Zelda 64 Recompiled Guide" +sidebar_position: 51 +description: "A guide for setting up Zelda 64 Recompiled on dev mode." +tags: + - guides + - ports + - xbox +slug: zelda64-guide +--- + + +- Only **Majora’s Mask** is supported currently +- **Ocarina of Time** support is planned for a future release + +### Requirements: +- Xbox Series S/X +- External USB Drive +- Majoras Mask (US) n64 rom + +### Install Zelda 64 Recompiled: +1. Download the **recomp_1.2.0.0_x64.msixbundle** +2. Install the MSIX package using the **Dev Portal**: + - `recomp_1.2.0.0_x64.msixbundle` + +### External Drive Setup +1. Create a folder named `Majoras Mask` +2. Place your **Majora’s Mask ROM** inside (must be the US version) + - Supported format: `.n64` + +### First-Time Setup in App: +- Launch **recomp** +- Choose *Select rom* and choose your rom in your `Majoras Mask` folder. +- Use the on-screen menu to remap controls or adjust video settings + +### Modding +The mod database can be found **[here]()** + +--- + +*Contributor: MewLew* + diff --git a/docs/ports/zircon-guide.mdx b/docs/ports/zircon-guide.mdx new file mode 100644 index 0000000..6f9ce2b --- /dev/null +++ b/docs/ports/zircon-guide.mdx @@ -0,0 +1,56 @@ +--- +title: "Zircon (Quake) Guide" +sidebar_position: 52 +description: "A guide for setting up Zircon (Quake) on dev mode." +tags: + - guides + - ports + - xbox +slug: zircon-guide +--- + + +### Requirements +- **Xbox Series S/X**. +- **External Drive** - Required to store your game file and other data. +- **Game (`id1`) file** - You must own a copy of Quake or Quake enhanced to obtain the required data files. + +### Obtaining the `id1` Folder +1. Open your Quake game directory. +2. Locate the `id1` folder. +3. Ensure the folder contains `pak0.pak` and `pak1.pak` files and a `music` folder. +4. If a `config.cfg` file is present, delete it. + +### Notes for Enhanced Release Users + +- **Important**: Avoid using the `pak0.pak` file found in the `id1` folder within the `rerelease` directory of the enhanced Quake installation. +- Instead, navigate to the root of the Quake enhanced directory. +- Locate the `id1` folder in the root directory. +- Use the `PAK0.PAK` and `PAK1.PAK` files from this folder for compatibility. +- If you want in-game music, copy the `music` folder from the `id1` directory in the `rerelease` folder to the `id1` folder on your external drive. + +### Preparing an External Drive +1. Create a folder named `quake` (use lowercase for compatibility). +2. Place the `id1` folder into the `quake` folder. + +### Modding +- Place any mod files directly into the `id1` folder within your `quake` directory on your external drive. + +### Controls +- A premade configuration is included in the `.zip` file with the following controls: + - **Left Stick**: Movement + - **Right Stick**: Camera movement + - **RT**: Shoot + - **A**: Jump + - **LB/RB**: Switch weapons +- Simply copy the `config.cfg` to your `id1` folder. + +### Additional Notes +- Two builds are provided: + - **`zircon_vsync_1.0.5.0_x64.msixbundle`**: Music works, but HDR is not supported. + - **`zircon_vsync_hdr_1.0.3.0_x64.msixbundle`**: Partial HDR support, but music does not work. + +--- + +*Contributor: MewLew* + diff --git a/docs/xbox-setup/index.mdx b/docs/xbox-setup/index.mdx new file mode 100644 index 0000000..3d7febf --- /dev/null +++ b/docs/xbox-setup/index.mdx @@ -0,0 +1,19 @@ +--- +title: Xbox Setup +description: Prepare your Xbox for Developer Mode before installing emulators or UWP builds. +sidebar_position: 1 +tags: + - xbox-setup + - dev-mode +slug: /xbox-setup +--- + +# Xbox Setup + +Use this section to put your console into **Developer Mode** and get storage, networking, and the device portal ready. Most emulator and port guides assume this is done first. + +## Main guide + +- **[Xbox Developer Mode setup](/docs/xbox-setup/xbox-developer-mode-setup)** - activating Dev Mode, retail vs dev, USB permissions, Remote Access basics + +After setup is stable, jump to **[Emulation guides](/docs/emulation)**, **[Frontends](/docs/frontends)**, or **Native ports & engines** from the sidebar. diff --git a/docs/xbox-setup/xbox-developer-mode-setup.mdx b/docs/xbox-setup/xbox-developer-mode-setup.mdx index ccc8023..05d50a8 100644 --- a/docs/xbox-setup/xbox-developer-mode-setup.mdx +++ b/docs/xbox-setup/xbox-developer-mode-setup.mdx @@ -1,7 +1,8 @@ --- -sidebar_position: 5 +sidebar_position: 2 title: Xbox Developer Mode Setup Guide description: Complete guide for setting up Xbox Developer Mode for emulation and homebrew development +slug: xbox-developer-mode-setup --- # Xbox Developer Mode Setup Guide diff --git a/package.json b/package.json index 2f09b0e..13d72a4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "devmodewiki", - "version": "1.0.1", + "version": "1.1.0", "private": false, "scripts": { "docusaurus": "docusaurus", diff --git a/sidebars.js b/sidebars.js index 1c49632..46de6a4 100644 --- a/sidebars.js +++ b/sidebars.js @@ -27,58 +27,37 @@ const sidebars = { { type: 'category', label: 'Xbox Setup', - items: [ - 'xbox-setup/xbox-developer-mode-setup', - ], + items: [{type: 'autogenerated', dirName: 'xbox-setup'}], }, { type: 'category', label: 'Emulation Guides', - items: [ - 'emulation/index', - 'emulation/chonkystation3-guide', - 'emulation/dolphin-guide', - 'emulation/panda3ds-guide', - 'emulation/ppsspp-guide', - 'emulation/retroarch-guide', - 'emulation/touchhle-guide', - 'emulation/xbsx2-guide', - 'emulation/flycast-guide', - ], + items: [{type: 'autogenerated', dirName: 'emulation'}], }, { type: 'category', - label: 'App Guides', - items: [ - 'apps/boxedwine-guide', - 'apps/gzdoom-guide', - 'apps/launchpass-guide', - 'apps/razeuwp-guide', - 'apps/sonic-adventure-blast2-uwp', - 'apps/sonic-unleashed-recompiled', - ], + label: 'Experimental Ports', + items: [{type: 'autogenerated', dirName: 'experimental'}], + }, + { + type: 'category', + label: 'Frontends', + items: [{type: 'autogenerated', dirName: 'frontends'}], + }, + { + type: 'category', + label: 'Native ports & engines', + items: [{type: 'autogenerated', dirName: 'ports'}], }, { type: 'category', label: 'Development Guides', - items: [ - 'development/index', - 'development/compiling-xbsx2-guide', - 'development/compiling-dolphin-guide', - 'development/compiling-xenia-guide', - 'development/compiling-mesa-guide', - ], + items: [{type: 'autogenerated', dirName: 'development'}], }, { type: 'category', label: 'Helpful Links', - items: [ - 'helpful-links/index', - 'helpful-links/xbox-uwp-development', - 'helpful-links/visual-studio-2022-setup', - 'helpful-links/visual-studio-2026-setup', - 'helpful-links/worleydls-uwp-porting-notes', - ], + items: [{type: 'autogenerated', dirName: 'helpful-links'}], }, ], };