/Cxbx-Reloaded

Xbox (Original) Emulator

Primary LanguageC++GNU General Public License v2.0GPL-2.0

Cxbx-Reloaded - Original Xbox Emulator

License: GPL v2 AppVeyor Gitter

Cxbx-Reloaded is an emulator for running Microsoft Xbox (and eventually, Chihiro) games on Microsoft Windows.

The project began its life as a fork of Cxbx, with added 64-bit support. Work is currently underway to backport some of the improvements made from Dxbx.

Cxbx-Reloaded is early in development and still pretty unstable, so don't expect it to run much at this stage.

System Requirements

Minimum

  • OS: Windows 7 64-bit or newer. 32-bit installations are not supported.
  • Video card: anything that supports Direct3D 8.

Prerequisites

  • Visual C++ 2015 and 2017 redistributables may be required. Download them here.

Automated Builds

Cxbx-Reloaded is not yet ready for general release, but the latest development build can always be downloaded from our AppVeyor (navigate to Configuration: Release => Artifacts => export\Release.zip). Also, a history of AppVeyor builds is available here.

Compatibility

Cxbx-Reloaded has a separate compatibility list. If you have something to report on a title, please create or update the issue for it over there. (Please, read the Read-me file first!)

Bug Reports

As Cxbx-Reloaded is in early stages of development right now, most software will either crash or do nothing. Please do not submit issues for this.

Software that actually does something (for example, it outputs graphics or audio before crashing), can be reported in the compatibility list.

For emulation issues that are suspected to be generic (NOT specific to any single piece of software), a bug report can be submitted at the Cxbx-Reloaded issue tracker.

Make sure bug reports contains the build tested with, error message displayed (if any), screenshots, an Xbe dump (created via [Edit -> Dump Xbe Info To -> File]), and a Kernel Debug file (created when running a game when [View -> Debug Output (Kernel) -> File] is selected).

Additional information

Cxbx-Reloaded has a wiki containing various subjects and background information. Chat on Gitter or Discord. You can find a screenshot gallery at imgur.

Contributing

We welcome contributions, large and small. If you want to do some coding, be sure to read the 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.

Prerequisites

  1. Git for Windows
  2. Visual Studio 2017 (2015 should work, but is not officially supported)
  3. Windows 8.1 SDK (Should be included with Visual Studio)
  4. Microsoft Child Process Debugging Power Tool

Fetching the code

Run the following command on the command line. git clone --recursive https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/

Please note that --recursive parameter: This is required to fetch sub-modules 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 --recursive

Compiling

Simply open build/Win32/Cxbx.sln within Visual Studio, select your configuration (Release or Debug) and hit Build. Please note that Debug builds are significantly slower, but do include much more detailed kernel logging, so these may help diagnose a problematic title.

Support

You can support Luke Usher (initiator of Cxbx-Reloaded) on Patreon.

Special Thanks

All contributors to the original Cxbx and Dxbx projects, without which Cxbx-Reloaded would not exist at all.