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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions docs/experimental/nxbox-guide.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
sidebar_position: 4
title: NXbox Guide
description: A guide for installing and using NXbox, an experimental Nintendo Switch emulator for Xbox Series consoles.
tags:
- emulation
- switch
- uwp
- experimental
slug: nxbox-guide
---

NXbox is an experimental Nintendo Switch emulator for Xbox Series consoles in Developer Mode.

### Installation

1. Make sure your Xbox Series X is in Developer Mode.
2. Download the `.appx` from the [latest NXbox release](https://github.com/NspxMiguel/NXbox/releases/latest).
3. In Device Portal, open **My games & apps → Add**.
4. Upload the `.appx` and select **Start**.
5. Once installed, open Dev Home, select NXbox → **View details**, and set **App type** to **Game**.

### Keys and Game Setup

1. Launch NXbox once to generate its folders, then close it.
2. In Device Portal, open **File explorer** → `LocalAppData` → NXbox package → `LocalState`.
3. Upload your `prod.keys` and `title.keys` to `LocalState\eden\keys`.
4. Upload your games to `LocalState\games`.
5. If required, upload your firmware files to `LocalState\firmware`.
6. Launch NXbox and select your game from the library.

Supported game formats include `.nsp`, `.nsz` and `.xci`. Some games, such as Mario Kart 8 Deluxe, may also require firmware dumped from your own console.

Internal developer storage is limited, so larger games can be stored on a USB drive in an `E:\NXbox\games` folder.

### Settings and Tips

- **Renderer:** Direct3D 12 is the default. To use the older OpenGL renderer, add `renderer_backend=0` to `LocalState\eden_settings.txt`.
- **Standalone apps:** [NXbox Pack](https://github.com/NspxMiguel/NXbox/tree/main/tools/nxbox-pack) packages games you own as individual Xbox apps that launch directly into the game. Available for Windows, macOS and Linux.
- **Updates:** NXbox checks its GitHub releases and updates itself.
- **Crash reports:** If you encounter a crash, attach `LocalState\nxbox_crash.txt` when [reporting an issue](https://github.com/NspxMiguel/NXbox/issues).

### Compatibility

The full compatibility table is available in the [NXbox README](https://github.com/NspxMiguel/NXbox#compatibility).

---

*Contributor: NspxMiguel*
2 changes: 1 addition & 1 deletion docs/experimental/sm64hd-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "SM64HD Fan Remake (Super Mario 64) Guide"
sidebar_position: 4
sidebar_position: 5
description: "A guide for setting up SM64HD Fan Remake (Super Mario 64) on dev mode."
tags:
- guides
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/ports/open-ce.mdx → docs/ports/opence-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ tags:
- xbox
- ports
- uwp
slug: open-ce
slug: opence-guide
---

Based on OpenCE PC build 155.
Expand Down
75 changes: 75 additions & 0 deletions docs/ports/warthog-guide.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: Warthog UWP
sidebar_position: 72
description: Warthog UWP for Xbox Dev Mode.
tags:
- xbox
- ports
- uwp
slug: warthog-guide
---

### Installation

1. Make sure your Xbox is in Dev Mode.
2. Open Xbox Device Portal on your computer.
3. Open **Home → Add**.
4. Upload `Warthog-UWP-x64.appx`.
5. Finish the installation.
6. Set Warthog as a **Game** in Dev Mode.
7. Launch Warthog.

### Internal Storage Setup

1. Launch Warthog once to create the `Developmentfiles/Warthog` folder.
2. Place your Halo ISO or XISO in the app's `Developmentfiles/Warthog` folder.
3. Launch Warthog. Your game should appear in the list.
4. Select the ISO or XISO.
5. Wait for extraction to reach 100%.

The extracted game files, saves, profiles, settings, and cache are stored in `Developmentfiles/Warthog`.

Future updates will not overwrite the game files, so you will not need to reinstall your game after updating Warthog.

### External Storage Setup

1. Connect a USB storage drive to the Xbox.
2. Place your Halo ISO or XISO on the USB drive.
3. Launch Warthog and select **External**.
4. Browse to and select the ISO or XISO.
5. Warthog will create an `Warthog` folder on the drive.
6. Wait for extraction to reach 100%.

Keep the USB drive connected when using Warthog. Saves, profiles, settings, cache, and game files are stored inside the external `Warthog` folder.

### Custom Maps

Place custom map files directly inside the `custom_maps` folder.

#### Internal Storage

`Developmentfiles\Warthog\custom_maps`

#### External Storage

`USB:\Warthog\custom_maps`

Copy the loose `.map` files into the folder. Do not copy the downloaded map's enclosing folder.

Halo Custom Edition maps also require these three Halo Custom Edition resource maps in the same `custom_maps` folder:

- `bitmaps.map`
- `sounds.map`
- `loc.map`

Maps requiring OpenSauce are not supported.

### Tips

1. Warthog stores cache data, so you may experience stutters when loading something for the first time. This should quickly improve as the cache builds.

Wort, Wort, Wort.

---

*Contributor: ReviveMe*
2 changes: 1 addition & 1 deletion docs/ports/zelda3-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Zelda 3 Guide"
sidebar_position: 72
sidebar_position: 73
description: "A guide for setting up Zelda 3 on dev mode."
tags:
- guides
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/zelda64-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Zelda 64 Recompiled Guide"
sidebar_position: 73
sidebar_position: 74
description: "A guide for setting up Zelda 64 Recompiled on dev mode."
tags:
- guides
Expand Down
2 changes: 1 addition & 1 deletion docs/ports/zircon-guide.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Zircon (Quake) Guide"
sidebar_position: 74
sidebar_position: 75
description: "A guide for setting up Zircon (Quake) on dev mode."
tags:
- guides
Expand Down
Loading