xenia-canary/README.md

94 lines
3.9 KiB
Markdown
Raw Normal View History

2013-01-10 23:22:20 +00:00
Xenia - Xbox 360 Emulator Research Project
==========================================
2013-01-10 23:20:45 +00:00
2015-06-14 01:30:19 +00:00
Xenia is an experimental emulator for the Xbox 360. For more information see the
[main xenia website](http://xenia.jp/).
2013-01-10 23:22:20 +00:00
Come chat with us about **emulator-related topics** in
2015-06-14 01:30:19 +00:00
[#xenia @ irc.freenode.net](http://webchat.freenode.net?channels=%23xenia&uio=MTE9NzIaa).
2015-11-30 17:39:07 +00:00
For developer chat join `#xenia-dev` but stay on topic. Lurking is fine.
2015-06-14 01:30:19 +00:00
Please check the [frequently asked questions](http://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.
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) | [![Build status](https://ci.appveyor.com/api/projects/status/ftqiy86kdfawyx3a/branch/master?svg=true)](https://ci.appveyor.com/project/benvanik/xenia/branch/master)
2016-01-01 19:25:20 +00:00
[Linux](https://travis-ci.org/benvanik/xenia) | [![Build status](https://travis-ci.org/benvanik/xenia.svg)](https://travis-ci.org/benvanik/xenia)
2015-05-02 18:07:40 +00:00
2015-11-30 17:39:07 +00:00
Some real games run. Most don't.
See the [Game compatibility list](https://github.com/xenia-project/game-compatibility/issues)
2015-11-30 17:39:07 +00:00
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).
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
Windows 8.1+ with Python 2.7 and [Visual Studio 2015 or Visual Studio 2017](https://www.visualstudio.com/downloads/) and the Windows SDKs installed:
> git clone https://github.com/benvanik/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)
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!
**Before contributing code or issues be sure to read [CONTRIBUTING.md](.github/CONTRIBUTING.md).**
2015-11-30 17:39:07 +00:00
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
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
2014-07-04 16:59:16 +00:00
* Help work through missing functionality/bugs in game [compat](https://github.com/benvanik/xenia/issues?labels=compat)
2014-12-23 21:16:43 +00:00
* Add input drivers for [PS4 controllers](https://github.com/benvanik/xenia/issues/60) (or anything else)
* Skilled with Linux? A strong contributor is needed to [help with porting](https://github.com/benvanik/xenia/labels/cross%20platform)
See more projects [good for contributors](https://github.com/benvanik/xenia/labels/good%20first%20issue). It's a good idea to ask on IRC/the bugs before beginning work
2014-01-14 21:29:04 +00:00
on something.
2014-01-10 03:12:51 +00:00
## FAQ
2015-06-14 01:30:19 +00:00
For more see the main [frequently asked questions](http://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
Check [Appveyor's artifacts](https://ci.appveyor.com/project/benvanik/xenia/build/artifacts) to see
what's there.