ShuriZma
/
xemu
mirror of https://github.com/xemu-project/xemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated Home (markdown)

mborgerson 2020-02-20 23:48:58 -07:00
parent 04ca9a869f
commit 18691c4335
1 changed files with 58 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
Home.md

@ -1 +1,58 @@
Welcome to the xemu wiki!
<!-- <img src=https://i.imgur.com/lf2KlyN.png height=200 /> -->
<img src=https://i.imgur.com/3bztvmH.png />
<br /><br />
[![Build Status](https://github.com/mborgerson/xemu/workflows/Build/badge.svg?branch=master)](https://github.com/mborgerson/xemu/actions?query=branch%3Amaster)
[![Download](https://img.shields.io/badge/Download-Windows-blue)](https://github.com/mborgerson/xemu/releases/latest)
[![Chat Badge](https://img.shields.io/badge/Chat-Discord-7289DA)](https://discord.gg/ayyjsuM)
Welcome! **xemu** is an open-source, cross-platform application that emulates the hardware of the [original Xbox](https://en.wikipedia.org/wiki/Xbox_(console)) game console, allowing users to play their Xbox games on Windows, macOS, and Linux systems. This project is focused on making significant forward progress in terms of features, performance, stability, and user experience in Xbox emulation.
This project is an active fork of the [XQEMU](https://xqemu.com) project, which is based on the very popular and highly actively maintained [QEMU](https://www.qemu.org/) full system emulator project.
What's to come?
---------------
Lots of great things. If you've subscribed to my [YouTube channel](https://www.youtube.com/playlist?list=PLBRxCmSa5Ob1m8XsJMkRQrAQu0RUxa4PF), you will have seen the experimental work I've done already in this area on the XQEMU project, much of which has not yet been released. That work (and more) is going to be made more stable in the coming months and will be integrated into this project.
Building and Testing
--------------------
### Windows
Windows users a recommended to use the pre-built release version. However, if you would like to build from source, you can do so by downloading the [MSYS2 environment](https://www.msys2.org/) and building with:
```bash
pacman --needed --noconfirm -S git make \
mingw-w64-x86_64-gcc \
mingw-w64-x86_64-glib2 \
mingw-w64-x86_64-libepoxy \
mingw-w64-x86_64-libtool \
mingw-w64-x86_64-pixman \
mingw-w64-x86_64-pkg-config \
mingw-w64-x86_64-SDL2 \
python3
./build.sh
```
### macOS
At the moment, [macOS](https://brew.sh/) users will need to build from source. Binaries will be available soon.
With the Homebrew package manager installed:
```bash
brew update
brew install glib pixman sdl2 libepoxy coreutils pkg-config
./build.sh
```
### Linux (Debian/Ubuntu)
At the moment, Linux users will need to build from source. Binaries will be available soon.
```bash
sudo apt-get update
sudo apt-get install -y libsdl2-dev libepoxy-dev libpixman-1-dev
./build.sh
```
### Testing
For now (but not for long), xemu is compatible with the [XQEMU getting started guide](https://xqemu.com/getting-started/). Please read carefully and understand this guide. If you have questions, please consult the [XQEMU FAQ](https://xqemu.com/faq/).