Cxbx-Reloaded/README.md

44 lines
3.2 KiB
Markdown
Raw Normal View History

# Cxbx-Reloaded - Original Xbox Emulator
[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://img.shields.io/badge/License-GPL%20v2-blue.svg)
[![AppVeyor](https://ci.appveyor.com/api/projects/status/iao43irxl3umbp33?svg=true)](https://ci.appveyor.com/project/SoullessSentinel/cxbx-reloaded)
[![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/Cxbx-Reloaded/Lobby)
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
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.
2016-09-09 20:44:08 +00:00
Cxbx-Reloaded is early in development and still pretty unstable, so don't expect it to run much at this stage.
2016-09-09 20:44:08 +00:00
## 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](https://support.microsoft.com/en-gb/help/2977003/the-latest-supported-visual-c-downloads).
2017-03-22 09:11:25 +00:00
## Automated Builds
Cxbx-Reloaded is not yet ready for general release, but the latest development build can always be downloaded from our [AppVeyor](https://ci.appveyor.com/project/SoullessSentinel/cxbx-reloaded/branch/master) (navigate to Configuration: Release => Artifacts => export\Release.zip).
2017-03-22 09:11:25 +00:00
## Compatibility
Cxbx-Reloaded has a separate [compatibility list](https://github.com/Cxbx-Reloaded/game-compatibility/issues). 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](https://github.com/Cxbx-Reloaded/game-compatibility/blob/master/README.md) first!)
2016-09-30 07:33:33 +00:00
## 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.
2016-09-30 07:33:33 +00:00
Software that actually does something (for example, it outputs graphics or audio before crashing), can be reported in the [compatibility list](https://github.com/Cxbx-Reloaded/game-compatibility/issues).
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](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/issues).
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).
2016-09-30 07:33:33 +00:00
2017-08-02 13:07:37 +00:00
## Additional information
2017-08-02 13:11:40 +00:00
Cxbx-Reloaded has a [wiki](http://github.com/Cxbx-Reloaded/Cxbx-Reloaded/wiki) containing various subjects and background information.
2017-08-02 13:07:37 +00:00
Chat on [Gitter](https://gitter.im/Cxbx-Reloaded/Lobby) or [Discord](https://discord.gg/26Xjx23).
You can find a screenshot gallery at [imgur](http://imgur.com/a/Bzvti).
2016-09-09 20:44:08 +00:00
2017-06-24 16:46:33 +00:00
## Support
2017-08-02 13:46:36 +00:00
You can support Luke Usher (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
All contributers to the original Cxbx and Dxbx projects, without which Cxbx-Reloaded would not exist at all.