ShuriZma
/
Cxbx-Reloaded
mirror of https://github.com/Cxbx-Reloaded/Cxbx-Reloaded.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Cxbx-Reloaded/README.md

109 lines
6.0 KiB
Markdown
Raw Normal View History

README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
# Cxbx-Reloaded - Original Xbox Emulator
Update README.md to add license build and chat badges
2017-03-13 16:07:07 +00:00
[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://img.shields.io/badge/License-GPL%20v2-blue.svg)
hotfix github badge
2020-04-08 16:38:10 +00:00
[![GitHub Actions](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/workflows/GitHub%20CI/badge.svg)](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/actions)
Update README.md to add license build and chat badges
2017-03-13 16:07:07 +00:00
[![AppVeyor](https://ci.appveyor.com/api/projects/status/iao43irxl3umbp33?svg=true)](https://ci.appveyor.com/project/SoullessSentinel/cxbx-reloaded)
Set up CI with Azure Pipelines
2019-08-20 12:24:33 +00:00
[![Azure](https://Cxbx-Reloaded.visualstudio.com/Cxbx-Reloaded/_apis/build/status/Cxbx-Reloaded.Cxbx-Reloaded?branchName=develop)](https://Cxbx-Reloaded.visualstudio.com/Cxbx-Reloaded/_build/latest?definitionId=7&branchName=develop)
Activate Travis CI
2019-08-23 07:51:07 +00:00
[![Travis](https://travis-ci.org/Cxbx-Reloaded/Cxbx-Reloaded.svg?branch=develop)](https://travis-ci.org/Cxbx-Reloaded/Cxbx-Reloaded)
Oops
2018-07-24 18:33:04 +00:00
[![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?logo=discord)](https://discord.gg/26Xjx23)
Create README.md
2016-08-24 19:55:47 +00:00
Update README.md
2016-09-09 20:44:08 +00:00
Cxbx-Reloaded is an emulator for running Microsoft Xbox (and eventually, Chihiro) games on Microsoft Windows.
Create README.md
2016-08-24 19:55:47 +00:00
Update README.md
2016-09-09 20:44:08 +00:00
## System Requirements
Update README.md (#544) * Update README.md README.md cleanup. * Couple of changes Small Bug Reports rewrite.
2017-07-30 09:13:10 +00:00
### Minimum
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
* OS: Windows 7+ x64. 32-bit is not supported.
* GPU: Direct3D 9.0c with Pixel Shader Model 2.x, and Vertex Shader Model 3.0.
Updated readme Changed Direct3D 8 into Direct3D 9 Removed d3d8to9 mention
2018-09-02 06:22:48 +00:00
Add prerequisites needed to run to README (#558) * Add prerequisites needed to run to README
2017-07-31 08:01:48 +00:00
### Prerequisites
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
* [32-bit (x86) Visual C++ 2019 Redistributable](https://aka.ms/vs/16/release/vc_redist.x86.exe)
* [Npcap *(used for network emulation)*](https://nmap.org/npcap/#download)
* Make sure to enable winpcap compatibility mode!
update README.md for CMake usage
2019-05-13 22:06:13 +00:00
Update README.md
2017-03-22 09:11:25 +00:00
## Automated Builds
Update README to better present AppVeyor links
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:
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
* **[Latest Development Build](https://ci.appveyor.com/api/projects/SoullessSentinel/cxbx-reloaded/artifacts/Release.zip?branch=develop&job=Configuration:%20Release&pr=false)**
Update README to better present AppVeyor links
2018-06-18 07:24:45 +00:00
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
* *[Full build history](https://ci.appveyor.com/project/SoullessSentinel/cxbx-reloaded/history)*
Update README.md
2017-03-22 09:11:25 +00:00
Update README.md (#536) Added compatibility link
2017-07-28 05:18:12 +00:00
## Compatibility
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
Cxbx-Reloaded has a [compatibility list](https://github.com/Cxbx-Reloaded/game-compatibility#cxbx-reloaded-game-compatibility-project).
Update README.md --recursive is deprecated. Formatting. Fix small error in 'Fetching the code' section. Removed screenshot gallery as it's now outdated.
2018-04-28 02:03:19 +00:00
Update README.md
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.
Update README.md --recursive is deprecated. Formatting. Fix small error in 'Fetching the code' section. Removed screenshot gallery as it's now outdated.
2018-04-28 02:03:19 +00:00
Update README.md
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!
Update README.md (#536) Added compatibility link
2017-07-28 05:18:12 +00:00
Update README.md
2016-09-30 07:33:33 +00:00
## Bug Reports
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
Game or software specific issues can be reported in the [compatibility list](https://github.com/Cxbx-Reloaded/game-compatibility#cxbx-reloaded-game-compatibility-project).
Separated compatibility issues from emulation issues
2017-08-15 12:23:28 +00:00
Update README.md
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).
Separated compatibility issues from emulation issues
2017-08-15 12:23:28 +00:00
Update README.md
2018-05-16 09:12:03 +00:00
Make sure bug reports contain:
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
* The build tested with, error message displayed (if any)
* Screenshots
* 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).
Update README.md
2016-09-30 07:33:33 +00:00
Readme updates (#581) README updates
2017-08-02 13:07:37 +00:00
## Additional information
Update README.md --recursive is deprecated. Formatting. Fix small error in 'Fetching the code' section. Removed screenshot gallery as it's now outdated.
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.
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
Removed Gitter Link from Readme The community has migrated over to Discord and Gitter has not been used for a very long time now.
2019-07-23 07:44:10 +00:00
Chat on [Discord](https://discord.gg/26Xjx23).
Update README.md
2016-09-09 20:44:08 +00:00
Added contributing details and a link to Developer notes.
2017-08-25 14:55:38 +00:00
## Contributing
Update README.md --recursive is deprecated. Formatting. Fix small error in 'Fetching the code' section. Removed screenshot gallery as it's now outdated.
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).
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
**IMPORTANT: Pull-Requests containing code derived from XQEMU will _not_ be approved until an agreement is reached to make work mutually beneficial. this includes updates to existing XQEMU derived code. We should not/will not become a hostile fork.**
Add note about xqemu derived code.
2019-02-05 20:59:39 +00:00
Update README.md --recursive is deprecated. Formatting. Fix small error in 'Fetching the code' section. Removed screenshot gallery as it's now outdated.
2018-04-28 02:03:19 +00:00
Please contact us before you start working on something, so we can make sure your work is going to be accepted once finished.
Added contributing details and a link to Developer notes.
2017-08-25 14:55:38 +00:00
update README.md for CMake usage
2019-05-13 22:06:13 +00:00
### Main Prerequisites
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
1. [Git for Windows](https://git-scm.com)
2. [CMake](https://cmake.org)
* Some IDEs already have CMake support, so this is optional.
Add simple compilation instructions to Readme.md
2017-12-02 10:42:06 +00:00
### Fetching the code
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
1. Run the following command in the command line:
Add simple compilation instructions to Readme.md
2017-12-02 10:42:06 +00:00
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
`git clone --recurse-submodules https://github.com/Cxbx-Reloaded/Cxbx-Reloaded.git`
* Please note the `--recurse-submodules` parameter. This is required to fetch submodules.
* If Cxbx-Reloaded was checked out without submodules, they can be updated/fetched with the following command:
Update README.md --recursive is deprecated. Formatting. Fix small error in 'Fetching the code' section. Removed screenshot gallery as it's now outdated.
2018-04-28 02:03:19 +00:00
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
`git submodule update --init --recursive`
Add simple compilation instructions to Readme.md
2017-12-02 10:42:06 +00:00
### Compiling
update README.md for CMake usage
2019-05-13 22:06:13 +00:00
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
#### Windows
**NOTE:** Don't open `CMakeLists.txt` from Visual Studio, as it won't generate files in the `build` directory.
##### Prerequisites
1. [Visual Studio](https://visualstudio.microsoft.com/downloads/) 2017 or later
* C++ and C# desktop development
* Windows Universal CRT SDK
* C++ CMake tools for Windows
* *Optional if CMake is installed*
* [Microsoft Child Process Debugging Power Tool](https://marketplace.visualstudio.com/items?itemName=vsdbgplat.MicrosoftChildProcessDebuggingPowerTool)
##### Generate Visual Studio files
1. If you don't have CMake installed, open `___ Native Tools Command Prompt for VS 20##`.
2. `cd` to the Cxbx-Reloaded directory.
3. Run these commands.
1. `mkdir build & cd build`
2. `cmake .. -G "Visual Studio 16 2019" -A Win32`
fix CMake version typo
2020-03-21 20:38:50 +00:00
* Visual Studio 2019 16.1 or later has CMake 3.14 bundled, and is required for the Visual Studio 2019 generator.
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
* Use `cmake .. -G "Visual Studio 15 2017" -A Win32` for Visual Studio 2017.
4. Open `Cxbx-Reloaded.sln` from the `build` directory.
5. Select the Release configuration, then click Build.
* Debug builds are **significantly slower, and only for developers**.
#### Linux / macOS
Currently not supported.
Add simple compilation instructions to Readme.md
2017-12-02 10:42:06 +00:00
Added Patreon link
2017-06-24 16:46:33 +00:00
## Support
Update README.md --recursive is deprecated. Formatting. Fix small error in 'Fetching the code' section. Removed screenshot gallery as it's now outdated.
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).
Added Patreon link
2017-06-24 16:46:33 +00:00
Update README.md
2016-09-09 20:44:08 +00:00
## Special Thanks
Switch to Visual Studio 2019 in README.md Also minor grammar fixes, style changes, and made Dxbx into a link.
2019-05-25 17:25:20 +00:00
* All contributors to the original Cxbx and [Dxbx](https://github.com/PatrickvL/Dxbx) projects. Without them Cxbx-Reloaded would not exist at all.
README improvements (#1838) README improvements Deleted trailing whitespace. Raised minimum GPU requirements, and removed LLE GPU since it's disabled. Make links more direct, and update outdated links. Removed redundant Development Builds header. Link to readme instead of directly to compatibility issues so people read the readme. Move Compiling note where it makes more sense. Seperated/formatted building steps and made them less confusing. Grammar/spelling fixes.
2020-03-20 10:16:26 +00:00
* [XQEMU](https://github.com/xqemu/xqemu) - While the majority of Cxbx-R is our own work (Kernel, HLE, etc), the NV2A LLE and NVNet implementation are primarily the work of the XQEMU developers.
* [XboxDev](https://github.com/xboxdev) - Providing Xbox hardware research & useful tooling.