2013-01-10 23:22:20 +00:00
|
|
|
Xenia - Xbox 360 Emulator Research Project
|
|
|
|
|
==========================================
|
2013-01-10 23:20:45 +00:00
|
|
|
|
2013-01-10 23:22:20 +00:00
|
|
|
Xenia is an experimental emulator for the Xbox 360. It does not run games (yet),
|
|
|
|
|
and if you are unable to understand that please leave now.
|
|
|
|
|
|
|
|
|
|
Currently supported features:
|
|
|
|
|
|
|
|
|
|
* Nothing!
|
|
|
|
|
|
|
|
|
|
Coming soon (maybe):
|
|
|
|
|
|
|
|
|
|
* Everything!
|
|
|
|
|
|
|
|
|
|
## Quickstart
|
|
|
|
|
|
|
|
|
|
git clone https://github.com/benvanik/xenia.git
|
2013-01-11 09:23:08 +00:00
|
|
|
cd xenia && source xeniarc
|
|
|
|
|
xb setup
|
|
|
|
|
xb build
|
|
|
|
|
./bin/xenia-run some.xex
|
2013-01-10 23:22:20 +00:00
|
|
|
|
2013-01-11 09:23:08 +00:00
|
|
|
## Requirements
|
2013-01-10 23:22:20 +00:00
|
|
|
|
|
|
|
|
You must have a 64-bit machine for building and running the project. Always
|
|
|
|
|
run your system updater before building and make sure you have the latest
|
|
|
|
|
video drivers for your card.
|
|
|
|
|
|
|
|
|
|
#### Windows
|
|
|
|
|
|
|
|
|
|
Ensure you have the latest patched version of Visual Studio 2010, the
|
|
|
|
|
Windows SDK, the full DirectX SDK, and the Kinect SDK.
|
|
|
|
|
|
|
|
|
|
* Visual Studio 2010 (not sure Express will work)
|
|
|
|
|
* [Visual Studio 2010 SP1](http://msdn.microsoft.com/en-us/vstudio/aa718359)
|
|
|
|
|
* [Windows SDK](http://www.microsoft.com/download/en/details.aspx?id=8279)
|
|
|
|
|
* [DirectX SDK](http://msdn.microsoft.com/en-us/directx/)
|
|
|
|
|
* [Kinect SDK](http://www.kinectforwindows.org/download/)
|
|
|
|
|
* [Doxygen](http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc)
|
|
|
|
|
* [Python 2.6](http://www.python.org/getit/releases/2.6/)
|
|
|
|
|
* [CMake](http://www.cmake.org/cmake/resources/software.html)
|
|
|
|
|
|
|
|
|
|
#### OS X
|
|
|
|
|
|
2013-01-11 09:23:08 +00:00
|
|
|
Only tested on OS X 10.8 (Mountain Lion).
|
|
|
|
|
|
|
|
|
|
* [Xcode 4](http://developer.apple.com/xcode/) + command line tools
|
|
|
|
|
* [Homebrew](http://mxcl.github.com/homebrew/)
|
|
|
|
|
|
|
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
A simple build script is included to manage basic tasks such as building
|
|
|
|
|
dependencies.
|
|
|
|
|
|
|
|
|
|
./xenia-build.py --help
|
|
|
|
|
|
|
|
|
|
The `xeniarc` bash file has some aliases that save some keypresses.
|
|
|
|
|
|
|
|
|
|
source xeniarc
|
|
|
|
|
xb -> python xenia-build.py
|
|
|
|
|
xbb -> python xenia-build.py build
|
|
|
|
|
xbc -> python xenia-build.py clean
|
|
|
|
|
|
|
|
|
|
### Commands
|
|
|
|
|
|
|
|
|
|
#### setup
|
|
|
|
|
|
|
|
|
|
Run this on initial checkout to pull down all dependencies and setup LLVM.
|
|
|
|
|
|
|
|
|
|
xb setup
|
|
|
|
|
|
|
|
|
|
#### pull
|
|
|
|
|
|
|
|
|
|
Does a `git pull` in addition to updating submodules and rebuilding dependencies
|
|
|
|
|
and gyp outputs. Use this, if possible, instead of git pull.
|
|
|
|
|
|
|
|
|
|
xb pull
|
|
|
|
|
|
|
|
|
|
#### gyp
|
|
|
|
|
|
|
|
|
|
Updates all of the supported gyp projects. If you're using Visual Studio or
|
|
|
|
|
Xcode to build or debug your projects you'll need to run this after you change
|
|
|
|
|
gyp/gypi files.
|
|
|
|
|
|
|
|
|
|
xb gyp
|
2013-01-14 21:27:52 +00:00
|
|
|
|
|
|
|
|
#### xethunk
|
|
|
|
|
|
|
|
|
|
Updates the checked-in `src/cpu/xethunk/xethunk.bc` and `xethunk.ll` files.
|
|
|
|
|
This is only required if changes are made to the xethunk files. The results
|
|
|
|
|
should be checked in.
|
2013-01-11 09:23:08 +00:00
|
|
|
|
|
|
|
|
#### build
|
|
|
|
|
|
|
|
|
|
Builds all xenia targets using ninja. Release is built by default; specify
|
|
|
|
|
`--debug` to build the debug configuration.
|
|
|
|
|
|
|
|
|
|
xb build
|
|
|
|
|
xb build --debug
|
|
|
|
|
|
|
|
|
|
#### clean
|
|
|
|
|
|
|
|
|
|
Cleans just xenia outputs from the build/ directory. A following build will just
|
|
|
|
|
have the rebuild xenia and not all of the dependencies.
|
|
|
|
|
|
|
|
|
|
xb clean
|
|
|
|
|
|
|
|
|
|
#### nuke
|
|
|
|
|
|
|
|
|
|
Cleans up xenia outputs as well as all dependencies. A full build will be
|
|
|
|
|
required after this - including LLVM - so only do this if you want to reclaim
|
|
|
|
|
your disk space or something is really wrong.
|
|
|
|
|
|
|
|
|
|
xb nuke
|
|
|
|
|
|
|
|
|
|
## Running
|
|
|
|
|
|
|
|
|
|
Use the wrapper shell scripts under `bin/` to run tools. They will ensure the
|
|
|
|
|
tools are built (but not that they are up to date) before running and allow
|
|
|
|
|
switching between the debug and release variants with `--debug`.
|
|
|
|
|
|
|
|
|
|
### xenia-info
|
|
|
|
|
|
|
|
|
|
Dumps information about a xex file.
|
|
|
|
|
|
|
|
|
|
./bin/xenia-info some.xex
|
|
|
|
|
|
|
|
|
|
### xenia-run
|
2013-01-10 23:22:20 +00:00
|
|
|
|
2013-01-11 09:23:08 +00:00
|
|
|
Runs a xex.
|
2013-01-10 23:22:20 +00:00
|
|
|
|
2013-01-11 09:23:08 +00:00
|
|
|
./bin/xenia-run some.xex
|
