diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/about.md b/about.md new file mode 100644 index 000000000..c6798e150 --- /dev/null +++ b/about.md @@ -0,0 +1,30 @@ +# About this guide + +This guide was written by staff members of the [Nintendo Homebrew Discord Server](https://discord.gg/C29hYvh) + +> **Credits** +> +> **Flump, jerbear64, Phoenix, xGhostBoyx, Such Meme Many Skill, and oreo639.** +> +> Thank you to [everyone else](https://github.com/nh-server/switch-guide/graphs/contributors) that contributed to the guide on GitHub, but special thanks to **noirscape**. + +?> [You can find this guide on GitHub](https://github.com/nh-server/switch-guide) It is licensed under the [ISC license.](https://github.com/nh-server/switch-guide/blob/master/LICENSE.md) + +
+ Nintendo Homebrew +
+ +> **Developer / Tool credits** +> - **Atmosphere-NX** for [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere). +> - **switchbrew** for [nx-hbloader](https://github.com/switchbrew/nx-hbloader) and [nx-hbmenu](https://github.com/switchbrew/nx-hbmenu). +> - **nwert** and **CTCaer** for [Hekate](https://github.com/CTCaer/hekate). +> - **Flagbrew** for [Checkpoint](https://github.com/FlagBrew/Checkpoint). +> - **mtheall** for [FTPD](https://github.com/mtheall/ftpd/). +> - **joel16** for [NX-Shell](https://github.com/joel16/NX-Shell). +> - **Cease & DeSwitch** for [fusee-gelee](https://github.com/Cease-and-DeSwitch/fusee-launcher). +> - **MenosGrante** for [Rekado](https://github.com/MenosGrante/Rekado). +> - **eliboa** for [TegraRcmGUI](https://github.com/eliboa/TegraRcmGUI). +> - **vgmoose**, **pwsincd**, **rw-r-r_0644** and **crc32** for [hb-appstore](https://github.com/vgmoose/hb-appstore). +> - **exelix** for [nxthemesinstaller and SwitchThemeInjector](https://github.com/exelix11/SwitchThemeInjector). +> - **Essometer** for collecting patched Switch serials. +> - **shchmue** for [Lockpick](https://github.com/shchmue/Lockpick/releases) and [Lockpick_RCM](https://github.com/shchmue/Lockpick_RCM/releases) \ No newline at end of file diff --git a/browser-exploit.md b/browser-exploit.md new file mode 100644 index 000000000..eb47a2751 --- /dev/null +++ b/browser-exploit.md @@ -0,0 +1,11 @@ +# Browser Exploit + +To install CFW, we first need to launch the Homebrew Launcher through the browser exploit. +Make sure your Wii U has internet access for this step. + +### Instructions + +> 1. Take the SD Card out of your Computer and plug it into your Wii U console. +> 2. Launch the internet browser and open `wiiuexploit.xyz`. +> 3. Click on `Run Homebrew Launcher!`. Your console should launch the Homebrew Launcher. +> If your Wii U gets stuck on a white or otherwise frozen screen, [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. diff --git a/changelog.md b/changelog.md new file mode 100644 index 000000000..054b95297 --- /dev/null +++ b/changelog.md @@ -0,0 +1,13 @@ +# Changelog + +> Version 0.2 (16/04/2019) +- Added introduction, getting started and FAQ +- Changed expand to tabs on serials +- Added placeholder graphics and cleaned up theme + +> Version 0.1 (15/04/2019) +- Initial Alpha +- Matched Discords theme +- Added required addons +- Added Discord icon to top right of coverpage and every main section +- Added theme option to top right. Dark and light to start with, more to come later \ No newline at end of file diff --git a/coverpage.md b/coverpage.md new file mode 100644 index 000000000..e1295d952 --- /dev/null +++ b/coverpage.md @@ -0,0 +1,13 @@ + + +> A simple guide from Stock to Atmosphere CFW + +- Backing up and restoring Nand guides +- Introduction to game modding +- Managing your save files +- Dumping Title Keys +- How to theme your user interface + +[Get Started](introduction) +[Discord](https://discord.gg/C29hYvh) +[GitHub](https://github.com/nh-server/switch-guide) \ No newline at end of file diff --git a/faq.md b/faq.md new file mode 100644 index 000000000..8b75d72e2 --- /dev/null +++ b/faq.md @@ -0,0 +1,107 @@ +# FAQ + +### Hackable Switches + +> Currently two hardware revisions of the Switch exist. Any Switch bought before July 2018 has a bootrom bug that allows us to launch CFW regardless of the firmware version on the switch. This bug cannot be fixed by Nintendo once the console leaves the factory, not even if the console is sent in for repairs. This means that all current and future firmwares will be able to launch CFW through this exploit on the old hardware revision. +> +> The first claims of a new hardware revision of the Switch that fixes the exploit needed to launch cfw have been made in July 2018. Currently the only way to know if your Switch is hackable is by trying to send the payload in RCM. Even with this exploit fixed, any Switch on firmware 4.1 and below will be able to launch CFW through other means in the far future. The serial number on the back of the box can possibly tell you which consoles are patched and which aren't. See [GBA Thread](https://gbatemp.net/threads/switch-informations-by-serial-number.481215/) for an up to date list. + +### How safe? + +> The Switch comes with a lot of telemetry, and has been called a "telemetry monster" by several prominent developers. As long as the Switch is connected to the internet, Nintendo gets a report about a lot of different actions and states and has the option to log or act on them. Even if the Switch is offline and connects to the internet at a later point, Nintendo still recieves information about what happened while the Switch was disconnected. +> +> To disable some of this telemetry, it is advised to disable the sending of error reports in the System Settings of the Switch. Additionally if you live in the EU you can set the "do not share" option on [Nintendos Accounts Settings Page](https://accounts.nintendo.com/setting) to prevent your Switch from sending a lot of telemetry. +> +> Nintendo still recieves a lot of information, even with those options disabled. We also cannot know if Nintendo decides to look for something in the logs and ban people in retrospect. They have also shown to expand their telemetry options with every other firmware update. +> +> Currently all bans have been for very obvious and intrusive actions, specifically: +> +> - Developers using their unique Switch data to poke and reverse-engineer Nintendos Server responses +> - People pirating games and using them online +> - People changing their profile pictures to custom pictures +> - People using savegame editors to unlock content that is not available yet and using it online (Splatoon 2) +> - People cheating online in general (Modifying Cart stats in MK8) +> - People installing homebrew NSP files, which Nintendo can pick up on with their telemetry +> - People using unsafe custom firmware (such as ReiNX) that dangerously changes the system version string, creating a massive red flag for Nintendo (Atmosphere safely changes the version string and does not have this problem). +> +> Atmosphere stops some, but ***not all*** of Nintendo's telemetry, and prevents crash reports from being sent. This means Nintendo can't tell if anything, including homebrew or modded games crashed, and Atmosphere dumps the crash log to the SD card to help homebrew developers. However, Nintendo still receives information about what is being played, and general system report information. +> +> Atmosphere is not a silver bullet, and this does not mean that Nintendo won't decide to ban people for harmless homebrew in the future. If you are scared to get banned then don't use homebrew for now. In a future Atmosphere update, we will be able to create a dual-boot (EmuNAND) solution, that allows us to have a clean, online firmware and a seperate offline firmware for homebrew related software. Unbanning on the Switch will be a lot harder than previous Nintendo systems, if not impossible. + +!> **SX OS** + *Team Xecuter's "EmuNAND" is not a proper (or safe) EmuNAND, and Nintendo can pick up on it with their telemetry.* + +### Exploit usage + +> To launch CFW through the exploit, the Switch needs to be in "Recovery Mode"(RCM). The easiest way to enter RCM is by grounding pin 10 in the right joycon rail and holding VOL+ on boot. Several methods and designs to do this exist, see [this page of the guide](../user_guide/entering_rcm) for more information. Once the Switch is in RCM it needs to be connected to either a computer, phone or dongle to send the exploit and the payload. +> +> This procedure needs to happen every time the Switch boots from a completely "off" state, otherwise the Switch will boot into the stock firmware. + +### Recommended Jigs + +> Most people prefer to use 3d-printed jigs to enter RCM. These jigs are made in a way that they slide into the right joycon rail and have a piece of connected wire that then bridges pin 10 and one of the grounded pins on the Switch. A lot of different designs for these jigs exist, but it is important to understand, that these jigs can damage the Switch if they are made in a bad way. +> +> Since the wire in the jig is supposed to touch the pads inside the Switch's joycon rail, it is important to use wire that is thin, not rigid and bent/not pointy. Paperclips make for potentially dangerous jigs, as they are made out of a hard material, are rigid and pointy and can easily scratch off the pads inside the Switch. A good jig uses 32Gauge(0.2mm diameter) wire and is bent in a way that the end of the wire does not scratch the pads. [Switch Jigs](https://switchjigs.com/) sells jigs we consider "good". You can also download and 3d-print your own jig and use the pictures on the website to guide you on how to bend the wire correctly. + +### Auto RCM + +> To enter RCM more comfortably a solution called "AutoRCM" exists. Once set up, this method will always boot the Switch into RCM, even without a jig or holding any buttons. This works by "bricking" the Switch in a controlled manner. The Switch detects that something is wrong and boots into RCM to get repaired. The big downside of this method is, that it is impossible to boot the Switch without a computer, phone or dongle, as it will never boot into stock firmware by itself, and that it requires an SD card with the proper CFW files on it at all times. In addition, if the battery of the Switch is completely drained, the Switch will need to charge to at least 10% in Hekate before launching Atmosphere, otherwise the Switch will refuse to boot due to the low battery. Charging in RCM is not recommended as this is very slow. "AutoRCM" can be uninstalled, but it is advised to keep a working NAND and BOOT0/1 backup before using it. +> +> Many Android-phones are able to send the exploit to the Switch, making them a perfect portable way to launch CFW. Different designs for portable dongles exist, ranging from Raspberry Pi Zero and Arduino projects to internal dongles, that work completely autonomous. The latter should only be done by advanced users, as it requires soldering onto the Switch mainboard itself. + +### Direct CFW + +> In the future there will possibly be methods to launch CFW without needing a computer, phone or dongle to send the exploit and payload from. However, the higher the firmware of the Switch the less likely these exploits become. Currently there is little hope for such an exploit on firmware 5.0+. Even on lower firmwares, this exploit will most likely not directly boot you into CFW from a "off" state, but require you to launch an exploit on the original firmware to then reboot into CFW. +> +> The chances of a persistent, untethered coldboot solution (like on the 3DS and Wii-U) technically exist on firmwares below 3.0.2. + +### Should I update FW? + +> If your Switch is one of the new hardware revisions that patched the exploit in RCM and you are on firmware 4.1.0 or lower, you should not update if you want to have CFW in the forseeable future. +> +> If your Switch is one of the older hardware revisions and you don't mind having to use jigs/hardmods/AutoRCM and sending the exploit via computer, phone or dongle everytime you want to launch into CFW then it is completely safe to update. If you want the chance to maybe, one day, not have to use a external device, then it is recommended to stay on a FW as low as possible. Beware that this means that you potentially need to wait for a very long time (months to years) for this to happen, if ever. Private exploits to launch CFW are known to exist for firmwares up to 4.1. +> +> Downgrading on the Switch is possible, but it requires using AutoRCM and a custom bootloader payload to bypass the Switch's several hardware anti-downgrade mechanisms. This will not work on an unpatched system, and is practically useless for most users. +> +> On every boot the Switch firmware checks how many e-fuses have been burned and how many e-fuses the Switch expects to be burned. Major updates to the Switch, or updates in which a large vulnerability has been patched, irreversibly burn one of the Switch's 32 "e-fuses". If the Switch ever detects that more e-fuses have been burned than expected (meaning a downgrade happened), it will refuse to boot. Replacing e-fuses is not an option. +> +> A method to update without burning e-fuses exists, but, like downgrading, it forces you to use AutoRCM and sending the exploit via USB every time, as booting into the stock firmware even once would instantly burn the e-fuse. Note that other anti-downgrade mechanisms exist, making it for example impossible to boot game carts on a firmware below 4.1 if the Switch has ever launched a game on firmware 4.1+. This can only be worked around by completely disabling the game cart slot while on 4.1 or greater, which is similarly impractical for most users. + +### Homebrew formats + +> Homebrew can come in two different formats, namely in `nro` files and in `kip` files. +> +> `nro` files are placed in the `switch` folder on your SD card and can be launched using the Homebrew menu. +> +> `kip` files are placed in the `atmosphere/kips` folder on your SD card and provide additional services. + +!> **Homebrew risks** + *Be careful with launching downloaded homebrew! If you don't know the source, it's best not to launch it.*

+ *Homebrew can potentially damage your system! Atmosphere provides protections against common bricking methods, but these are not guaranteed to always work!* + +### No homebrew showing + +> This is an issue primarily affecting macOS users, but may occur on other devices as well. If you are able to launch the homebrew menu, but you are not seeing some or any of your homebrew, you will need to unset the archive bit with Hekate. +> +> 1. [Send the Hekate payload to your Switch](../user_guide/sending_payload/). +> 2. Navigate to `Tools` with the volume buttons and press power to confirm. +> 3. Navigate to `Fix archive bit (except Nintendo folder)` with the volume buttons and press power to confirm. +> 4. Wait a bit, this may take a while. +> 5. Press any button to continue. +> 6. Navigate to `Fix archive bit (Nintendo folder)` with the volume buttons and press power to confirm. +> 7. Wait a bit, this may take a while. +> 8. Press any button to continue. +> 9. Navigate to `Back...` with the volume buttons and press power to confirm. +> 10. Follow the instructions at [Launching CFW](../user_guide/launching_cfw/) to launch Atmosphere. + +### Which microSD? + +> microSD cards that are 32GB or smaller can be used for homebrew, but are not recommended as these will not permit you to have a full NAND dump and an emuNAND in the future. +> +> The recommended microSD card size is 128GB. This will permit you to make a full NAND dump as well as having enough space to run an emuNAND in the future while also having adequate space for homebrew. +> +> The recommended filesystem format is FAT32. While the Switch supports exFAT through an additional update from Nintendo, this filesystem is prone to corruption and as a result is not advisable. + +!> **Fake microSD cards** + Do not buy microSD cards from sites like eBay. These microSD cards are often fake and do not have the advertised amount of storage and will result in data corruption if used. Consumer grade microSD cards do not exist in capacities over 512GB and any that advertise that they are 512GB or larger are fake.

+ If you suspect your microSD card is fake or damaged, see the instructions [here](https://3ds.filthycasuals.tech/sderrors.html) to verify the integrity of your SD card. diff --git a/getting-started.md b/getting-started.md new file mode 100644 index 000000000..b2cdd566a --- /dev/null +++ b/getting-started.md @@ -0,0 +1,56 @@ +# Getting Started + +### Different CFWs + +The first thing to decide is what CFW you want to use. + +There are two main CFWs: + + + +#### **Haxchi** +- Requires a legitimately installed paid DS VC game from the eShop. +- Can be used to launch CFW directly from the Wii U Menu. +- Needs to be re-launched from the Wii U Menu every reboot to enable CFW. +- It's functionality can be extended by installing ColdBootHaxchi (CBHC) to a Haxchi installation. + +#### **Haxchi and ColdBootHaxchi (CBHC)** +!> Installing CBHC incorrectly can brick your Wii U. Make sure to follow the following rules when installing CBHC: + - The DS game has to be legitimately installed from the eShop + - Don't format the system while CBHC is installed + - Don't delete the user account that bought the DS VC game + - Don't re-install the same game using wup installer or from the eShop + - Don't install Haxchi over CBHC + +- Requires a working Haxchi installation. +- Automatically launches CFW on every boot. + + + +### Compatible DS VC Games + +?> This is only needed if you want to use Haxchi or CBHC as your CFW. Mocha CFW does not require a game. + +The following games are compatible with Haxchi: +- Animal Crossing: Wild World +- Big Brain Academy +- Brain Age +- DK: Jungle Climber +- Dr. Kawashima’s Brain Training +- Kirby: Canvas Curse +- Kirby: Mass Attack +- Kirby: Squeak Squad / Kirby: Mouse Attack +- Legend of Zelda: Phantom Hourglass +- Legend of Zelda: Spirit Tracks +- Mario & Luigi: Partners in Time +- Mario Kart DS +- New Super Mario Bros. +- Pokemon Mystery Dungeon: Explorers of the Sky +- Starfox Command +- Super Mario 64 DS +- Wario: Master of Disguise +- WarioWare: Touched +- Yoshi’s Island DS +- Yoshi’s Touch & Go + +Currently Brain Age is the cheapest title for 6.99 USD. diff --git a/index.html b/index.html new file mode 100644 index 000000000..ffdc8cb57 --- /dev/null +++ b/index.html @@ -0,0 +1,73 @@ + + + + + + + + + NH Wii U Guide + + + + + + + + + + + +
+ + + + + + + + + + + + + + + diff --git a/installing-hbc.md b/installing-hbc.md new file mode 100644 index 000000000..b6df08055 --- /dev/null +++ b/installing-hbc.md @@ -0,0 +1,33 @@ +# Installing the Homebrew Channel + +This page will install the Homebrew Channel as an application directly to your Home Menu for easy access. + +?> This page is only for Haxchi and CBHC users. The Home-Menu Homebrew Channel will **not** work with Mocha CFW! + +### Instructions + + + +#### **Haxchi** + +> 1. Power on your console +> 2. Launch the Haxchi DS game from the Wii U Menu. This will re-launch the Wii U Menu with CFW activate. +> 3. Launch the Haxchi DS game again while holding the A button. This will launch the Homebrew Launcher. +> 4. Navigate the Homebrew Launcher and launch the WUP Installer GX2 app. +> 5. Use the touchscreen to select `hbc`. Press `Install` and confirm with `Yes`. +> 6. Select NAND as the installation destination. This will install the Homebrew Channel to the Wii U Menu. +> 7. Once the process is finished, press the Home button until you're back at the Wii U Menu. +> 8. You will now see the Homebrew Channel installed on your Wii U Menu. Keep in mind you will need to launch cfw every reboot to run this channel. +> 9. You can now re-attach any USB devices you had attached before starting the guide. +### **CBHC** + +> 1. Power on your console +> 2. Press the Home button during the `Autobooting...` screen to get into the boot menu. +> 3. Select `Boot Homebrew Launcher` to launch the Homebrew Launcher. +> 4. Navigate the Homebrew Launcher and launch the WUP Installer GX2 app. +> 5. Use the touchscreen to select `hbc`. Press `Install` and confirm with `Yes`. +> 6. Select NAND as the installation destination. This will install the Homebrew Channel to the Wii U Menu. +> 7. Once the process is finished, press the Home button until you're back at the Wii U Menu. +> 8. You will now see the Homebrew Channel installed on your Wii U Menu. +> 9. You can now re-attach any USB devices you had attached before starting the guide. + diff --git a/introduction.md b/introduction.md new file mode 100644 index 000000000..320c615b6 --- /dev/null +++ b/introduction.md @@ -0,0 +1,50 @@ +# NH Wii U Guide + +A guide collaboration between Nintendo Homebrew's Helpers and Staff, from stock to CBHC custom firmware. + +?> **Discord Help** +For live support with this guide please visit us in **#wiiu-assistance** on [Nintendo Homebrew Discord](https://discord.gg/C29hYvh). + +### Homebrew + +> Homebrew applications are custom, user-made software, which haven’t been authorised by Nintendo. This can include save editing tools, games, emulators, and more. +> +> Homebrew can be run on your Wii U as long as you have a way to put files on an SD Card regardless of version or region. + +### Custom Firmware + +> Custom Firmware (“CFW”) enables you to use more advanced hacks that userland homebrew can’t easily do. For instance, installing game modifications with ease. +> +> +> Among other things, it allows you to do the following: +> * Use “ROM hacks” for games that you own +> * Backup, edit, and restore saves for many games +> * Play games for older systems with various emulators, using RetroArch or other standalone emulators +> * Play out-of-region games +> +> CFW can be set up on any console on any version (but will require additional software). +### End Goal + +> This guide has the end goal of taking a completely unmodified Wii U from Stock to Custom Firmware. + +### Before starting + +!> Before beginning the guide, you must know the risks of Wii U hacking: EVERY time you modify your system, there is always the potential for an UNRECOVERABLE brick. They’re rare but still a possibility so make sure you follow ALL directions EXACTLY. +> +> This guide will work on all Wii U consoles in all regions on firmware 5.5.4 or below. +> +> You will need one of the following in order to successfully follow this guide: +> +> - An SD Card +> - A device such as a Computer to place files onto the SD Card +> - A Wii U with internet access +> +> Your SD card should preferably be 32 gigabytes large, as a full NAND backup for the console will take up around 8 or 30 gigabytes depending on your model. + +If everything goes according to plan, you will lose no data and end up with everything that you started with (games, NNID, saves, etc will be preserved). + +Keep your device plugged in and charged throughout the entire process to avoid data loss or damage from an unexpected power-off. + +Custom Firmware is not permanent with current methods, and will be unloaded upon rebooting the system. + +It is advised that you read the entire guide from start to finish one or more times before actually running through the guide with your system. diff --git a/launching-cfw.md b/launching-cfw.md new file mode 100644 index 000000000..799f8277d --- /dev/null +++ b/launching-cfw.md @@ -0,0 +1,48 @@ +# Launching CFW + +Now that you have your NAND backup in case anything goes wrong later, you can run CFW on your system. + +Unlike systems such as the DSi, Wii, or 3DS, Wii U CFW is temporary. This means that as soon as your system reboots, you will lose CFW and have to follow these instructions again. This can be skipped by installing CBHC to a Haxchi CFW installation. + +### Instructions + + + +#### **Haxchi** + +> 1. Take the SD Card out of your PC and plug it into your Wii U. +> 2. If you haven't already, now download your DS VC game of choice from the eShop. +> 3. Launch the Homebrew Launcher on your system as [previously explained](/browser-exploit). +> 4. Navigate the Homebrew Launcher and open the Haxchi app. +> 5. Use the DPAD to navigate the cursor to the game you want to install haxchi to and press the A button to install it. +> 6. Once the installation has finished, your console will launch the system menu. You will see your game replaced by a haxchi icon. +> 7. Run the modified DS game. This will reboot the console and enable CFW. +> 8. You will need to run your Haxchi DS game every reboot to launch CFW. + +#### **Haxchi and CBHC** + +> 1. Take the SD Card out of your PC and plug it into your Wii U. +> 2. If you haven't already, now download your DS VC game of choice from the eShop. +> 3. Launch the Homebrew Launcher on your system as [previously explained](/browser-exploit). +> 4. Navigate the Homebrew Launcher and open the Haxchi app. +> 5. Use the DPAD to navigate the cursor to the game you want to install haxchi to and press the A button to install it. +> 6. Once the installation has finished, your console will launch the system menu. You will see your game replaced by a haxchi icon. +> 7. Run the modified DS game. This will reboot the console and enable CFW. +> 8. Run the modified DS game again and hold the A button after launching it. This will run the Homebrew Launcher. +> 9. Navigate the Homebrew launcher and run the CBHC app. +> 10. Use the DPAD to navigate the cursor to the game you previously installed haxchi to and press the A button to install CBHC. +> 11. Once the installation has finished, your console will launch the system menu. +> 12. Reboot your console. If CBHC installed correctly, you should see a new boot menu. +> 13. Use the DPAD to navigate to `Autoboot: Disabled` and press the A button until it says `Autoboot: System Menu`. +> 14. Use the DPAD to navigate to `Boot System Menu` and press the A button. This will launch the Wii U Menu with CFW enabled. +> 15. Your console now automatically boots into CFW every reboot. + +#### **Mocha** + +> 1. Take the SD Card out of your PC and plug it into your Wii U. +> 2. Launch the Homebrew Launcher on your system as [previously explained](/browser-exploit). +> 3. Navigate the Homebrew Launcher and open the Mocha app. +> 4. Your console will launch the system menu and enable CFW. +> 5. You will need to re-do these steps every reboot to launch cfw. + + diff --git a/md-syntax.md b/md-syntax.md new file mode 100644 index 000000000..e794f52dc --- /dev/null +++ b/md-syntax.md @@ -0,0 +1,559 @@ +# Markdown Syntax + +## Headings + + + +#### ** Rendered ** + +# Heading 1 {docsify-ignore} + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. + +## Heading 2 {docsify-ignore} + +Vestibulum lobortis laoreet nunc vel vulputate. + +### Heading 3 {docsify-ignore} + +Suspendisse sit amet tincidunt nibh, ac interdum velit. + +#### Heading 4 {docsify-ignore} + +Donec odio orci, facilisis ac vehicula in, vestibulum ut urna. + +##### Heading 5 {docsify-ignore} + +Commodo sit veniam nulla cillum labore ullamco aliquip quis. + +###### Heading 6 {docsify-ignore} + +Ipsum ea amet dolore mollit incididunt fugiat nulla laboris est sint voluptate. + +#### ** Markdown ** + +```markdown +# Heading 1 + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. + +## Heading 2 + +Vestibulum lobortis laoreet nunc vel vulputate. + +### Heading 3 + +Suspendisse sit amet tincidunt nibh, ac interdum velit. + +#### Heading 4 + +Donec odio orci, facilisis ac vehicula in, vestibulum ut urna. + +##### Heading 5 + +Commodo sit veniam nulla cillum labore ullamco aliquip quis. + +###### Heading 6 + +Ipsum ea amet dolore mollit incididunt fugiat nulla laboris est sint voluptate. +``` + + + +## Text + + + +#### ** Rendered ** + +Body text + +**Bold text** + +*Italic text* + +~~Strikethrough~~ + +Marked text + +
Preformatted text
+ +Small Text + +This is subscript + +This is superscript + +#### ** Markdown ** + +```markdown +Body text + +**Bold text** + +*Italic text* + +~~Strikethrough~~ + +Marked text + +
Preformatted text
+ +Small Text + +This is subscript + +This is superscript +``` + + + +## Links + + + +#### ** Rendered ** + +[Inline link](https://google.com) + +[Inline link with title](https://google.com "Google") + +[Reference link by name][link1] + +[Reference link by number][1] + +[Reference link by self] + +[link1]: https://google.com +[1]: https://google.com +[Reference link by self]: https://google.com + +#### ** Markdown ** + +```markdown +[Inline link](https://google.com) + +[Inline link with title](https://google.com "Google") + +[Reference link by name][link1] + +[Reference link by number][1] + +[Reference link by self] + +[link1]: https://google.com +[1]: https://google.com +[Reference link by self]: https://google.com +``` + + + +## Lists + + + +#### ** Rendered ** + +**Ordered Lists** + +1. Ordered 1 +1. Ordered 2 + 1. Ordered 2a + 1. Ordered 2b + 1. Ordered 2c +1. Ordered 3 + +**Unordered Lists** + +- Unordered 1 +- Unordered 2 + - Unordered 2a + - Unordered 2b + - Unordered 2c +- Unordered 3 + +**Task Lists** + +- [x] Task 1 +- [ ] Task 2 + - [x] Subtask A + - [ ] Subtask B +- [ ] Task 3 + +#### ** Markdown ** + +```markdown +**Ordered Lists** + +1. Ordered 1 +1. Ordered 2 + 1. Ordered 2a + 1. Ordered 2b + 1. Ordered 2c +1. Ordered 3 + +**Unordered Lists** + +- Unordered 1 +- Unordered 2 + - Unordered 2a + - Unordered 2b + - Unordered 2c +- Unordered 3 + +**Task Lists** + +- [x] Task 1 +- [ ] Task 2 + - [x] Subtask A + - [ ] Subtask B +- [ ] Task 3 +``` + + + +## Blockquotes + + + +#### ** Rendered ** + +> Cras aliquet nulla quis metus tincidunt, sed placerat enim cursus. Etiam +> turpis nisl, posuere eu condimentum ut, interdum a risus. Sed non luctus mi. +> Quisque malesuada risus sit amet tortor aliquet, a posuere ex iaculis. Vivamus +> ultrices enim dui, eleifend porttitor elit aliquet sed. +> +> *- Quote Source* + +#### ** Markdown ** + +```markdown +> Cras aliquet nulla quis metus tincidunt, sed placerat enim cursus. Etiam +> turpis nisl, posuere eu condimentum ut, interdum a risus. Sed non luctus mi. +> Quisque malesuada risus sit amet tortor aliquet, a posuere ex iaculis. Vivamus +> ultrices enim dui, eleifend porttitor elit aliquet sed. +> +> *- Quote Source* +``` + + + +## Notices + + + +#### ** Rendered ** + +!> **Important** notice with `inline code` and additional placeholder text used +to force the content to wrap and span multiple lines. + +?> **Tip** notice with `inline code` and additional placeholder text used to +force the content to wrap and span multiple lines. + +#### ** Markdown ** + +```markdown +!> **Important** notice with `inline code` and additional placeholder text used +to force the content to wrap and span multiple lines. + +?> **Tip** notice with `inline code` and additional placeholder text used to +force the content to wrap and span multiple lines. +``` + + + +## Tabs + + + +#### **English** + +Hello! + +#### **French** + +Bonjour! + +#### **Italian** + +Ciao! + +#### ** Markdown ** + +```markdown + + +#### **English** + +Hello! + +#### **French** + +Bonjour! + +#### **Italian** + +Ciao! + + +``` + + + +## Horizontal Rule + + + +#### ** Rendered ** + +--- + +#### ** Markdown ** + +```markdown +--- +``` + + + +## Images + + + +#### ** Rendered ** + +![alt text](assets/img/serial-location.jpg) + +> ![alt text](assets/img/serial-switch.png) + +#### ** Markdown ** + +```markdown +![alt text](assets/img/serial-location.jpg) + +> ![alt text](assets/img/serial-switch.png) +``` + + + +## Thumbnails + + + +#### ** Rendered ** + +**Thumbnails (4)** + +
+ alt text + alt text + alt text + alt text +
+ +**Thumbnails (2)** + +
+ alt text + alt text +
+ +**Default image with shadows from thumbnail css** + +
+ alt text +
+ +#### ** Markdown ** + +```markdown +**Thumbnails (4)** + +
+ alt text + alt text + alt text + alt text +
+ +**Thumbnails (2)** + +
+ alt text + alt text +
+ +**Default image with shadows from thumbnail css** + +
+ alt text +
+``` + + + +## Code Window + + + +#### ** Rendered ** + +Windows Joiner Script + +```cmd +copy /b rawnand.bin.* rawnand.bin +``` + +Linux/Mac Joiner Script + +```terminal +#!/usr/bin/env bash +if command -v pv >/dev/null; then + cat rawnand.bin.* | pv -s 30g > rawnand.bin +else + cat rawnand.bin.* > rawnand.bin +fi +``` + +#### ** Markdown ** + +````markdown +Windows Joiner Script + +```cmd +copy /b rawnand.bin.* rawnand.bin +``` + +Linux/Mac Joiner Script + +```terminal +#!/usr/bin/env bash +if command -v pv >/dev/null; then + cat rawnand.bin.* | pv -s 30g > rawnand.bin +else + cat rawnand.bin.* > rawnand.bin +fi +``` +```` + + + +## Tables + + + +#### ** Rendered ** + +| Left Align | Center Align | Right Align | Non‑Breaking Header | +| ---------- |:------------:| -----------:| ------------------------------ | +| A1 | A2 | A3 | A4 | +| B1 | B2 | B3 | B4 | +| C1 | C2 | C3 | C4 | + +#### ** Markdown ** + +```markdown +| Left Align | Center Align | Right Align | Non‑Breaking Header | +| ---------- |:------------:| -----------:| ------------------------------ | +| A1 | A2 | A3 | A4 | +| B1 | B2 | B3 | B4 | +| C1 | C2 | C3 | C4 | +``` + + + +## Keyboard + + + +#### ** Rendered ** + +↑ Arrow Up + +↓ Arrow Down + +← Arrow Left + +→ Arrow Right + +⇪ Caps Lock + +⌘ Command + +⌃ Control + +⌫ Delete + +⌦ Delete (Forward) + +↘ End + +⌤ Enter + +⎋ Escape + +↖ Home + +⇞ Page Up + +⇟ Page Down + +⌥ Option, Alt + +↵ Return + +⇧ Shift + +␣ Space + +⇥ Tab + +⇤ Tab + Shift + +#### ** Markdown ** + +```markdown +↑ Arrow Up + +↓ Arrow Down + +← Arrow Left + +→ Arrow Right + +⇪ Caps Lock + +⌘ Command + +⌃ Control + +⌫ Delete + +⌦ Delete (Forward) + +↘ End + +⌤ Enter + +⎋ Escape + +↖ Home + +⇞ Page Up + +⇟ Page Down + +⌥ Option, Alt + +↵ Return + +⇧ Shift + +␣ Space + +⇥ Tab + +⇤ Tab + Shift +``` + + \ No newline at end of file diff --git a/nand-backup.md b/nand-backup.md new file mode 100644 index 000000000..973d8aa86 --- /dev/null +++ b/nand-backup.md @@ -0,0 +1,19 @@ +# Making a NAND Backup + +In case anything should go wrong in the later process and your Wii U ends up bricked, restoring a previously made NAND backup can fix it. + +### Instructions + +?> The Wii U NAND is (depending on your model) either 8 or 32gb. As a result of this, to create a full backup of your console's NAND, your SD Card has to be larger than the size of your NAND. If you do not have a large enough SD Card, you can skip the optional `MLC` section which includes save files and game data. + +> 1. Navigate through the Homebrew Launcher and launch the `Wii U NAND Dumper` app. +> 2. Use the Wii U Gamepad's DPAD to enter the following configuration: + - Dump SLPC: **yes** + - Dump SLCCMPT: **yes** + - Dump MLC: **optional** + - Dump OTP: **yes** + - Dump SEEPROM: **yes** +> 3. Press the A button to start the dumping process. +> 4. When the process completed, power off your Wii U, take your SD Card out of the Wii U and plug it into your PC. +> 5. To make sure you don't lose the files, copy the `slc.bin`, `slccmpt.bin`, `seeprom.bin`, and, if you chose to go with a full backup, `every mlc.bin.part` file to your computer. +> 6. Delete the files from your SD Card to free up space. diff --git a/navbar.md b/navbar.md new file mode 100644 index 000000000..d6712884c --- /dev/null +++ b/navbar.md @@ -0,0 +1,4 @@ +- Themes + - Dark + - Light +- [![Discord](assets/img/discord.png)](https://discord.gg/C29hYvh) \ No newline at end of file diff --git a/sd-preparation.md b/sd-preparation.md new file mode 100644 index 000000000..420d9c50c --- /dev/null +++ b/sd-preparation.md @@ -0,0 +1,106 @@ +# SD Preparation + +We will now place the required CFW files and some additional homebrew files on the SD card. + +!> If you are installing Haxchi or CBHC, make sure to unplug any USB devices attached to the console before further following the guide! + +?> **Notice** + Your SD card will need to be formatted as FAT32. If your SD Card is not formatted to FAT32, use [GUIFormat](http://www.ridgecrop.demon.co.uk/index.htm?guiformat.htm) with 32k (32768) Allocation unit size to format it. + +### What you need + + + +#### **Haxchi** + +> - The Haxchi [config](/files/config.txt) +> - The latest release of [Homebrew Launcher Installer](https://github.com/wiiu-env/homebrew_launcher_installer/releases/latest) +> - You will need to download the `payload.zip` file. +> - The 1.4 release of [The Homebrew Launcher](https://github.com/dimok789/homebrew_launcher/releases/tag/1.4) +> - You will need to download the v1.4 `homebrew_launcher.v1.4.zip` release of The Homebrew Launcher +> - The latest release of [WUP Installer GX2](http://wiiubru.com/appstore/zips/wup_installer_gx2.zip) +> - The latest release of [The Homebrew Launcher Channel](https://github.com/dimok789/homebrew_launcher/releases/latest) +> - You will need to download the `channel.zip` file. +> - The latest release of [Wii U NAND Dumper](https://github.com/koolkdev/wiiu-nanddumper/releases/latest) +> - The latest release of the [Homebrew App Store](https://github.com/vgmoose/hbas/releases/latest) +> - You will need to download the `-wiiu-exracttosd.zip` file. +> - The latest release of [Haxchi](https://github.com/FIX94/haxchi/releases/latest) +> - Download only the Haxchi .zip file. + +#### **Haxchi and CBHC** + +> - The Haxchi [config](/files/config.txt) +> - The latest release of [Homebrew Launcher Installer](https://github.com/wiiu-env/homebrew_launcher_installer/releases/latest) +> - You will need to download the `payload.zip` file. +> - The 1.4 release of [The Homebrew Launcher](https://github.com/dimok789/homebrew_launcher/releases/tag/1.4) +> - You will need to download the v1.4 `homebrew_launcher.v1.4.zip` release of The Homebrew Launcher +> - The latest release of [WUP Installer GX2](http://wiiubru.com/appstore/zips/wup_installer_gx2.zip) +> - The latest release of [The Homebrew Launcher Channel](https://github.com/dimok789/homebrew_launcher/releases/latest) +> - You will need to download the `channel.zip` file. +> - The latest release of [Wii U NAND Dumper](https://github.com/koolkdev/wiiu-nanddumper/releases/latest) +> - The latest release of the [Homebrew App Store](https://github.com/vgmoose/hbas/releases/latest) +> - You will need to download the `-wiiu-exracttosd.zip` file. +> - The latest release of [Haxchi and CBHC](https://github.com/FIX94/haxchi/releases/latest) +> - Download both the Haxchi and CBHC .zip files. + +#### **Mocha** + +> - The Mocha [config](/files/config.ini) +> - The latest release of [Homebrew Launcher Installer](https://github.com/wiiu-env/homebrew_launcher_installer/releases/latest) +> - You will need to download the `payload.zip` file. +> - The 1.4 release of [The Homebrew Launcher](https://github.com/dimok789/homebrew_launcher/releases/tag/1.4) +> - You will need to download the v1.4 `homebrew_launcher.v1.4.zip` release of The Homebrew Launcher +> - The latest release of [WUP Installer GX2](http://wiiubru.com/appstore/zips/wup_installer_gx2.zip) +> - The latest release of [Wii U NAND Dumper](https://github.com/koolkdev/wiiu-nanddumper/releases/latest) +> - The latest release of the [Homebrew App Store](https://github.com/vgmoose/hbas/releases/latest) +> - You will need to download the `-wiiu-exracttosd.zip` file. +> - The latest release of [Mocha](https://www.wiiubru.com/appstore/zips/mocha.zip) + + + + +### Instructions + + + +#### **Haxchi** + +> 1. Insert your Wii U's SD card into your PC +> 2. Extract the `Haxchi.zip` file to the root of your SD Card +> 3. Copy the `config.txt` file to the `haxchi` folder on your SD Card. Overwrite files if asked +> 5. Copy the `payload.elf` from the `payload.zip` to the `wiiu` folder on your SD Card +> 6. Extract the `wup_installer_gx2.zip` file to the root of your SD Card +> 7. Extract the `nanddumper.zip` file to the root of your SD Card +> 8. Extract the `wiiu-extracttosd.zip` file to the root of your SD Card +> 9. Extract the `homebrew_launcher.v.1.4.zip` to the root of your SD Card +> 10. Create a folder called `install` on the root of your SD Card +> 11. Create a folder called `hbc` in the `install` folder you created +> 12. Extract the `homebrew_launcher_channel.zip` file to the `hbc` folder you created + +#### **Haxchi and CBHC** + +> 1. Insert your Wii U's SD card into your PC +> 2. Extract the `Haxchi.zip` file to the root of your SD Card +> 3. Extract the `CBHC.zip` file to the root of your SD Card +> 4. Copy the `config.txt` file to the `haxchi` folder on your SD Card. Overwrite files if asked +> 6. Copy the `payload.elf` from the `payload.zip` to the `wiiu` folder on your SD Card +> 7. Extract the `wup_installer_gx2.zip` file to the root of your SD Card +> 8. Extract the `nanddumper.zip` file to the root of your SD Card +> 9. Extract the `wiiu-extracttosd.zip` file to the root of your SD Card +> 10. Extract the `homebrew_launcher.v.1.4.zip` to the root of your SD Card +> 11. Create a folder called `install` on the root of your SD Card +> 12. Create a folder called `hbc` in the `install` folder you created +> 13. Extract the `homebrew_launcher_channel.zip` file to the `hbc` folder you created + +#### **Mocha** + +> 1. Insert your Wii U's SD card into your PC +> 2. Extract the `mocha.zip` file to the root of your SD Card +> 3. Copy the `config.ini` file to the `/wiiu/apps/mocha` folder on your SD Card +> 5. Copy the `payload.elf` from the `payload.zip` to the `wiiu` folder on your SD Card +> 6. Extract the `wup_installer_gx2.zip` file to the root of your SD Card +> 7. Extract the `nanddumper.zip` file to the root of your SD Card +> 8. Extract the `wiiu-extracttosd.zip` file to the root of your SD Card +> 9. Extract the `homebrew_launcher.v.1.4.zip` to the root of your SD Card + + diff --git a/sidebar.md b/sidebar.md new file mode 100644 index 000000000..160e91535 --- /dev/null +++ b/sidebar.md @@ -0,0 +1,17 @@ +- **User Guide** +- [Introduction](introduction) +- [Getting Started](getting-started) +- [SD Preparation](sd-preparation) +- [Browser Exploit](browser-exploit) +- [Making a NAND Backup](nand-backup) +- [Launching CFW](launching-cfw) +- [Installing the Homebrew Channel](installing-hbc) +- [FAQ](faq) +- **Extras** +- [Themes](themes) +- [Changelog](changelog) +- [MD Syntax](md-syntax) +- [About](about) +- **Links** +- [![Github](https://icongram.jgog.in/simple/github.svg?color=808080&size=16)Github](https://github.com/nh-server/switch-guide) +- [![Discord](https://icongram.jgog.in/simple/discord.svg?colored&size=16)Discord](https://discord.gg/C29hYvh) diff --git a/themes.md b/themes.md new file mode 100644 index 000000000..1c310f513 --- /dev/null +++ b/themes.md @@ -0,0 +1,25 @@ +# Themes + +### Dark + +A clean, versatile theme featuring a Discord dark color scheme with vibrant accents, a [system font stack](https://css-tricks.com/snippets/css/system-font-stack/), a gradient +background cover page, and visual indicators for drop-menus and expand/collapse +state. + +Preview + +
+ Screenshot of coverpage + Screenshot of content +
+ +### Light + +A modified version of the Dark theme featuring a light color scheme. + +Preview + +
+ Screenshot of coverpage + Screenshot of content +
\ No newline at end of file