xenia-canary/README.md

72 lines
3.6 KiB
Markdown
Raw Normal View History

2019-03-10 23:03:21 +00:00
<p align="center">
<a href="https://github.com/xenia-canary/xenia-canary/tree/canary_experimental/assets/icon">
<img height="256px" src="https://raw.githubusercontent.com/xenia-canary/xenia/master/assets/icon/256.png" />
2019-03-10 23:03:21 +00:00
</a>
</p>
2013-01-10 23:20:45 +00:00
<h1 align="center">Xenia Canary - Xbox 360 Emulator</h1>
2019-03-10 23:03:21 +00:00
Xenia is an experimental emulator for the Xbox 360. For more information, see the
2024-03-23 14:28:38 +00:00
[Xenia wiki](https://github.com/xenia-canary/xenia-canary/wiki).
2013-01-10 23:22:20 +00:00
Come chat with us about **emulator-related topics** on [Discord](https://discord.gg/Q9mxZf9).
2018-11-23 18:21:00 +00:00
For developer chat join `#dev` but stay on topic. Lurking is not only fine, but encouraged!
Please check the [FAQ](https://github.com/xenia-project/xenia/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
2014-01-24 20:59:28 +00:00
## Status
2013-01-10 23:22:20 +00:00
2022-01-25 14:05:51 +00:00
Buildbot | Status | Releases
-------- | ------ | --------
2024-03-23 14:28:38 +00:00
Windows | [![CI](https://github.com/xenia-canary/xenia-canary/actions/workflows/Windows_build.yml/badge.svg?branch=canary_experimental)](https://github.com/xenia-canary/xenia-canary/actions/workflows/Windows_build.yml) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/cd506034fd8148309a45034925648499)](https://app.codacy.com/gh/xenia-canary/xenia-canary/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) | [Latest](https://github.com/xenia-canary/xenia-canary/releases/latest) ◦ [All](https://github.com/xenia-canary/xenia-canary/releases)
Linux | Curently unsupported
Netplay Build | | [Latest](https://github.com/AdrianCassar/xenia-canary/releases/latest)
2015-05-02 18:07:40 +00:00
## Quickstart
2015-05-02 18:07:40 +00:00
See the [Quickstart](https://github.com/xenia-project/xenia/wiki/Quickstart) page.
2013-02-02 03:37:53 +00:00
## FAQ
2013-02-02 03:37:53 +00:00
See the [frequently asked questions](https://github.com/xenia-project/xenia/wiki/FAQ) page.
2013-01-10 23:22:20 +00:00
## Game Compatibility
See the [Game compatibility list](https://github.com/xenia-project/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-project/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
2014-01-10 03:12:51 +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.
2014-01-14 21:29:04 +00:00
2019-03-10 23:03:21 +00:00
**For general rules and guidelines please see [CONTRIBUTING.md](.github/CONTRIBUTING.md).**
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:
2014-01-10 03:12:51 +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)
* Reduce the size of Xenia's [huge log files](https://github.com/xenia-project/xenia/issues/1526)
2020-11-16 17:37:55 +00:00
* Skilled with Linux? A strong contributor is needed to [help with porting](https://github.com/xenia-project/xenia/labels/platform-linux)
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.
2014-01-10 03:12:51 +00:00
## Disclaimer
The goal of this project is to experiment, research, and educate on the topic
of emulation of modern devices and operating systems. **It is not for enabling
illegal activity**. All information is obtained via reverse engineering of
legally purchased devices and games and information made public on the internet
(you'd be surprised what's indexed on Google...).