Skip to content
Open
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
9 changes: 6 additions & 3 deletions .vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default withPwa(defineConfig({
],
server: {
host: '0.0.0.0',
port: 80,
port: 8000,
}
},
title: title,
Expand All @@ -39,6 +39,7 @@ export default withPwa(defineConfig({
siteTitle: "WinDurango",
nav: [
{ text: 'Home', link: '/' },
{ text: 'Running', link: '/running-a-game' },
{ text: 'Setup', link: '/build-contrib' },
{ text: 'Team', link: '/team' },
],
Expand All @@ -48,11 +49,13 @@ export default withPwa(defineConfig({
},

sidebar: generateSidebar({
sortFolderTo: "top",
sortFolderTo: "bottom",
documentRootPath: "/docs",
sortMenusByFrontmatterOrder: true,
sortMenusOrderByDescending: true,
collapsed: true,
capitalizeEachWords: true,
rootGroupText: 'Main',
rootGroupText: '',
hyphenToSpace: true,
includeEmptyFolder: false
}),
Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ hero:
name: "WinDurango Documentation"
tagline: "Documentation for the WinDurango Xbox One Compatibility Layer."
features:
- title: Running A Game with WinDurango
link: /running-a-game.md
details: How to run a Xbox One game with WinDurango.
icon: ▶️
- title: Setup, Building, and Contributing
link: /build-contrib.md
details: How to use, build, and contribute to the project.
Expand Down
4 changes: 2 additions & 2 deletions docs/playable-games.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
| Burnout Paradise Remastered | Does not run | | |
| CHAOS;CHILD | Does not run | | |
| Cuphead | Does not run | | |
| Destiny | Does not run | | |
| Destiny | Does not run | | |
| Forza Horizon 2 | Boots | | Boots to the title menu but crashes after words must use the [Forza-Horizon-2](https://github.com/WinDurango/WinDurango/tree/Forza-Horizon-2) branch |
| Forza Horizon 2 Demo | Does not run | | |
| Forza Horizon 2 Demo | Does not run | | |
| Forza Horizon 2 F&F | Does not run | | |
| Forza Motorsport 5 | Does not run | | |
| Lego Dimensions | Does not run | | |
Expand Down
Binary file added docs/public/assets/example-mount.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
49 changes: 49 additions & 0 deletions docs/running-a-game.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Running a Game with WinDurango


WinDurango works by being added to existing Xbox One game dumps. WinDurango is not an independently running piece of software.

The process of adding WinDurango to an existing Xbox One game will add the game to your system as a
"Universal Windows Platform" (UWP) application, much like anything else you'd find on the Windows Store.


## Prerequisites


1. Windows Developer Mode is enabled in settings, see [Enable Developer Mode](/build-contrib.md#enabling-developer-mode)
2. Windows 10 (or later)
3. Install the [Windows App SDK](https://learn.microsoft.com/en-us/windows/apps/windows-app-sdk/downloads)
4. Visual Studio 2022 OR WinDbg (for debugging if needed)
a. If using Visual Studio, make sure you select the "Desktop development with C++" workload.
6. Install [Visual C++ Redistributables](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist) (install the "Latest supported" (2017-2026), 2015, 2013, and 2012 for best results)
7. Enable the Graphics Tools optional feature in Windows (from `Settings > Apps > Optional Features` (Windows 10) or `Settings > System > Optional Features` (Windows 11))
8. The latest [release](https://github.com/WinDurango/WinDurango/releases), or [artifact](https://github.com/WinDurango/WinDurango/actions/workflows/msbuild.yml)

> **Note**: If you run into errors on the latest release, try the latest artifact.


## Setting up a Game


You need to have an existing dump of an Xbox One game. A proper dump will have at least a "Mount" folder, and will likely have other folders.

Inside that "Mount" folder should be the game's main exe file.
If that is not where the exe file is, find the exe file, and use that as the "Mount" folder for the rest of these instructions.

![Example Mount Folder](assets/example-mount.png)

1. Open the "Mount" folder, and the WinDurango build you downloaded above.
2. Copy the contents of the WinDurango build into the "Mount" folder.
3. Open PowerShell to this folder (Shift + Right Click, "Open PowerShell window here")
4. Run `Add-AppXPackage -Register .\\AppxManifest.xml`


Once the registration completes, look up the name of the game in Window's search bar, and you should see it. Try running the game now.


## Troubleshooting


If the game does not work on the latest release, try the latest artifact. Same goes if you tried the artifact first to try the release instead.
If it still does not work, but it is listed to work on the [Playable Games](/playable-games.md) page, open an issue in
[GitHub](https://github.com/WinDurango/WinDurango/issues), or ask in the [Discord](https://discord.gg/mHN2BgH7MR).
3 changes: 3 additions & 0 deletions docs/team.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
order: -1
---
# Team

| PFP | Name | Role |
Expand Down