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

118 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)
readme: update to focus only on push events than include pull requests
2020-08-25 07:12:22 +00:00
[![GitHub Actions](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/workflows/GitHub%20CI/badge.svg?event=push)](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/actions?query=event%3Apush+workflow%3A%22GitHub+CI%22)
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
One more Wine-related edit Somehow I missed the very first line of the readme, which also makes it sound Windows-exclusive, in my last PR. Sorry for the spam.
2020-05-07 20:52:51 +00:00
Cxbx-Reloaded is an emulator for running Microsoft Xbox (and eventually, Chihiro) games on Microsoft Windows and Wine.
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
Mention Wine support more prominently in the readme Right now the first mention of Wine is down next to the download link, and no mention is made of it under the system requirements. Given that compatibility with Wine has been a goal for this project in the past (in terms of bugfixes that fixed issues that only emerged when using it), I thought it would be a good idea to show that this use case is indeed considered by the developers. As a Linux user myself, this kind of thing would be more likely to consider using Cxbx after glancing at the repository.
2020-05-07 20:40:21 +00:00
* OS: Windows 7+ x64, or x86-64 Linux with Wine. 32-bit is not supported.
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
* 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 notice + fix header
2021-02-02 11:14:48 +00:00
## Prerequisites
### Windows
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
add notice + fix header
2021-02-02 11:14:48 +00:00
### Wine
review remark
2021-02-02 12:31:42 +00:00
**NOTICE: Please use the latest stable release version of Wine. If it does not work for you, then roll back to Wine 5.0.3 which is the last known working version.**
update prerequisites section
2021-02-02 10:59:05 +00:00
* Winetricks
* `vcrun2017` or `vcrun2019`
review remark
2021-02-02 12:31:42 +00:00
* NOTE: vcrun2019 requires the latest winetricks script!
update prerequisites section
2021-02-02 10:59:05 +00:00
* `d3dcompiler_47`
review remark
2021-02-02 12:31:42 +00:00
* NOTE: May be subject to change over time.
* Winpcap is built-in, no installation is required.
update prerequisites section
2021-02-02 10:59:05 +00:00
add notice + fix header
2021-02-02 11:14:48 +00:00
Update README.md
2017-03-22 09:11:25 +00:00
## Automated Builds
redirect users to releases page
2020-04-09 07:52:12 +00:00
Cxbx-Reloaded doesn't currently have stable builds, but you can obtain pre-release builds from the Releases tab, or the links below:
Update README to better present AppVeyor links
2018-06-18 07:24:45 +00:00
redirect users to releases page
2020-04-09 07:52:12 +00:00
* **[Release Builds](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/releases)**
Mention Wine support more prominently in the readme Right now the first mention of Wine is down next to the download link, and no mention is made of it under the system requirements. Given that compatibility with Wine has been a goal for this project in the past (in terms of bugfixes that fixed issues that only emerged when using it), I thought it would be a good idea to show that this use case is indeed considered by the developers. As a Linux user myself, this kind of thing would be more likely to consider using Cxbx after glancing at the repository.
2020-05-07 20:40:21 +00:00
* **Wine users will need to use `CxbxReloaded-Release-VS2017.zip` for it to run correctly.**
redirect users to releases page
2020-04-09 07:52:12 +00:00
* *[Full build history](https://github.com/Cxbx-Reloaded/Cxbx-Reloaded/actions?query=workflow%3A%22GitHub+CI%22)*
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
Update Readme.md: Link to Compatibility website
2021-01-12 15:39:45 +00:00
Cxbx-Reloaded has a [compatibility list](https://cxbx-reloaded.co.uk/compatibility).
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: Link to Compatibility website
2021-01-12 15:39:45 +00:00
If you would like to submit compatibility reports, please request permission in our Discord server.
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
Update Readme.md: Link to Compatibility website
2021-01-12 15:39:45 +00:00
Game or software specific issues can be reported in the [compatibility website](https://cxbx-reloaded.co.uk/compatibility).
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
readme: update bug report section
2020-08-26 22:37:04 +00:00
Make sure to follow the issue template and that it contains:
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)
readme: update bug report section
2020-08-26 22:37:04 +00:00
* **(You can copy and paste any popup messages. However, please keep it clean by paste and trimming down to only the message itself.)**
* Screenshots
* (optional unless has any graphic bug for references)
**NOTICE: Failure to follow template will auto close your ticket.**
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: fix grammars
2020-08-27 21:31:12 +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)
readme: fix grammars
2020-08-27 21:31:12 +00:00
* Some IDEs already have CMake support, 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.