From 8a75d916d49056312deffffa33091098e0aba399 Mon Sep 17 00:00:00 2001 From: Matt Borgerson Date: Thu, 17 Jun 2021 19:40:30 -0700 Subject: [PATCH] Rename getting-started to required-files and split out some content --- docs/docs/about.md | 11 +++- docs/docs/dashboard.md | 14 +++-- docs/docs/disc-images.md | 20 +++++++ docs/docs/faq.md | 2 +- docs/docs/getting-started.md | 106 ----------------------------------- docs/docs/required-files.md | 54 ++++++++++++++++++ docs/mkdocs.yml | 6 +- 7 files changed, 97 insertions(+), 116 deletions(-) create mode 100644 docs/docs/disc-images.md delete mode 100644 docs/docs/getting-started.md create mode 100644 docs/docs/required-files.md diff --git a/docs/docs/about.md b/docs/docs/about.md index ea2dd614..da1733e4 100644 --- a/docs/docs/about.md +++ b/docs/docs/about.md @@ -1,5 +1,3 @@ -# About -
[![Chat Badge](https://img.shields.io/badge/Chat-xemu%20Discord%20Server-7289DA?logo=Discord&logoColor=white)](https://discord.gg/ayyjsuM) [![YouTube Badge](https://img.shields.io/badge/Videos-YouTube-red?logo=YouTube&logoColor=white)](https://www.youtube.com/channel/UCrT8NawDTt5gJnMMe9uUg-Q/featured) @@ -26,6 +24,15 @@ others. xemu is based on the excellent QEMU full system emulator project. all users to do the same. Piracy is not tolerated on any communication channel. +## System Requirements + +xemu runs on Windows, macOS, and Linux systems. An OpenGL 4.0-compatible GPU is +required. Most recent integrated GPUs will work. + +Please note that xemu is an evolving project and, although xemu can run on large +number of systems, actual game performance is in flux and will vary based on the +characteristics of your system. + ## Open Source Development xemu is developed on GitHub at https://github.com/mborgerson/xemu. Contributions diff --git a/docs/docs/dashboard.md b/docs/docs/dashboard.md index 4b79880d..d32bb2b6 100644 --- a/docs/docs/dashboard.md +++ b/docs/docs/dashboard.md @@ -7,11 +7,15 @@ storage management. ## Default xemu Dashboard The [pre-built Xbox HDD image](getting-started.md#option-1-use-a-pre-built-xbox-hdd-image-recommended), -does not contain the official Xbox dashboard. Instead it contains only a 'dummy' -dashboard, intended to be replaced. +does not contain the official Xbox dashboard. Instead it contains only an +**unsigned** "dummy" dashboard, intended to be replaced. -It is not strictly required to replace the dummy dashboard. Games can still -be launched with the dummy dashboard installed. +It is not strictly required to replace the dummy dashboard. Games can still be +launched with the dummy dashboard installed. + +Because the dummy dashboard is unsigned, 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. ## Installing the Official Xbox Dashboard @@ -26,4 +30,4 @@ an FTP server. [See here for more details](ftp.md). It is not required to use the official Xbox dashboard. There are alternatives available, such as the open-source dashboard -[NevolutionX](https://github.com/dracc/nevolutionx). \ No newline at end of file +[NevolutionX](https://github.com/dracc/nevolutionx). diff --git a/docs/docs/disc-images.md b/docs/docs/disc-images.md new file mode 100644 index 00000000..fab6e1f1 --- /dev/null +++ b/docs/docs/disc-images.md @@ -0,0 +1,20 @@ +xemu requires game discs to be in the form of ".iso" disc images. You can +backup your legally purchased games by: + +* Using a real Xbox with a custom dashboard to transfer the game files to your + computer over FTP. +* Purchasing and using a special, reflashed DVD drive. [More details here](http://wiki.redump.org/index.php?title=Microsoft_Xbox_and_Xbox_360_Dumping_Guide). + +You can create an iso image using [extract-xiso](https://github.com/XboxDev/extract-xiso) (command-line only). + +### About "redump" ISOs + +Redump-style ISOs contain data for both the video partition and game partition. For now, +you'll want to extract the game partition for use with xemu. You can do this by simply +extracting everything after the first 387MiB. For example, using `dd`: + +``` +dd if=my-redump-style-dump.iso of=my-game-partition.iso skip=387 bs=1M +``` + +You can then use the `my-game-partition.iso` with xemu. diff --git a/docs/docs/faq.md b/docs/docs/faq.md index cfcc09a1..6f4a50b6 100644 --- a/docs/docs/faq.md +++ b/docs/docs/faq.md @@ -7,7 +7,7 @@ Of course, but first please read through the [getting started guide](getting-sta Join the Discord server and chat about what you're seeing in #general, maybe it's a known issue. We can work together to get it recorded and fixed. #### Q: Are there system requirements? -See [here](getting-started.md#system-requirements). +See [here](about.md#system-requirements). #### Q: What BIOS do I need to use? Your MCPX and BIOS dump should be for a 1.0 Xbox. It's suggested that your MCPX dump be 1.0 and that a compatible BIOS image be used (users have reported success with "COMPLEX 4627"). diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md deleted file mode 100644 index e8ec0dfc..00000000 --- a/docs/docs/getting-started.md +++ /dev/null @@ -1,106 +0,0 @@ -## System Requirements - -xemu runs on Windows, macOS, and Linux systems. An OpenGL 4.0-compatible GPU is -required. Most recent integrated GPUs will work. - -Please note that xemu is an evolving project and, although xemu can run on large -number of systems, actual game performance is in flux and will vary based on the -characteristics of your system. - -## Required Files - -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](#mcpx-boot-rom-image) -2. [The flash ROM image (aka *BIOS*)](#flash-rom-image-aka-bioskernel) -3. [A properly-formatted hard disk drive image](#hard-disk-drive-image) -4. [Game disc image(s)](#game-disc-images) - -Unfortunately, distributing some of these items would violate copyright laws, so -you'll need to acquire them on your own. - -!!! warning "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 compatible BIOS. Just like a real Xbox, running an unmodified retail BIOS will -not allow booting unofficial software. - -People have reported most success using the modified retail "COMPLEX 4627" BIOS. - -## 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/mborgerson/xemu-hdd-image/releases/latest/download/xbox_hdd.qcow2.zip) - -!!! 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/mborgerson/xemu-hdd-image). - -## Game Disc Images - -xemu requires game discs to be in the form of ".iso" disc images. You can -backup your legally purchased games by: - -* Using a real Xbox with a custom dashboard to transfer the game files to your - computer over FTP. -* Purchasing and using a special, reflashed DVD drive. [More details here](http://wiki.redump.org/index.php?title=Microsoft_Xbox_and_Xbox_360_Dumping_Guide). - -You can create an iso image using [extract-xiso](https://github.com/XboxDev/extract-xiso) (command-line only). - -### About "redump" ISOs - -Redump-style ISOs contain data for both the video partition and game partition. For now, -you'll want to extract the game partition for use with xemu. You can do this by simply -extracting everything after the first 387MiB. For example, using `dd`: - -``` -dd if=my-redump-style-dump.iso of=my-game-partition.iso skip=387 bs=1M -``` - -You can then use the `my-game-partition.iso` with xemu. - -I've found an issue, what do I do? ----------------------------------- -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. - ---- diff --git a/docs/docs/required-files.md b/docs/docs/required-files.md new file mode 100644 index 00000000..1d22caf8 --- /dev/null +++ b/docs/docs/required-files.md @@ -0,0 +1,54 @@ +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](#mcpx-boot-rom-image) +2. [The flash ROM image (aka *BIOS*)](#flash-rom-image-aka-bioskernel) +3. [A properly-formatted hard disk image](#hard-disk-image) + +Unfortunately, distributing some of these items would violate copyright laws, so +you'll need to acquire them on your own. + +!!! warning "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 (BIOS) + +Xbox compatible BIOS. Just like a real Xbox, running an unmodified retail BIOS will +not allow booting unofficial software. + +People have reported most success using the modified retail "COMPLEX 4627" BIOS. + +## Hard Disk Image + +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/mborgerson/xemu-hdd-image/releases/latest/download/xbox_hdd.qcow2.zip) + +!!! note + By design, this particular drive image does not contain the official Xbox + dashboard, but instead contains only an **unsigned** dummy dashboard. [More + information](dashboard.md) + +??? "Alternative Options" + **Alternative 1:** 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. + + **Alternative 2:** 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/mborgerson/xemu-hdd-image). diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ef3567e1..118ddae6 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -77,7 +77,8 @@ nav: - FAQ: faq.md - Setup: - Download: download.md - - Getting Started: getting-started.md + - Required Files: required-files.md + - Disc Images: disc-images.md - Input Devices: input.md - Networking: networking.md - Dashboard: dashboard.md @@ -94,6 +95,7 @@ plugins: - search - redirects: redirect_maps: - index.md: getting-started.md + index.md: download.md + getting-started.md: required-files.md - minify: minify_html: true