xenia-canary/README.md

79 lines
4.1 KiB
Markdown
Raw Normal View History

2019-03-10 23:03:21 +00:00
<p align="center">
2020-05-04 05:09:12 +00:00
<a href="https://github.com/xenia-canary/xenia-canary/tree/canary/assets/icon">
<img height="120px" width="120px" src="https://raw.githubusercontent.com/xenia-canary/xenia-canary/canary/assets/icon/1024.png" />
2019-03-10 23:03:21 +00:00
</a>
</p>
2020-05-04 05:09:12 +00:00
<h1 align="center">Xenia Canary - Xbox 360 Emulator</h1>
2013-01-10 23:20:45 +00:00
2020-05-04 05:09:12 +00:00
[![Discord Server](https://discordapp.com/api/guilds/533275703882547200/widget.png)](https://discord.gg/jydhhRQ)
[![Actions Status](https://github.com/xenia-canary/xenia-canary/workflows/CI/badge.svg)](https://github.com/xenia-canary/xenia-canary/actions)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/5fs0ia3031l9rbpo/branch/canary_new?svg=true)](https://ci.appveyor.com/project/chris-hawley/xenia-canary/branch/canary_new)
[![Azure Build Status](https://dev.azure.com/xenia-canary/xenia-canary/_apis/build/status/xenia-canary.xenia-canary?branchName=canary_new)](https://dev.azure.com/xenia-canary/xenia-canary/_build/latest?definitionId=1&branchName=canary_new)
<!--[![Travis Build Status](https://travis-ci.org/xenia-canary/xenia-canary.svg?branch=canary)](https://travis-ci.org/xenia-canary/xenia-canary)-->
2019-03-10 23:03:21 +00:00
2020-05-04 05:09:12 +00:00
Xenia Canary is an experimental fork of Xenia. For more information, see the
[wiki](https://github.com/xenia-canary/xenia-canary/wiki).
See current Pull Request status [here](https://github.com/xenia-canary/xenia-canary/wiki/PR-status).
2013-01-10 23:22:20 +00:00
2019-03-10 23:03:21 +00:00
**Interested in supporting the core contributors?** Visit
[Xenia Project on Patreon](https://www.patreon.com/xenia_project).
2018-11-23 18:21:21 +00:00
2020-05-04 05:09:12 +00:00
Please check the [FAQ](https://github.com/xenia-canary/xenia-canary/wiki/FAQ) page before asking questions.
We've got jobs/lives/etc, so don't expect instant answers.
2019-05-12 12:37:56 +00:00
Discussing illegal activities will get you banned.
2013-01-10 23:22:20 +00:00
2020-05-04 05:09:12 +00:00
### Disclaimer
2013-02-02 03:37:53 +00:00
The goal of this project is to experiment, research, and educate on the topic
2013-11-16 09:29:25 +00:00
of emulation of modern devices and operating systems. **It is not for enabling
illegal activity**. All information is obtained via reverse engineering of
2013-02-02 03:37:53 +00:00
legally purchased devices and games and information made public on the internet
(you'd be surprised what's indexed on Google...).
2013-01-10 23:22:20 +00:00
## Quickstart
See the [Quickstart](https://github.com/xenia-project/xenia/wiki/Quickstart) page.
2020-05-04 05:09:12 +00:00
## Download
Windows:
* **[AppVeyor](https://ci.appveyor.com/api/projects/chris-hawley/xenia-canary/artifacts/xenia_canary.zip?branch=canary_new&job=Configuration:%20Release&pr=false)**
* *[GitHub Actions](https://github.com/xenia-canary/xenia-canary/releases/latest/download/xenia_canary.zip)*
## Compatibility
Quite a few real games run. Quite a few don't.
See the [Game compatibility list](https://github.com/xenia-canary/game-compatibility/issues)
for currently tracked games, and feel free to contribute your own updates,
screenshots, and information there following the [existing conventions](https://github.com/xenia-canary/game-compatibility/blob/master/README.md).
## Building
See [building.md](docs/building.md) for setup and information about the
`xb` script. When writing code, check the [style guide](docs/style_guide.md)
2015-06-10 01:02:57 +00:00
and be sure to run clang-format!
2013-06-29 16:28:13 +00:00
2020-05-04 05:09:12 +00:00
<!--## Contributors Wanted!
<!--
2014-01-14 22:06:05 +00:00
Have some spare time, know advanced C++, and want to write an emulator?
2014-01-14 21:29:04 +00:00
Contribute! There's a ton of work that needs to be done, a lot of which
is wide open greenfield fun.
2020-05-04 05:09:12 +00:00
<!--
2019-03-10 23:03:21 +00:00
**For general rules and guidelines please see [CONTRIBUTING.md](.github/CONTRIBUTING.md).**
2020-05-04 05:09:12 +00:00
<!--
2014-01-14 21:29:04 +00:00
Fixes and optimizations are always welcome (please!), but in addition to
that there are some major work areas still untouched:
2020-05-04 05:09:12 +00:00
<!--
2019-05-12 12:46:12 +00:00
* Help work through [missing functionality/bugs in games](https://github.com/xenia-project/xenia/labels/compat)
2019-05-12 12:37:56 +00:00
* Add input drivers for [DualShock4 (PS4) controllers](https://github.com/xenia-project/xenia/issues/60) (or anything else)
* Skilled with Linux? A strong contributor is needed to [help with porting](https://github.com/xenia-project/xenia/labels/cross%20platform)
2020-05-04 05:09:12 +00:00
<!--
2019-05-12 12:37:56 +00:00
See more projects [good for contributors](https://github.com/xenia-project/xenia/labels/good%20first%20issue). It's a good idea to ask on Discord and check the issues page before beginning work on
something.
2020-05-04 05:09:12 +00:00
-->
## FAQ
2020-05-04 05:09:12 +00:00
See the [frequently asked questions](https://github.com/xenia-canary/xenia-canary/wiki/FAQ) page.