mirror of https://github.com/xemu-project/xemu.git
Updated Home (markdown)
mborgerson
parent
af89a16e31
commit
461609e712
90
Home.md
90
Home.md
|
|
@ -3,7 +3,7 @@
|
||||||
<br /><br />
|
<br /><br />
|
||||||
|
|
||||||
[](https://github.com/mborgerson/xemu/actions?query=branch%3Amaster)
|
[](https://github.com/mborgerson/xemu/actions?query=branch%3Amaster)
|
||||||
[](https://github.com/mborgerson/xemu/releases/latest)
|
[](https://github.com/mborgerson/xemu/releases/latest)
|
||||||
[](https://discord.gg/ayyjsuM)
|
[](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.
|
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.
|
||||||
|
|
@ -30,13 +30,13 @@ Lots of great things. If you've subscribed to my [YouTube channel](https://www.y
|
||||||
|
|
||||||
Along the way, I plan to catalog and demonstrate reasonably often, which includes posting more demo videos on YouTube of stuff you can try for yourself. I also look forward to seeing your videos of testing things out so we can hunt bugs together.
|
Along the way, I plan to catalog and demonstrate reasonably often, which includes posting more demo videos on YouTube of stuff you can try for yourself. I also look forward to seeing your videos of testing things out so we can hunt bugs together.
|
||||||
|
|
||||||
Building and Testing
|
Download/Build
|
||||||
--------------------
|
--------------
|
||||||
Users are encouraged to help regularly test for regressions. I plan to create a compatibility system soon where reports and videos can be shared documenting progress.
|
Users are encouraged to help regularly test for regressions. I plan to release the compatibility system soon where reports and videos can be shared documenting progress. In the mean time, feel free to report issues in the Discord server linked at the top of this page.
|
||||||
|
|
||||||
### Windows
|
### 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:
|
Windows users are recommended to use the pre-built release version. The link to this can be found at the top of this page. 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
|
```bash
|
||||||
pacman --needed --noconfirm -S git make \
|
pacman --needed --noconfirm -S git make \
|
||||||
|
|
@ -52,13 +52,11 @@ pacman --needed --noconfirm -S git make \
|
||||||
```
|
```
|
||||||
|
|
||||||
### macOS
|
### macOS
|
||||||
At the moment, macOS users will need to build from source. Binaries will be available soon.
|
macOS users are recommended to use the pre-built release version. The link to this can be found at the top of this page. However, if you would like to build from source, you can do so by first installing the [Homebrew package manager](https://brew.sh/) and building with:
|
||||||
|
|
||||||
With the [Homebrew package manager](https://brew.sh/) installed:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
brew update
|
brew update
|
||||||
brew install glib pixman sdl2 libepoxy coreutils pkg-config
|
brew install glib pixman sdl2 libepoxy coreutils pkg-config dylibbundler
|
||||||
./build.sh
|
./build.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -71,11 +69,77 @@ sudo apt-get install -y libsdl2-dev libepoxy-dev libpixman-1-dev
|
||||||
./build.sh
|
./build.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
### Testing
|
Getting Started
|
||||||
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/). If you have further questions, or just want to chat, head over to the Discord server linked at the top.
|
---------------
|
||||||
|
xemu is a low-level, full-system emulator which emulates the actual hardware of
|
||||||
|
the Xbox; this means that in order to actually run xemu, you must have a copy
|
||||||
|
of the stuff that a real Xbox needs when it turns on:
|
||||||
|
|
||||||
|
1. The MCPX Boot ROM image
|
||||||
|
2. The flash ROM image (aka *BIOS*)
|
||||||
|
3. A properly-formatted hard disk drive image
|
||||||
|
4. Game disc image(s)
|
||||||
|
|
||||||
|
Unfortunately, distributing some of these items would violate copyright laws, so
|
||||||
|
you'll need to acquire them on your own.
|
||||||
|
|
||||||
|
```diff
|
||||||
|
- Disclaimer ------------------------------------------------------------------
|
||||||
|
The xemu project does not endorse or promote piracy. We don't link to
|
||||||
|
copyrighted files, or discuss how to acquire them. The only legal way to
|
||||||
|
acquire these files is to dump them from *your real, physical Xbox*. Please
|
||||||
|
don't ask us how to get them.
|
||||||
|
```
|
||||||
|
|
||||||
|
#### MCPX Boot ROM Image
|
||||||
|
|
||||||
|
MD5 (mcpx_1.0.bin) = d49c52a4102f6df7bcf8d0617ac475ed
|
||||||
|
|
||||||
|
If your MCPX dump has an MD5 of `196a5f59a13382c185636e691d6c323d`, you dumped
|
||||||
|
it badly and it's a couple of bytes off. It should start with `0x33 0xC0` and end
|
||||||
|
with `0x02 0xEE`.
|
||||||
|
|
||||||
|
#### Flash ROM Image (aka BIOS/Kernel)
|
||||||
|
|
||||||
|
Xbox 1.0 compatible BIOS (cromwell, 4034, 4036, ...). You can use a retail
|
||||||
|
or debug image. Just like a real Xbox, running an unmodified retail BIOS will
|
||||||
|
not allow booting unofficial software.
|
||||||
|
|
||||||
|
People have reported most success using the modified "COMPLEX 4627" BIOS (retail version).
|
||||||
|
|
||||||
|
#### Hard Disk Drive Image
|
||||||
|
|
||||||
|
You have options:
|
||||||
|
|
||||||
|
##### Option 1: Use a pre-built Xbox HDD image (recommended)
|
||||||
|
|
||||||
|
You can use a pre-built 8G Xbox HDD image, free of any copyrighted content, and
|
||||||
|
only containing a dummy dashboard. [You can download this image from
|
||||||
|
here!](https://github.com/xqemu/xqemu-hdd-image/releases)
|
||||||
|
|
||||||
|
**Note:** By design, this particular drive image does not contain the official Xbox
|
||||||
|
dashboard, but instead contains only a dummy dashboard. Because of this, you
|
||||||
|
may see an error message when starting xemu with an unmodified retail BIOS
|
||||||
|
image due to the system failing to find a properly signed dashboard.
|
||||||
|
|
||||||
|
If you would like to change your dashboard (perhaps to the official retail
|
||||||
|
dashboard, or any alternative dashboard), or copy additional files over to
|
||||||
|
the Xbox HDD, you can start xemu, using a modified BIOS image, and a disc
|
||||||
|
containing an alternative dashboard. Then you can either install that
|
||||||
|
dashboard, or connect to xemu using FTP to transfer your desired dashboard
|
||||||
|
files to the HDD.
|
||||||
|
|
||||||
|
##### Option 2: Image your real Xbox HDD
|
||||||
|
|
||||||
|
This is the most authentic way to do it. Unlock your drive, connect it to a
|
||||||
|
computer, and `dd` the entire contents of the drive straight to a file. This
|
||||||
|
file can be used as-is with xemu.
|
||||||
|
|
||||||
|
##### Option 3: Build a new HDD image from scratch
|
||||||
|
|
||||||
|
You can also create an Xbox hard-disk image using XboxHDM. Directions on how
|
||||||
|
to do this [can be found here](https://github.com/xqemu/xqemu-hdd-image).
|
||||||
|
|
||||||
I've found an issue, what do I do?
|
I've found an issue, what do I do?
|
||||||
----------------------------------
|
----------------------------------
|
||||||
Great! Please do not file any GitHub issues at the moment, as I need to create the issue templates before hand. Instead, come chat on the Discord server linked at the top and we can do an early diagnosis of the issue. If necessary, we can catalog the issue for further exploration.
|
Great! Please do not file any GitHub issues at the moment, as I need to create the issue templates before hand. Instead, come chat on the Discord server linked at the top and we can do an early diagnosis of the issue. If necessary, we can catalog the issue for further exploration.
|
||||||
|
|
||||||
.
|
|
||||||
Loading…
Reference in New Issue