2019-03-10 23:03:21 +00:00
< p align = "center" >
< a href = "https://github.com/xenia-project/xenia/tree/master/assets/icon" >
2019-05-03 09:31:54 +00:00
< img height = "120px" src = "https://raw.githubusercontent.com/xenia-project/xenia/master/assets/icon/128.png" / >
2019-03-10 23:03:21 +00:00
< / a >
< / p >
2013-01-10 23:20:45 +00:00
2019-03-10 23:03:21 +00:00
< h1 align = "center" > Xenia - Xbox 360 Emulator< / h1 >
Xenia is an experimental emulator for the Xbox 360. For more information, see the
2018-11-22 15:20:09 +00:00
[main xenia website ](https://xenia.jp/ ).
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
2018-05-04 00:58:37 +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!
2018-11-22 15:20:09 +00:00
Please check the [frequently asked questions ](https://xenia.jp/faq/ ) page before
2015-06-14 01:30:19 +00:00
asking questions. We've got jobs/lives/etc, so don't expect instant answers.
2018-05-04 00:58:37 +00:00
2015-06-14 01:30:19 +00:00
Discussing illegal activities will get you banned. No warnings.
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
2016-01-01 19:25:20 +00:00
Buildbot | Status
-------- | ------
2017-12-17 05:57:58 +00:00
[Windows ](https://ci.appveyor.com/project/benvanik/xenia/branch/master ) | [](https://ci.appveyor.com/project/benvanik/xenia/branch/master)
2018-06-14 23:05:43 +00:00
[Linux ](https://travis-ci.org/xenia-project/xenia ) | [](https://travis-ci.org/xenia-project/xenia)
2015-05-02 18:07:40 +00:00
2019-03-10 23:03:21 +00:00
Quite a few real games run. Quite a few don't.
2015-08-28 21:16:38 +00:00
See the [Game compatibility list ](https://github.com/xenia-project/game-compatibility/issues )
2019-03-10 23:03:21 +00:00
for currently tracked games, and feel free to contribute your own updates,
2015-11-30 17:39:07 +00:00
screenshots, and information there following the [existing conventions ](https://github.com/xenia-project/game-compatibility/blob/master/README.md ).
2015-05-02 18:07:40 +00:00
2013-02-02 03:37:53 +00:00
## Disclaimer
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
2019-04-22 03:17:16 +00:00
With Windows 8+, Python 3.4+, and [Visual Studio 2017 or 2019 ](https://www.visualstudio.com/downloads/ ) and the Windows SDKs installed:
2015-05-03 04:46:42 +00:00
2018-11-22 15:20:09 +00:00
> git clone https://github.com/xenia-project/xenia.git
2015-12-27 19:53:37 +00:00
> cd xenia
> xb setup
2015-08-28 21:16:38 +00:00
2015-12-27 19:53:37 +00:00
# Pull latest changes, rebase, and update submodules and premake:
> xb pull
2015-08-28 21:16:38 +00:00
2015-12-27 19:53:37 +00:00
# Build on command line:
> xb build
2015-08-28 21:16:38 +00:00
2015-12-27 19:53:37 +00:00
# Run premake and open Visual Studio (run the 'xenia-app' project):
> xb devenv
2015-08-28 21:16:38 +00:00
2015-12-27 19:53:37 +00:00
# Run premake to update the sln/vcproj's:
> xb premake
2013-10-18 06:35:54 +00:00
2015-12-27 19:53:37 +00:00
# Format code to the style guide:
> xb format
2015-08-28 21:16:38 +00:00
2013-10-18 06:35:54 +00:00
When fetching updates use `xb pull` to automatically fetch everything and
2015-07-18 23:00:01 +00:00
run premake for project files/etc.
2013-10-18 06:35:54 +00:00
2013-01-11 09:23:08 +00:00
## Building
2016-01-05 10:57:33 +00:00
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
2014-02-02 19:25:00 +00:00
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 ).**
2015-08-30 01:06:30 +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:
2014-01-10 03:12:51 +00:00
2019-04-21 05:00:16 +00:00
* Help work through [missing functionality/bugs in games ](https://github.com/xenia-project/xenia/labels/compat )
2018-11-22 15:20:09 +00:00
* Add input drivers for [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 )
2014-02-02 19:25:00 +00:00
2019-03-10 23:03:21 +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/check the issues before beginning work on something.
2014-01-10 03:12:51 +00:00
2013-11-16 09:15:17 +00:00
## FAQ
2018-11-22 15:20:09 +00:00
For more see the main [frequently asked questions ](https://xenia.jp/faq/ ) page.
2014-01-24 20:59:28 +00:00
2015-06-14 01:30:19 +00:00
### Can I get an exe?
2013-11-16 09:39:06 +00:00
2017-03-19 05:12:00 +00:00
Check [Appveyor's artifacts ](https://ci.appveyor.com/project/benvanik/xenia/build/artifacts ) to see
2017-03-17 15:41:57 +00:00
what's there.
