2017-07-30 09:13:10 +00:00
# Cxbx-Reloaded - Original Xbox Emulator
2017-03-13 16:07:07 +00:00
[](https://img.shields.io/badge/License-GPL%20v2-blue.svg)
[](https://ci.appveyor.com/project/SoullessSentinel/cxbx-reloaded)
[](https://gitter.im/Cxbx-Reloaded/Lobby)
2018-07-24 18:33:04 +00:00
[](https://discord.gg/26Xjx23)
2016-08-24 19:55:47 +00:00
2016-09-09 20:44:08 +00:00
Cxbx-Reloaded is an emulator for running Microsoft Xbox (and eventually, Chihiro) games on Microsoft Windows.
2016-08-24 19:55:47 +00:00
2016-09-09 20:44:08 +00:00
## System Requirements
2017-07-30 09:13:10 +00:00
### Minimum
2018-05-16 09:12:03 +00:00
* OS: Windows 7+ x64. 32-bit installations are not supported.
2018-09-02 06:22:48 +00:00
* GPU: Anything that supports Direct3D 9 (HLE) and OpenGL 3.3 (LLE).
2017-07-31 08:01:48 +00:00
### Prerequisites
2018-12-06 13:19:56 +00:00
* Visual C++ 2015 and 2017 redistributables are required. Most people should already have these, but if not, Download them [here ](https://support.microsoft.com/en-gb/help/2977003/the-latest-supported-visual-c-downloads ). Make sure to install the 32-bit version even if you are on a 64-bit machine, as the 64-bit build does not include both!
2017-07-30 09:13:10 +00:00
2017-03-22 09:11:25 +00:00
## Automated Builds
2018-06-18 07:24:45 +00:00
Cxbx-Reloaded is not yet ready for general release, but the latest development builds can be downloaded using the links below:
### Latest Stable
Grab these if you just want to use the emulator to play games.
2018-09-06 07:12:46 +00:00
* [Latest Stable Build ](https://ci.appveyor.com/api/projects/SoullessSentinel/cxbx-reloaded/artifacts/export/Release.zip?branch=master&job=Configuration:%20Release&pr=false )
2018-06-18 07:24:45 +00:00
### Development Builds
Grab these builds if you want to test the latest and greatest features. These builds are likely to be more unstable than release builds, and are not recommended for just playing games.
2018-09-06 07:12:46 +00:00
* [Latest Development Build ](https://ci.appveyor.com/api/projects/SoullessSentinel/cxbx-reloaded/artifacts/export/Release.zip?branch=develop&job=Configuration:%20Release&pr=false )
2018-06-18 07:24:45 +00:00
2018-02-14 20:13:30 +00:00
* [Full build history ](https://ci.appveyor.com/project/SoullessSentinel/cxbx-reloaded/history )
2017-03-22 09:11:25 +00:00
2017-07-28 05:18:12 +00:00
## Compatibility
2018-05-16 09:12:03 +00:00
Cxbx-Reloaded has a [compatibility list ](https://github.com/Cxbx-Reloaded/game-compatibility/issues ).
2018-04-28 02:03:19 +00:00
2018-05-16 09:12:03 +00:00
If you have something to report on a title, please create or update the issue for it there.
2018-04-28 02:03:19 +00:00
2018-05-16 09:12:03 +00:00
Please read the [Readme file ](https://github.com/Cxbx-Reloaded/game-compatibility/blob/master/README.md ) first!
2017-07-28 05:18:12 +00:00
2016-09-30 07:33:33 +00:00
## Bug Reports
2018-03-05 05:14:56 +00:00
Game or software specific issues can be reported in the [compatibility list ](https://github.com/Cxbx-Reloaded/game-compatibility/issues ).
2017-08-15 12:23:28 +00:00
2018-05-16 09:12:03 +00:00
For emulation issues that are not specific to any single piece of software, a bug report can be submitted at [the Cxbx-Reloaded issue tracker ](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/issues ).
2017-08-15 12:23:28 +00:00
2018-05-16 09:12:03 +00:00
Make sure bug reports contain:
2018-04-28 02:03:19 +00:00
* The build tested with, error message displayed (if any)
* Screenshots
2018-05-16 09:12:03 +00:00
* Xbe dump (created via [Edit > Dump Xbe Info To > File])
* Kernel Debug log (created when running a game with [View > Debug Output (Kernel) > File] selected).
2016-09-30 07:33:33 +00:00
2017-08-02 13:07:37 +00:00
## Additional information
2018-04-28 02:03:19 +00:00
Cxbx-Reloaded has a [wiki ](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/wiki ) containing various subjects and background information.
Chat on [Gitter ](https://gitter.im/Cxbx-Reloaded/Lobby ), or [Discord ](https://discord.gg/26Xjx23 ).
2016-09-09 20:44:08 +00:00
2017-08-25 14:55:38 +00:00
## Contributing
2018-04-28 02:03:19 +00:00
We welcome contributions, large and small.
If you want to do some coding, be sure to read the [Developer notes ](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/wiki/Developer-notes ).
Please contact us before you start working on something, so we can make sure your work is going to be accepted once finished.
2017-08-25 14:55:38 +00:00
2017-12-02 10:42:06 +00:00
### Prerequisites
2017-12-02 10:44:45 +00:00
1. [Git for Windows ](https://git-scm.com/ )
2018-04-28 02:03:19 +00:00
2. [Visual Studio 2017 ](https://www.visualstudio.com/downloads/ ) (2015 might work, but is not officially supported)
2017-12-02 10:44:45 +00:00
3. Windows 8.1 SDK (Should be included with Visual Studio)
4. [Microsoft Child Process Debugging Power Tool ](https://marketplace.visualstudio.com/items?itemName=GreggMiskelly.MicrosoftChildProcessDebuggingPowerTool )
2017-12-02 10:42:06 +00:00
### Fetching the code
2018-05-16 09:12:03 +00:00
Run the following command on the command line:
2018-04-28 02:03:19 +00:00
`git clone --recurse-submodules https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/`
Please note the `--recurse-submodules` parameter. This is required to fetch sub-modules.
2017-12-02 10:42:06 +00:00
2018-04-28 02:03:19 +00:00
Without this, Cxbx-Reloaded will fail to build.
If Cxbx-Reloaded was previously checked out without the submodules, they can be updated/fetched with the following command:
`git submodule update --recurse-submodules`
2017-12-02 10:42:06 +00:00
### Compiling
Simply open `build/Win32/Cxbx.sln` within Visual Studio, select your configuration (Release or Debug) and hit Build.
2018-04-28 02:03:19 +00:00
2018-05-16 09:12:03 +00:00
Please note that Debug builds are significantly slower, but include much more detailed kernel logging, and may help diagnose a problematic title.
2017-12-02 10:42:06 +00:00
2017-06-24 16:46:33 +00:00
## Support
2018-04-28 02:03:19 +00:00
You can support [Luke Usher ](https://github.com/LukeUsher ), initiator of Cxbx-Reloaded, on [Patreon ](https://www.patreon.com/LukeUsher ).
2017-06-24 16:46:33 +00:00
2016-09-09 20:44:08 +00:00
## Special Thanks
2019-02-05 20:13:36 +00:00
* All contributors to the original Cxbx and Dxbx projects. Without them Cxbx-Reloaded would not exist at all.
* [XQEMU ](https://github.com/xqemu/xqemu ) - While the majority of Cxbx-R is our own work (Kernel, HLE, etc), the NV2A LLE implementation is primarily the work of the XQEMU developers.
* [XboxDev ](https://github.com/xboxdev/ ) - Providing Xbox Hardware Research & Useful Toling
