94 lines
3.9 KiB
Markdown
94 lines
3.9 KiB
Markdown
Xenia - Xbox 360 Emulator Research Project
|
|
==========================================
|
|
|
|
Xenia is an experimental emulator for the Xbox 360. For more information see the
|
|
[main xenia website](https://xenia.jp/).
|
|
|
|
Come chat with us about **emulator-related topics** on [Discord](https://discord.gg/Q9mxZf9).
|
|
For developer chat join `#dev` but stay on topic. Lurking is fine.
|
|
Please check the [frequently asked questions](https://xenia.jp/faq/) page before
|
|
asking questions. We've got jobs/lives/etc, so don't expect instant answers.
|
|
|
|
Discussing illegal activities will get you banned. No warnings.
|
|
|
|
## Status
|
|
|
|
Buildbot | Status
|
|
-------- | ------
|
|
[Windows](https://ci.appveyor.com/project/benvanik/xenia/branch/master) | [](https://ci.appveyor.com/project/benvanik/xenia/branch/master)
|
|
[Linux](https://travis-ci.org/xenia-project/xenia) | [](https://travis-ci.org/xenia-project/xenia)
|
|
|
|
Some real games run. Most don't.
|
|
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).
|
|
|
|
## 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...).
|
|
|
|
## Quickstart
|
|
|
|
Windows 8.1+ with Python 3.4 and [Visual Studio 2017](https://www.visualstudio.com/downloads/) and the Windows SDKs installed:
|
|
|
|
> git clone https://github.com/xenia-project/xenia.git
|
|
> cd xenia
|
|
> xb setup
|
|
|
|
# Pull latest changes, rebase, and update submodules and premake:
|
|
> xb pull
|
|
|
|
# Build on command line:
|
|
> xb build
|
|
|
|
# Run premake and open Visual Studio (run the 'xenia-app' project):
|
|
> xb devenv
|
|
|
|
# Run premake to update the sln/vcproj's:
|
|
> xb premake
|
|
|
|
# Format code to the style guide:
|
|
> xb format
|
|
|
|
When fetching updates use `xb pull` to automatically fetch everything and
|
|
run premake for project files/etc.
|
|
|
|
## 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)
|
|
and be sure to run clang-format!
|
|
|
|
## Contributors Wanted!
|
|
|
|
**Before contributing code or issues be sure to read [CONTRIBUTING.md](.github/CONTRIBUTING.md).**
|
|
|
|
Have some spare time, know advanced C++, and want to write an emulator?
|
|
Contribute! There's a ton of work that needs to be done, a lot of which
|
|
is wide open greenfield fun.
|
|
|
|
For general rules and guidelines please see [CONTRIBUTING.md](.github/CONTRIBUTING.md).
|
|
|
|
Fixes and optimizations are always welcome (please!), but in addition to
|
|
that there are some major work areas still untouched:
|
|
|
|
* Help work through missing functionality/bugs in game [compat](https://github.com/xenia-project/xenia/issues?labels=compat)
|
|
* 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)
|
|
|
|
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/the bugs before beginning work
|
|
on something.
|
|
|
|
## FAQ
|
|
|
|
For more see the main [frequently asked questions](https://xenia.jp/faq/) page.
|
|
|
|
### Can I get an exe?
|
|
|
|
Check [Appveyor's artifacts](https://ci.appveyor.com/project/benvanik/xenia/build/artifacts) to see
|
|
what's there.
|