From 2b75c137572e60d00c906066b65269c56f5871c3 Mon Sep 17 00:00:00 2001 From: Vanny <48239094+VannyBuns@users.noreply.github.com> Date: Tue, 26 Dec 2023 23:55:02 -0500 Subject: [PATCH] Rewrite vWii Modding Guide (#197) * Rewrite vWii Modding Guide * Move vWii guide to User Guide --- docs/sidebar.md | 3 +- docs/user-guide/introduction.md | 2 +- docs/user-guide/vwii/browser-exploit.md | 34 +++---- docs/user-guide/vwii/finalizing-setup.md | 31 ++++++ docs/user-guide/vwii/installing-cioses.md | 27 +++++ .../vwii/installing-homebrewchannel.md | 10 ++ docs/user-guide/vwii/nand-backup.md | 20 ++++ docs/user-guide/vwii/patching-ios80.md | 17 ++++ docs/user-guide/vwii/sd-preparation.md | 31 ++++++ docs/user-guide/vwii/sidebar.md | 12 ++- docs/vwii/vwii-modding.md | 98 ------------------- index.html | 13 ++- 12 files changed, 172 insertions(+), 126 deletions(-) create mode 100644 docs/user-guide/vwii/finalizing-setup.md create mode 100644 docs/user-guide/vwii/installing-cioses.md create mode 100644 docs/user-guide/vwii/installing-homebrewchannel.md create mode 100644 docs/user-guide/vwii/nand-backup.md create mode 100644 docs/user-guide/vwii/patching-ios80.md create mode 100644 docs/user-guide/vwii/sd-preparation.md delete mode 100644 docs/vwii/vwii-modding.md diff --git a/docs/sidebar.md b/docs/sidebar.md index 7d1096662..47b3d7789 100644 --- a/docs/sidebar.md +++ b/docs/sidebar.md @@ -1,8 +1,7 @@ - **User Guide** - [Introduction](introduction) - [Tiramisu](tiramisu/sd-preparation) -- **vWii** -- [vWii Modding](vwii-modding) +- [vWii Modding](vwii/sd-preparation) - **Troubleshooting** - [Common Issues & Fixes](common-issues-fixes) - [Recover a vWii IOS/Channel](recover-vwii-ioses-channels) diff --git a/docs/user-guide/introduction.md b/docs/user-guide/introduction.md index aa221716b..bbe573f9a 100644 --- a/docs/user-guide/introduction.md +++ b/docs/user-guide/introduction.md @@ -3,7 +3,7 @@ A guide collaboration between Nintendo Homebrew's Helpers and Staff, from stock to Tiramisu custom firmware. ?> **Discord Help** -For live support with this guide please visit us in **#wiiu-assistance** on the [Nintendo Homebrew Discord](https://discord.gg/C29hYvh) and ask, in English, for assistance. Please read **#faq-wiiu**, as well as our [Frequently Asked Questions](faq) page beforehand to see if your question has already been answered. +For live support with this guide please visit us in **#wiiu-vwii-assistance** on the [Nintendo Homebrew Discord](https://discord.gg/C29hYvh) and ask, in English, for assistance. Please read **#faq-wiiu**, as well as our [Frequently Asked Questions](faq) page beforehand to see if your question has already been answered. > If you appreciate this guide, we accept [donations](donations). diff --git a/docs/user-guide/vwii/browser-exploit.md b/docs/user-guide/vwii/browser-exploit.md index 361f9135d..19f8a2b07 100644 --- a/docs/user-guide/vwii/browser-exploit.md +++ b/docs/user-guide/vwii/browser-exploit.md @@ -1,17 +1,17 @@ -# Launching an Exploit ---- -To install the Homebrew Channel, we first need to create a NAND backup and be able to launch the Homebrew Launcher through an exploit, such as the Browser Exploit. - -Make sure your Wii U has internet access for this step. - -### Instructions {docsify-ignore} - -1. Launch an exploit of your choice: - - If you've never run homebrew before, "launching the exploit" means run the Browser Exploit. To run the Browser Exploit launch the Internet Browser and navigate to the website `wiiuexploit.xyz`, then click on `Run Exploit!` - - If your Wii U gets stuck on a white or otherwise frozen screen, wait a few seconds. If nothing happens, reboot the console, [reset the browser's save data](https://en-americas-support.nintendo.com/app/answers/detail/a_id/1507/~/how-to-delete-the-internet-browser-history) and try again. - - - If you're coldbooting into the PayloadLoader, "launching the exploit" means booting your console. - - - If you're launching into the PayloadLoader via the Health & Safety application, "launching the exploit" means launching the Health & Safety Application. - -1. While launching the exploit of your choice, hold either the B button (if you're following the `NAND Backup` section) or the X button (if you're following the `Installing the Homebrew Channel` section). +# Launching an Exploit +--- +To install the Homebrew Channel, we first need to create a NAND backup and be able to launch the Homebrew Launcher through an exploit, such as the Browser Exploit. + +Make sure your Wii U has internet access for this step. + +### Instructions {docsify-ignore} + +1. Launch an exploit of your choice: + - If you've never run homebrew before, "launching the exploit" means run the Browser Exploit. To run the Browser Exploit launch the Internet Browser and navigate to the website `wiiuexploit.xyz`, then click on `Run Exploit!` + - If your Wii U gets stuck on a white or otherwise frozen screen, wait a few seconds. If nothing happens, reboot the console, [reset the browser's save data](https://en-americas-support.nintendo.com/app/answers/detail/a_id/1507/~/how-to-delete-the-internet-browser-history) and try again. + + - If you're coldbooting into the PayloadLoader, "launching the exploit" means booting your console. + + - If you're launching into the PayloadLoader via the Health & Safety application, "launching the exploit" means launching the Health & Safety Application. + +1. While launching the exploit of your choice, hold either the B button (if you're following the `NAND Backup` section) or the X button (if you're following the `Installing the Homebrew Channel` section). diff --git a/docs/user-guide/vwii/finalizing-setup.md b/docs/user-guide/vwii/finalizing-setup.md new file mode 100644 index 000000000..c84020fe7 --- /dev/null +++ b/docs/user-guide/vwii/finalizing-setup.md @@ -0,0 +1,31 @@ +# vWii Modding Guide {docsify-ignore-all} + +## Finalizing Setup + +Now that the required cIOSes and IOS80 patch have been applied, we are now going to finalize the setup. + +### Additional Homebrew Apps + +- **SaveGame Manager GX** allows you to backup and restore your saves and Miis, especially saves that can't usually be copied. +- **Nintendont** is a virtual machine that allows you to play Gamecube games. +- The **Open Shop Channel** is an appstore where you can download more apps. + +### Additional Homebrew Apps - What You Need + +- The latest release of [SaveGame Manager GX](https://hbb1.oscwii.org/api/v3/contents/SaveGame_Manager_GX/SaveGame_Manager_GX.zip) +- The `loader.dol`, `meta.xml` and `icon.png` of [Nintendont](https://github.com/GaryOderNichts/Nintendont) +- The `Homebrew Browser.zip` of the [Open Shop Channel](https://hbb1.oscwii.org/api/v3/contents/homebrew_browser/homebrew_browser.zip) + +### Additional Homebrew Apps - Extracting Files to the SD Card +1. Extract and copy the contents of `SaveGame_Manager_GX.zip` to the root of the SD card. +1. Follow the instructions in the link for copying Nintendont. +1. Extract the contents of the `homebrew_browser.zip` to the root of the SD card. + +### USB Loaders +In order to play Wii games, you will need a USB loader. There are two popular loaders called WiiFlow Lite and USB Loader GX. Both can be found on [this site](https://wii.hacks.guide/wii-loaders). + +### Installing Priiloader + +Yes, Priiloader now works on vWii! The guide for installing it can be found [here](https://wii.hacks.guide/priiloader). + +!> Priiloader versions before 0.10.0 do not work with vWii. Priiloader versions before 0.8.2 will brick your vWii. diff --git a/docs/user-guide/vwii/installing-cioses.md b/docs/user-guide/vwii/installing-cioses.md new file mode 100644 index 000000000..f0bd6070a --- /dev/null +++ b/docs/user-guide/vwii/installing-cioses.md @@ -0,0 +1,27 @@ +# vWii Modding Guide {docsify-ignore-all} + +## Installing cIOSes + +!> Make sure you have no `.wad` files anywhere else than in the `apps` folder on your SD Card. + +1. Power on your Wii U and launch vWii. +1. Launch The Homebrew Channel. +1. Launch d2x cIOS Installer. +1. Set everything to match the following: + - Select cIOS: `d2x-v11-beta1-vWii` + - Select cIOS base: `56` + - Select cIOS slot: `249` +1. Press the `A` button to install. +1. Set everything to match the following: + - Select cIOS: `d2x-v11-beta1-vWii` + - Select cIOS base: `57` + - Select cIOS slot: `250` +1. Press the `A` button to install. +1. Set everything to match the following: + - Select cIOS: `d2x-v11-beta1-vWii` + - Select cIOS base: `58` + - Select cIOS slot: `251` +1. Press the `A` button to install. +1. Press the `B` button to exit. + +!> If you are only getting `d2x-v6` or `d2x-v11-beta1`, redownload the app and/or make sure your SD card is unlocked. diff --git a/docs/user-guide/vwii/installing-homebrewchannel.md b/docs/user-guide/vwii/installing-homebrewchannel.md new file mode 100644 index 000000000..7358ad391 --- /dev/null +++ b/docs/user-guide/vwii/installing-homebrewchannel.md @@ -0,0 +1,10 @@ +# vWii Modding Guide {docsify-ignore-all} + +## Installing the Homebrew Channel + +1. Boot into [Tiramisu](browser-exploit). +1. Launch the Homebrew Launcher, by opening the Mii Maker. +1. Launch the `compat_installer.rpx`. +1. Press `A` to install the Homebrew Channel and wait until you see `Install succeeded`. Then press the HOME button to return to the Wii U Menu. +1. Launch vWii (the Wii Menu icon). + - If the installation has succeeded, you should see the Homebrew Channel in your Wii Menu. diff --git a/docs/user-guide/vwii/nand-backup.md b/docs/user-guide/vwii/nand-backup.md new file mode 100644 index 000000000..d9714ffb4 --- /dev/null +++ b/docs/user-guide/vwii/nand-backup.md @@ -0,0 +1,20 @@ +# vWii Modding Guide {docsify-ignore-all} + +## NAND Backup + +In case anything goes wrong in the later process and your vWii ends up bricked, restoring a previously made NAND backup can fix it. + +?> If you have recently made a NAND backup that includes SLCCMPT and OTP, feel free to skip this step. + +1. Launch the [Wii U NAND Dumper](browser-exploit). +1. Use the Wii U GamePad's D-Pad to enter the following configuration: + - Dump SLC: **optional** + - Dump SLCCMPT: **yes** + - Dump MLC: **optional** + - Dump OTP: **yes** + - Dump SEEPROM: **optional** +1. Press the A button to start the dumping process. +1. When the process completed, power off your Wii U, take your SD Card out of the Wii U and plug it into your PC. +1. To make sure you don't lose the files, copy the `slccmpt.bin` and `otp.bin` files (and if you chose to go with a full backup, `seeprom.bin`, `slc.bin`, and `every mlc.bin.part` file) to your computer. +1. Delete the files from your SD Card to free up space. +1. Take the SD Card out of your computer and plug it into your Wii U console. diff --git a/docs/user-guide/vwii/patching-ios80.md b/docs/user-guide/vwii/patching-ios80.md new file mode 100644 index 000000000..3c84a1bcc --- /dev/null +++ b/docs/user-guide/vwii/patching-ios80.md @@ -0,0 +1,17 @@ +# vWii Modding Guide {docsify-ignore-all} + +## Patching IOS 80 (Optional) + +Patching IOS 80 allows you to have custom channels on the SD card, including wads. However, it is not required. + +!> If for any reason, the Wii U is turned off while patching IOS 80, your vWii will be bricked. This can be fixed by either extracting the IOS 80 from your previously made NAND backup and then replacing it over FTP or by [reinstalling IOS 80](recover-vwii-ioses-channels). + +1. Launch Patched IOS 80 Installer for vWii. +1. Read the warning screen and wait 30 seconds. +1. Press any buttons to install. +1. Wait until it says IOS80 Installation is complete!. +1. Press any button to exit. + +!> Installing custom System Menu is a definite brick risk and you should always have an effective backup before installing one but when done right, won't brick the vWii. + +!> Installing any IOS (including TED IOSes) or wads made for the original Wii on your vWii will brick it. WiiWare wads are fine, but some need to be converted to work. diff --git a/docs/user-guide/vwii/sd-preparation.md b/docs/user-guide/vwii/sd-preparation.md new file mode 100644 index 000000000..e5a47b57c --- /dev/null +++ b/docs/user-guide/vwii/sd-preparation.md @@ -0,0 +1,31 @@ +# vWii Modding Guide {docsify-ignore-all} +--- +## SD Preparations + +This page will guide you through the process of modding your vWii. + +We will now start by placing the required Homebrew files on the SD Card. + +?> **Notice** + Your SD Card will need to be formatted as FAT32. If your SD Card is not formatted to FAT32, use [GUIFormat](http://ridgecrop.co.uk/index.htm?guiformat.htm) with 32k (32768) Allocation unit size to format it. **Do not** label the SD Card as `wiiu` or it will cause issues with homebrew. + +?> If you have hacked your Wii U in the past, you can use the same SD Card for this process. + + +### What You Need + +- The latest files from [Tiramisu for your café](https://tiramisu.foryour.cafe). + - Click on `Download Tiramisu`. + - If you have already installed Tiramisu, you do not need to redownload it. +- The latest release of the [Compat Title Installer](https://hb-app.store/wiiu/CompatTitleInstaller). +- The Patched IOS 80 Installer for vWii. ([Source](https://github.com/Lazr1026/Patched-IOS80-Installer-for-vWii)) +- The d2x cIOS Installer. + +## Instructions + +1. Insert your Wii U's SD Card into your PC. +1. Copy the `apps` folder from the `Patched_IOS80_Installer_for_vWii.zip` file to the root of your SD Card. +1. Copy the `d2x-cios-installer` from the `d2x_cIOS_Installer.zip` file to the apps folder on your SD Card. +1. Copy the contents of the downloaded Tiramisu *`.zip`* file to the root of your SD Card. +1. Copy the contents of the `CompatTitleInstaller.zip` file to the root of your SD Card. +1. Take the SD Card out of your computer and plug it into your Wii U console. diff --git a/docs/user-guide/vwii/sidebar.md b/docs/user-guide/vwii/sidebar.md index 7c305eec1..f16a4a8b6 100644 --- a/docs/user-guide/vwii/sidebar.md +++ b/docs/user-guide/vwii/sidebar.md @@ -1,10 +1,14 @@ -- **Navigation** +**vWii Modding** - [Home Page](../introduction) -- [vWii Modding](../vwii-modding) -- [Browser Exploit](browser-exploit) +- [SD Preparation](sd-preparation) +- [NAND Backup](nand-backup) +- [Installing the Homebrew Channel](installing-homebrewchannel) +- [Installing cIOSes](installing-cioses) +- [Patching IOS 80 (Optional)](patching-ios80) +- [Finalizing Setup](finalizing-setup) - **Links** - [![GitHub](https://icongr.am/simple/github.svg?color=808080&size=16)GitHub](https://github.com/hacks-guide/Guide-WiiU) - [![Discord](https://icongr.am/simple/discord.svg?colored&size=16)Discord](https://discord.gg/C29hYvh) - [![Translate](https://icongr.am/material/translate.svg?color=808080&size=16)Translate](https://hacks-guide.crowdin.com/u/projects/10) - [Donate](../donations) -- [About](../about) \ No newline at end of file +- [About](../about) diff --git a/docs/vwii/vwii-modding.md b/docs/vwii/vwii-modding.md deleted file mode 100644 index 93bd31d50..000000000 --- a/docs/vwii/vwii-modding.md +++ /dev/null @@ -1,98 +0,0 @@ -# vWii Modding Guide ---- -This page will guide you through the process of modding your vWii. - -We will now start by placing the required Homebrew files on the SD Card. - -?> **Notice** - Your SD Card will need to be formatted as FAT32. If your SD Card is not formatted to FAT32, use [GUIFormat](http://ridgecrop.co.uk/index.htm?guiformat.htm) with 32k (32768) Allocation unit size to format it. **Do not** label the SD Card as `wiiu` or it will cause issues with homebrew. - -?> If you have hacked your Wii U in the past, you can use the same SD Card for this process. - - - -### What You Need {docsify-ignore} - -- The latest files from [Tiramisu for your café](https://tiramisu.foryour.cafe). - - Click on `Download Tiramisu`. - - If you have already installed Tiramisu, you do not need to redownload it. -- The latest release of the [vwii-compat-installer](https://github.com/TheLordScruffy/vwii-compat-installer/releases). -- The Patched IOS 80 Installer for vWii. ([Source](https://github.com/Lazr1026/Patched-IOS80-Installer-for-vWii)) -- The d2x cIOS Installer. - -### SD Preparations {docsify-ignore} - -1. Insert your Wii U's SD Card into your PC. -1. Copy the `apps` folder from the Patched_IOS80_Installer_for_vWii.zip file to the root of your SD Card. -1. Copy the `d2x-cios-installer` from the d2x_cIOS_Installer.zip file to the apps folder on your SD Card. -1. Copy the contents of the downloaded Tiramisu *`.zip`* file to the root of your SD Card. -1. Copy the `compat_installer.elf` file to the `wiiu/apps` folder on the root of your SD Card. -1. Take the SD Card out of your computer and plug it into your Wii U console. - -### NAND Backup - -In case anything goes wrong in the later process and your vWii ends up bricked, restoring a previously made NAND backup can fix it. - -?> If you have recently made a NAND backup that includes SLCCMPT and OTP, feel free to skip this step. - -1. Launch the [Wii U NAND Dumper](vwii/browser-exploit). -1. Use the Wii U GamePad's D-Pad to enter the following configuration: - - Dump SLC: **optional** - - Dump SLCCMPT: **yes** - - Dump MLC: **optional** - - Dump OTP: **yes** - - Dump SEEPROM: **optional** -1. Press the A button to start the dumping process. -1. When the process completed, power off your Wii U, take your SD Card out of the Wii U and plug it into your PC. -1. To make sure you don't lose the files, copy the `slccmpt.bin` and `otp.bin` files, and if you chose to go with a full backup, `seeprom.bin`, `slc.bin`, and `every mlc.bin.part` file to your computer. -1. Delete the files from your SD Card to free up space. -1. Take the SD Card out of your computer and plug it into your Wii U console. - -### Installing the Homebrew Channel - -1. Boot into [Tiramisu](vwii/browser-exploit). -1. Launch the Homebrew Launcher, by opening the Mii Maker. -1. Launch the compat_installer. -1. Press `A` to install the Homebrew Channel and wait until you see `Install succeeded`. Then press the HOME button to return to the Wii U Menu. -1. Launch vWii (the Wii Menu icon). - - If the installation has succeeded, you should see the Homebrew Channel in your Wii Menu. - -### Installing cIOSes - -!> Make sure you have no `.wad` files anywhere else than in the `apps` folder on your SD Card. - -1. Power on your Wii U and launch vWii. -1. Launch The Homebrew Channel. -1. Launch d2x cIOS Installer. -1. Set everything to match the following: - - Select cIOS: `d2x-v11-beta1-vWii` - - Select cIOS base: `56` - - Select cIOS slot: `249` -1. Press the `A` button to install. -1. Set everything to match the following: - - Select cIOS: `d2x-v11-beta1-vWii` - - Select cIOS base: `57` - - Select cIOS slot: `250` -1. Press the `A` button to install. -1. Set everything to match the following: - - Select cIOS: `d2x-v11-beta1-vWii` - - Select cIOS base: `58` - - Select cIOS slot: `251` -1. Press the `A` button to install. -1. Press the `B` button to exit. - -### Patching IOS 80 - -!> If for any reason, the Wii U is turned off while patching IOS 80, your vWii will be bricked. This can be fixed by either extracting the IOS 80 from your previously made NAND backup and then replacing it over FTP or by [reinstalling IOS 80](recover-vwii-ioses-channels). - -1. Launch Patched IOS 80 Installer for vWii. -1. Read the warning screen and wait 30 seconds. -1. Press any buttons to install. -1. Wait until it says IOS80 Installation is complete!. -1. Press any button to exit. - -!> Installing custom System Menu is a definite brick risk and you should always have an effective backup before installing one but when done right, won't brick the vWii. - -!> Installing any IOS (including TED IOSes) or wads made for the original Wii on your vWii will brick it. - -!> Priiloader versions before 0.10.0 do not work with vWii. Priiloader versions before 0.8.2 will brick your vWii. diff --git a/index.html b/index.html index 7933b8f5f..9e152cdd9 100644 --- a/index.html +++ b/index.html @@ -51,9 +51,13 @@ '/aroma/sd-preparation' : '/docs/user-guide/aroma/sd-preparation.md', '/aroma/finalizing-setup' : '/docs/user-guide/aroma/finalizing-setup.md', // vWii - '/vwii-modding' : '/docs/vwii/vwii-modding.md', - '/vwii/sidebar.md' : '/docs/user-guide/vwii/sidebar.md', - '/vwii/browser-exploit' : '/docs/user-guide/vwii/browser-exploit.md', + '/vwii/sidebar.md' : '/docs/user-guide/vwii/sidebar.md', + '/vwii/sd-preparation' : '/docs/user-guide/vwii/sd-preparation.md', + '/vwii/nand-backup' : '/docs/user-guide/vwii/nand-backup.md', + '/vwii/installing-homebrewchannel' : '/docs/user-guide/vwii/installing-homebrewchannel.md', + '/vwii/installing-cioses' : '/docs/user-guide/vwii/installing-cioses.md', + '/vwii/patching-ios80' : '/docs/user-guide/vwii/patching-ios80.md', + '/vwii/finalizing-setup' : '/docs/user-guide/vwii/finalizing-setup', // Troubleshooting '/recover-vwii-ioses-channels' : '/docs/troubleshooting/recover-vwii-ioses-channels.md', '/common-issues-fixes' : '/docs/troubleshooting/common-issues-fixes.md', @@ -487,6 +491,7 @@ '/es_ES/vwii-modding' : '/translations/es_ES/docs/vwii/vwii-modding.md', '/es_ES/vwii/sidebar.md' : '/translations/es_ES/docs/user-guide/vwii/sidebar.md', '/es_ES/vwii/browser-exploit' : '/translations/es_ES/docs/user-guide/vwii/browser-exploit.md', + // Troubleshooting '/es_ES/recover-vwii-ioses-channels' : '/translations/es_ES/docs/troubleshooting/recover-vwii-ioses-channels.md', '/es_ES/common-issues-fixes' : '/translations/es_ES/docs/troubleshooting/common-issues-fixes.md', @@ -651,4 +656,4 @@ - \ No newline at end of file +