diff --git a/docs/docs/dashboard.md b/docs/docs/dashboard.md new file mode 100644 index 00000000..4b79880d --- /dev/null +++ b/docs/docs/dashboard.md @@ -0,0 +1,29 @@ +## What is a Dashboard? + +The dashboard is the application that runs when the original Xbox is started, +which presents the main menu interface and allows device configuration and +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. + +It is not strictly required to replace the dummy dashboard. Games can still +be launched with the dummy dashboard installed. + +## Installing the Official Xbox Dashboard + +If you would like to install use the official Xbox dashboard, you will first +need to download the dashboard files from your real Xbox, then transfer them to +the xemu hard disk image. + +This can easily be done by running an alternative dashboard which exposes +an FTP server. [See here for more details](ftp.md). + +## Alternative Dashboards + +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 diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md index 655e5c6b..b814de85 100644 --- a/docs/docs/getting-started.md +++ b/docs/docs/getting-started.md @@ -41,17 +41,18 @@ 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. +!!! 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. + 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 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index bd58b031..fe25030b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -71,6 +71,7 @@ nav: - Getting Started: getting-started.md - Input Devices: input.md - Networking: networking.md + - Dashboard: dashboard.md - Reference: - Command Line Arguments: cli.md - HDD Access via FTP: ftp.md