Skip to content

Commit

Permalink
Update README to include MLC Clone
Browse files Browse the repository at this point in the history
  • Loading branch information
jan-hofmeier committed May 29, 2023
1 parent 3413508 commit 3b7b90c
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
![screenshot](screenshot.png)

# Wii U Recovery Menu

A simple recovery menu running on the IOSU for unbricking, which can be booted using [udpih](https://github.com/GaryOderNichts/udpih).

> :information_source: Some Wii U's don't show any TV output, if it hasn't been configured properly before.
Expand All @@ -14,36 +15,47 @@ A simple recovery menu running on the IOSU for unbricking, which can be booted u
> **purple**: menu is ready and running
## Options

### Set Coldboot Title

Allows changing the current title the console boots to.
Useful for unbricking CBHC bricks.
Possible options are:

- `Wii U Menu (JPN) - 00050010-10040000`
- `Wii U Menu (USA) - 00050010-10040100`
- `Wii U Menu (EUR) - 00050010-10040200`

On non-retail systems the following additional options are available:

- `System Config Tool - 00050010-1F700500`
- `DEVMENU (pre-2.09) - 00050010-1F7001FF`
- `Kiosk Menu - 00050010-1FA81000`

### Dump Syslogs

Copies all system logs to a `logs` folder on the root of the SD Card.

### Dump OTP + SEEPROM

Dumps the OTP and SEEPROM to `otp.bin` and `seeprom.bin` on the root of the SD Card.

### Start wupserver

Starts wupserver which allows connecting to the console from a PC using [wupclient](https://gist.github.com/GaryOderNichts/409672b1bd5627b9dc506fe0f812ec9e).

### Load Network Configuration

Loads a network configuration from the SD, and temporarily applies it to use wupserver.
The configurations will be loaded from a `network.cfg` file on the root of your SD.
For using the ethernet adapter, the file should look like this:

```
type=eth
```

For using wifi:

```
type=wifi
ssid=ssidhere
Expand All @@ -52,33 +64,48 @@ key_type=WPA2_PSK_AES
```

### Pair Gamepad

Displays the Gamepad Pin and allows pairing a Gamepad to the system. Also bypasses any region checks while pairing.
The numeric values represent the following symbols: `♠ = 0, ♥ = 1, ♦ = 2, ♣ = 3`.
Note that rebooting the system might be required to use the newly paired gamepad.

### Install WUP

Installs a valid signed WUP from the `install` folder on the root of your SD Card.
Don't place the WUP into any subfolders.

### Edit Parental Controls

Displays the current Parental Controls pin configuration.
Allows disabling Parental Controls.

### Debug System Region

Fixes bricks caused by setting productArea and/or gameRegion to an invalid
value. Symptoms include being unable to launch System Settings or other
in-region titles.

### System Information

Displays info about several parts of the system.
Including serial number, manufacturing date, console type, regions, memory devices...

### Submit System Data

Allows submitting system information to an online database to collect various statistics about Wii U consoles.
This is entirely optional and personally identifying information will be kept confidential.
[The database can be found here!](https://wiiu.gerbilsoft.com/)

### Clone MLC

Clones the MLC to the SD card and overwrites the SD card in the process.
After selecting the Option the SD card will be unmounted and you can replace it with another SD card. You have to confirm then again to start the clone process.
During the clone process the LED will change color between yellow and blue. After the clone is finished the LED will turn purple. If the clone failed it will blink red.
After the clone is done, you should take an Image of the SD card and check it with wfs-extract.
**IMPORTANT:** If you plan to use the clone to replace the eMMC, you should not turn on the console again after the clone until use replaced the eMMC with the clone. If the console was turned on in between the SLC cache will missmatch and and the file system will corrupt irrecoverable. After you booted the console once of the the clone, you can not go back to the original eMMC, or the SLC cache would also missmatch.

## Building

```bash
# build the docker container
docker build -t recoverybuilder .
Expand All @@ -91,6 +118,7 @@ docker run -it --rm -v ${PWD}:/project recoverybuilder make DC_INIT=1
```

## Credits

- [@Maschell](https://github.com/Maschell) for the [network configuration types](https://github.com/devkitPro/wut/commit/159f578b34401cd4365efd7b54b536154c9dc576)
- [@dimok789](https://github.com/dimok789) for [mocha](https://github.com/dimok789/mocha)
- [@hexkyz](https://github.com/hexkyz) for [hexFW](https://github.com/hexkyz/hexFW)
Expand Down

0 comments on commit 3b7b90c

Please sign in to comment.