Some forms of ROM can be rewritten under very specific scenarios, such as [EEPROM](https://en.wikipedia.org/wiki/EEPROM) (electronically-erasable/programmable ROM). - **[TegraRCMGUI](https://github.com/eliboa/TegraRcmGUI/releases)/[fusee-interface-tk](https://github.com/nh-server/fusee-interfacee-tk/releases)**: Software used to run the fusee-gelee exploit on the Switch. +- **Stock**: "Stock" generally refers to the original factory operation or state of something.
For example, stock firmware means the original operation of Horizon, not using CFW. - **Tegra X1**: [A chip made by Nvidia that is used in the Nintendo Switch.](https://en.wikipedia.org/wiki/Tegra#Tegra_X1) -- **Trinket**: A tiny chip that is soldered on the Switch motherboard to automatically send a payload if it is in RCM. +- **Trinket**: A category of modchip that is soldered on the Switch motherboard to automatically send a payload if it is in RCM. They are not necessarily always the Trinket brand, as this refers to the category of modchip. - **TrustZone**: The highest security level on the Switch. - **XCI/NSP**: Format used to dump games to. XCI is used for gamecard dumps, while NSP is for dumping digital titles. diff --git a/docs/extras/img/ban.png b/docs/extras/img/ban.png new file mode 100644 index 00000000..48b3ca41 Binary files /dev/null and b/docs/extras/img/ban.png differ diff --git a/docs/extras/index.md b/docs/extras/index.md new file mode 100644 index 00000000..c1b549cb --- /dev/null +++ b/docs/extras/index.md @@ -0,0 +1,12 @@ +# Extras + +Several extra guides that are not required for basic usage can be found here. + +They are listed in the sidebar. + +### **Commonly used guides**: + +- [Get started](index.md) +- [Updating CFW](updating.md) +- [Blocking Nintendo servers](blocking_nintendo.md) +- [Changing microSD cards](transfer_sd.md) diff --git a/docs/extras/installing_android.md b/docs/extras/installing_android.md new file mode 100644 index 00000000..3c821ceb --- /dev/null +++ b/docs/extras/installing_android.md @@ -0,0 +1,133 @@ +# Installing Android + +This page will detail the setup of the latest release of Switchroot Android (Android 11) for the Nintendo Switch. + +!!! warning "Have you partitioned your microSD card?" + This page assumes that you've followed our guide to set up Atmosphère. Before starting, your microSD card needs partitions for Android set up via Hekate.
+ If you didn't do so, see [this page](../user_guide/all/partitioning_sd_syscfw.md) to install Android alongside Atmosphère. If you don't want to use Switch CFW and only Android, check the [Official Switchroot Documentation](https://wiki.switchroot.org/wiki/android/11-r-setup-guide) instead.
+ If you already have Android fully installed, do not follow this guide, as your current installation would be erased. + +!!! info "Looking for Android 10?" + An unfortunate bug with clocking on Android 11 results in degraded performance for Erista (v1) units on Android 11. Android 10 installation is not covered here, but there is a [guide](https://wiki.switchroot.org/wiki/android/10-q-setup-guide) on the Switchroot Wiki. However, Android 11 is the currently supported version and uses much more updated drivers. + + The Switch lacks a cell modem; simply installing Android does not grant your Switch access to cell towers. This means, unlike most Android devices, you will not be able to make emergency phone calls, and you will still need Wi-Fi to access the Internet. You can, however, natively run Android programs and games. + +This page will also *not* detail things such as rooting and overclocking; external links to these types of additions can be found in the [Power User Guides](#power-user-guides) section at the bottom of this page. + +### **Requirements:** +- A Nintendo Switch console that is capable of running Hekate.
+- A microSD card *larger than* 8GB. + - Please consult the [Switchroot microSD Card Guide](https://wiki.switchroot.org/wiki/sd-card-guide) before buying! +- A good quality, data-transfer capable USB-A to USB-C cable. + - C to C is unstable, but this will be fixed in the next release. +- A computer. + +### **Instructions:** + +#### Step 0: Preparation + +If you have official Joy-Con controllers, you can set up auto-pairing so undocking them seamlessly connects to the console regardless of what OS is running. To make this work, boot HOS, ensure both work undocked (pair them), then reboot to Hekate. Select `Nyx Options` followed by `Dump Joy-Con BT`. You should see "Found 2 out of 2 Joy-Con pairing data!" + +!!! tip "Have a Switch Lite?" + You should poke the dump button in Hekate anyway -- this will dump factory stick and IMU calibration for use in Android. + +----- + +#### Step 1: Downloading Files + +Download the latest `.7z` release archive from [the official Switchroot download site](https://download.switchroot.org/android-11/)--choose `nx-atv...` for Android TV (more console-like experience) or `nx-tab...` for standard Android (a more standard Android tablet experience). Both are usable with controllers and docking, but only tab supports proper touch input. + +!!! tip "If you prefer [TWRP recovery](https://twrp.me/)..." + ...you can download `twrp.img` from the [extras folder](https://download.switchroot.org/android-11/extras/). + +----- + +#### Step 2: Arranging the microSD Card + +!!! tip "Are you using a V1 or V2 Switch (standard models)?" + These models have a poorly designed microSD card reader and repeated removals/reinsertions can eventually cause the reader to fail. Please use Hekate SD UMS to transfer files instead of removing the microSD card from your Switch! + + - This can be done by booting into Hekate and going to `Tools` > `USB Tools` > `SD Card` and plugging your Switch into your PC via USB. + +Extract the archive to the root of the microSD card (the FAT32 partition). The microSD card file structure should look more or less like this: + +``` +root +|- bootloader +| |- ini +| | |- ... +| |- payloads +| | |- ... +| |- res +| | |- ... +| |- sys +| | |- ... +|- Nintendo (if you use Horizon) +| |- ... +|- switchroot +| |- android +| | |- ... +| |- install +| | |- ... +|- lineage-18.1-[date]-UNOFFICIAL-[device].zip +``` + +!!! tip "If you downloaded TWRP..." + ...you have to replace `/switchroot/install/recovery.img` with `twrp.img`. No need to rename the file, just swap it out. + +----- + +#### Step 3: Flashing Android + +Open the Hekate partition manager (located in `Tools` > `Partition SD Card`) and select Flash Android at the bottom of your screen. All three images should be found and successfully flashed. Select the option to reboot to recovery. + +Once in recovery, select `Factory Reset` followed by `Format Data`. This *does not delete anything here*, but rather is used to prepare your data partitions for flashing. Ignore any errors that may appear. Return to the main menu and select `Apply Update` followed by `Select from SWITCH SD`. Find and select the `lineage-18.1...` zip in the list, and wait for it to finish. + +!!! warning "Did the zip fail to flash?" + Your microSD card is probably bad... Take a look at Hekate's microSD card info, and consider buying a better card. + +!!! tip "If you are using TWRP..." + Good luck... TWRP is for advanced users; no user support will be provided. TWRP is provided for power users who have a specific need for it. + +Once done, reboot the system when prompted -- Android is now installed! + +### **Post-Install** + +#### Tips and Tricks + +- If Joy-Con autopairing has not kicked in, try a reboot. Sometimes the first boot doesn't pick up the addition. + +- To access recovery/TWRP: hold `VOL+` on boot or reboot. + +- To access Hekate from Android: hold `VOL-` on reboot. + +- To reboot back to Android: hold `Power` for a few seconds and perform a standard reboot. + +- To return to Horizon (`OFW/CFW`): power your Switch off fully, then boot into your desired mode. + +#### Power User Guides + +To learn more about using the Switch Configuration App and overclocking, see the [Switch Configuration App](https://wiki.switchroot.org/wiki/android/11-r-setup-guide#switch-configuration-app) section. Furthermore, you can check out the [INI guide](https://wiki.switchroot.org/wiki/android/11-r-ini-guide) as well. + +### **Need Help?** + +Join the [Switchroot Discord server](https://discord.gg/N9PPYXjWMY). + +----- + +This page was made in collaboration with `makinbacon21` on Discord. See the collapsible section below for the Switchroot guide maintainers. + +??? note "Switchroot Project Staff (Android / Linux)" + If you'd like, you can donate to the people who made this project possible using these links. + + - makinbacon (Android developer) + [https://paypal.me/makinbacon21](https://paypal.me/makinbacon21) + + - npjohnson (Android developer) + [https://paypal.me/nolenjohnson](https://paypal.me/nolenjohnson) + + - CTCaer (Linux & Low level developer, Hekate maintainer) + [https://www.patreon.com/ctcaer](https://www.patreon.com/ctcaer) + + - ave (Infrastructure & Hosting) + [https://patreon.com/aveao](https://patreon.com/aveao) diff --git a/docs/extras/installing_linux.md b/docs/extras/installing_linux.md new file mode 100644 index 00000000..697cf441 --- /dev/null +++ b/docs/extras/installing_linux.md @@ -0,0 +1,42 @@ +# Installing Linux 4 Switch + +!!! warning "Have you partitioned your microSD card?" + This guide assumes that you've followed the NH-Server guide up until this point, your microSD card should be partitioned accordingly. If you didn't do so, see [this page](../user_guide/all/partitioning_sd_syscfw.md) of our guide. + +Linux 4 Switch is a sister project to Switchroot Android--it uses a similar kernel but provides a variety of Linux distributions.The available distributions at this time are: + +- Ubuntu Bionic (maintained by CTCaer, the primary dev of both the L4S kernel and hekate--this is the most stable and supported distro) + +- Ubuntu Jammy (maintained by theofficialgman, one of the primary devs of the L4T Megascript installer program) + +- Fedora 39 (maintained by azkali, a L4S kernel developer) + +- Lakka 5.x (maintained by gavin_darkglider, a L4S kernel developer and Lakka maintainer) + +!!! info "Looking for Arch?" + Unfortunately, L4S Arch Linux is deprecated following an xorg ABI change that breaks compatibility with the Tegra210 BSP. + + +### **The installation** +To install an L4S distribution, follow the official guide starting from [0. Linux Distributions](https://wiki.switchroot.org/wiki/linux/linux-distributions). + +- **Note:** You can skip partitioning your microSD card since you partitioned your microSD card during the NH-Server guide. Start from step 4. during the [Installation](https://wiki.switchroot.org/wiki/linux/linux-install-update-guide#installation) section. + +----- + +This page was made in collaboration with `makinbacon21` on Discord. See the collapsible section below for the L4S guide maintainers. + +??? note "L4S Project Staff (Android / Linux)" + If you'd like, you can donate to the people who made this project possible using these links. + + - CTCaer (Linux & Low level developer, Hekate maintainer) + [https://www.patreon.com/ctcaer](https://www.patreon.com/ctcaer) + + - Azkali (Linux & Low level developer) + [https://www.patreon.com/azkali](https://www.patreon.com/azkali) + + - gavin_darkglider (Linux & Lakka developer) + [https://paypal.me/gavindarkglider](https://paypal.me/gavindarkglider) + + - ave (Infrastructure & Hosting) + [https://patreon.com/aveao](https://patreon.com/aveao) diff --git a/docs/extras/nandrestore.md b/docs/extras/nandrestore.md index a8d86ba5..48bffc89 100644 --- a/docs/extras/nandrestore.md +++ b/docs/extras/nandrestore.md @@ -1,38 +1,45 @@ -## Restore a NAND backup to the switch +## Restore a NAND backup to the Switch !!! danger "Warning:" - -This will reset all of your saves, games, system version and other system settings back to a point when you made the the nand backup. Keep this in mind, as you probably don't have to restore a nand backup unless you have bricked your switch or want to go back online safely after using cfw. - - -If you're going to restore an old NAND which will downgrade your firmware it's best to create a second NAND backup before restoring the first one in case something goes wrong. + - This will reset all of your saves, games, system version and other system settings back to the point of when you made the NAND backup. Keep this in mind, as you probably don't have to restore a NAND backup unless you have bricked your Switch or want to go back online safely after using CFW. + + - If you're going to restore an old NAND which will downgrade your firmware it's best to create a second NAND backup before restoring the first one in case something goes wrong. ### What you need: - Your `rawnand.bin` (Combined or in 15 or 30 parts) - Your `BOOT0` and `BOOT1` - If you're missing any of the files above, ask for further help in the [Nintendo Homebrew](https://discord.gg/C29hYvh) Discord server. - The Hekate Payload -- A microSD card larger than 32gb +- A microSD card larger than 32GB ### Instructions: -Before we start, check if you have a tree of folders called `backup/[8 Character NAND id]/restore` on your sd card. +Before we start, check if you have a tree of folders called `backup/[8 Character NAND id]/restore` on your microSD card. -!!! warning "If you don't see a backup or [8 Character NAND id] folder on your sd card:" +!!! warning "If you don't see a backup or [8 Character NAND id] folder on your microSD card:" This means you do not have a nand backup, it is highly recommended you make one as soon as possible. Follow the steps below to make one. - 1. Launch the latest Hekate payload on your switch. - 2. Navigate to `Tools > Backup eMMC > eMMC BOOT0 & BOOT1` and let it do its thing. - 3. Wait for the process to complete. When it's completed, you now have a `backup/[8 Character NAND id]/restore` folder on your sd card. Continue with step 1 of the guide. + 1. Launch the latest Hekate payload on your Switch. + 2. Navigate to `Tools` > `Backup eMMC` > `eMMC BOOT0 & BOOT1` and let it do its thing. + 3. Wait for the process to complete. When it's completed, you now have a `backup/[8 Character NAND id]/restore` folder on your microSD card. Continue with step 1 of the instructions below. -1. Copy your `rawnand.bin` (combined or in 15 or 30 parts), `BOOT0`, and `BOOT1` to the `backup/[8 Character NAND id]/restore` folder on the sd card. -2. Put your sd card into your switch, and launch Hekate. -3. Navigate to `Tools > Restore eMMC`. Select `Restore eMMC BOOT0 & BOOT1`. Wait for this process to complete. -4. In that same menu, select `eMMC RAW GPP` and wait for the process to complete. This will take a very long time to complete. +1. Enter RCM and inject the Hekate payload. + - If you use a modchipped Switch, you can simply just turn your Switch on with the Hekate payload renamed to `payload.bin` on the root of your SD. +2. Navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. +3. Copy your `rawnand.bin` (combined or in 15 or 30 parts), `BOOT0`, and `BOOT1` to the `backup/[8 Character NAND id]/restore` folder on the microSD card. +4. Eject the `UMS` device safely from within your computer's operating system. +5. Navigate to `Tools` > `Restore eMMC`. Select `Restore eMMC BOOT0 & BOOT1`. Wait for this process to complete. +6. In that same menu, select `eMMC RAW GPP` and wait for the process to complete. + - This will generally take a long time to complete, the time it takes depends on your microSD card's specifications. (10-15 minutes is expected.) !!! danger "If you're downgrading using your NAND backup" If the security version you were on before you performed the NAND restore is HIGHER than the NAND backup itself, you have to enable autoRCM to not get stuck in a boot crash. + + - Note: This section can be disregarded for modchipped Switch users. + A system update is considered a security version when a fuse is burned, you can check **which versions burn fuses here**. - If you were in autorcm before you upgraded to a newer security version (and still were after the upgrade) you don't have to do this. + If you were in AutoRCM before you upgraded to a newer security version (and still were after the upgrade) you don't have to do this. 1. In Hekate's main menu, navigate to `Tools` and go to the bottom of the page where you will find a button called `Archive bit - AutoRCM` 2. Select the `AutoRCM` buttom and you will see `ON` written next to it. This means it is enabled. diff --git a/docs/extras/rcm_injectors.md b/docs/extras/rcm_injectors.md index 48551b15..be6befeb 100644 --- a/docs/extras/rcm_injectors.md +++ b/docs/extras/rcm_injectors.md @@ -1,4 +1,4 @@ -# RCM Payload Injectors +# RCM Payload Injectors There are currently multiple RCM payload injectors available from multiple different companies and individuals. These devices remove the need to use a computer or smartphone when hacking an unpatched Switch. Each injector has its own advantages and disadvantages, listed below: diff --git a/docs/extras/save_management.md b/docs/extras/save_management.md deleted file mode 100644 index 9cfc2688..00000000 --- a/docs/extras/save_management.md +++ /dev/null @@ -1,19 +0,0 @@ -# Save Management - -For save management, [JKSV](https://github.com/J-D-K/JKSV) is recommended. It can be used to back up and restore game saves to your SD card. - -[Checkpoint](https://github.com/FlagBrew/Checkpoint) is also a save manager. It can be used to back up and restore game saves to your SD card. It also has the ability to share save data over FTP and WiFi. - - - -### JKSV -Please read JKSV's [homepage](https://github.com/J-D-K/JKSV) for information on how to use it. - -!!! tip "" -  - -### Checkpoint -Please read Checkpoint's [homepage](https://github.com/Flagbrew/Checkpoint) for information on how to use it. - -!!! tip "" -  diff --git a/docs/extras/showing_file_extensions.md b/docs/extras/showing_file_extensions.md index 27179347..fd98b523 100644 --- a/docs/extras/showing_file_extensions.md +++ b/docs/extras/showing_file_extensions.md @@ -1,15 +1,18 @@ -# Showing File Name Extensions on Windows 10 +# Showing File Name Extensions on Windows 10/11 -By default, Microsoft Windows 10 does not show file extensions for known file types. This can result in problems when you need to rename files. +By default, Microsoft Windows 10 and 11 do not show file extensions for known file types. This can result in problems when you need to rename files. - +### **Instructions for Windows 10:** -### Instructions +1. Open a new File Explorer window. +2. Switch to the View tab/ribbon. +3. On this tab, if the `File name extensions` checkbox is not ticked, put a check/tick mark in it by clicking it. -!!! tip "" - 1. Open a new File Explorer window. - 2. Switch to the View tab/ribbon. - 3. On this tab, if the "File name extensions" checkbox is blank, put a check/tick mark in it by clicking it. +### **Instructions for Windows 11:** + +1. Open a new File Explorer window. +2. Click the `View` hamburger menu/dropdown menu. +3. Go to `Show` at the bottom and ensure that `File name extensions` is ticked. !!! tip ""  diff --git a/docs/extras/theming.md b/docs/extras/theming.md deleted file mode 100644 index e553cd03..00000000 --- a/docs/extras/theming.md +++ /dev/null @@ -1,87 +0,0 @@ -# Theming - -You can create unique styles and layouts for your Switch Home Menu. - - - -!!! tip "" -  - -!!! tip "What to follow" - Follow the `Making a theme` section if you want to make a theme. - - Follow the `Installing a theme` section if you want to install a theme - - Follow the `Installing a custom font` sectio - n if you want to install a custom font - - - -## Making a theme (Windows) - -### What you need - -The latest release of **Switch Theme Injector** - -- You need to download the `ReleaseVx.x.zip` on the download page - -### Making the theme - -1. Unzip `ReleaseVx.x.zip` to somewhere on your pc's drive. -2. Open up the `SwitchThemes.exe` app. Navigate to `NXTheme Builder`. -3. Select a Home menu part, A 720p image and a Layout patch. Click on `Build NXTheme` after selecting your home menu part, image and layout patch. -4. Fill out the details in the window that pops up. After filling out this window and clicking ok, you will get asked where to save the NXTheme file. Save this file to a temporary folder. -5. Repeat step 3 and 4 for every Home Menu part of the Switch you want to modify. - - - -## Making a theme (Mac / Linux / Chrome OS) - -### Making the theme - -Make sure that the images you want to use are 1280x720 and in JPG! - -1. Navigate to **Exelix's Web Injector**. -2. Select a Theme Target you want to edit. After this, click the Open an Image button and select your background image. -3. Choose a theme name and an author name and optionally a different layout, then click build NxTheme. -4. Your browser will prompt you to download a file. Save this file to a temporary folder. -5. Repeat step 2 to 4 for every Home Menu part of the Switch you want to modify. - - - -## Installing a theme - -!!! tip "Community Themes" - If you want to use community themes, for example from the **r/NXThemes**, you can follow the guide below to install a community provided nxtheme. - -!!! tip "Homebrew app store" - If you want to use the homebrew app store for themes, you can simply install the theme you want via the appstore, and follow the instructions from step 2 onwards below. - -1. Copy the `.nxtheme` files to the `themes` folder on your sd card (It is recommended you put them into their own folders, e.g. /themes/awesome_theme/awesome.nxtheme). - - Create the `themes` folder on the root of your sd card if it does not exist. - -2. Boot Switch CFW, launch the Homebrew Menu and launch `NXThemes Installer`. -3. Your theme files should be listed here. You can install them one by one. -4. Reboot your switch to see the changes. - - - -## Installing a custom font - -1. Put a font in the .ttf file format into the `themes` folder (It is recommended you put them into their own folders, e.g. /themes/cool_font/font.ttf). -2. Boot Switch CFW, launch the Homebrew Menu and launch `NXThemes Installer`. -3. Find your font and install it. -4. Reboot your switch to see the changes. - - - - -## Troubleshooting: -My Switch crashes on boot after I installed a theme!: - -- You installed a bad theme. You can remove it by going into the `/atmosphere/contents/0100000000001000/romfs/lyt` and deleting every file in that folder. - - Note: `contents` is called `titles` on Atmosphere versions 0.9.4 and below. - -The NXTheme installer crashes when I launch it: - -- This is probably due to the archive bit being set on either the app or the nxthemes. This is usually the result of copying files to an sd card via a Mac. If you are experiencing this issue, try resetting the archive bit via Hekate for all files. diff --git a/docs/extras/transfer_sd.md b/docs/extras/transfer_sd.md index 90b7751e..68df4ecd 100644 --- a/docs/extras/transfer_sd.md +++ b/docs/extras/transfer_sd.md @@ -1,49 +1,54 @@ -# Changing SD cards +# Changing microSD cards -The goal of this page is to transfer the contents from one SD card to another one. The method to do this will differ, depending on whether you're using a partition based emuMMC on your SD card or not. +The goal of this page is to transfer the contents from one microSD card to another one. The method to do this will differ, depending on whether you're using a partition based emuMMC on your microSD card or not. -We will be using [hekate](https://github.com/CTCaer/hekate/releases/) to both backup and restore the emuMMC, so make sure that you have its latest files on your SD card already. +We will be using [hekate](https://github.com/CTCaer/hekate/releases/) to both backup and restore the emuMMC, so make sure that you have its latest files on your microSD card already. -## Instructions +#### **Instructions:** You should first check whether you have a file or partition based emuMMC: - -1. Inject the hekate payload. -2. Tap on `emuMMC`. + +1. Enter RCM and inject the Hekate payload. + - If you use a modchipped Switch, you can simply just turn your Switch on with the Hekate payload renamed to `payload.bin` on the root of your SD. +2. Tap on the `emuMMC` button. 3. Under `emuMMC Info & Selection`, check the text next to `Type`. - If you have one it should be either `SD Raw Partition` or `SD File`. ----- -### If you are using a file based emummc or are using no emummc at all: - -1. Remove your SD card. -2. Insert your old SD card into your computer. -3. Copy the contents of your SD card somewhere to your PC. -4. Eject the SD card and insert your new one. -5. Format your new SD card to FAT32 if it isn’t already. - - To do this, use [guiformat](http://ridgecrop.co.uk/index.htm?guiformat.htm) for example (Windows). -6. Copy the files from your PC to your new SD card and you’re done. +### **If you are using a file based emuMMC or are using no emuMMC at all:** + +1. Enter RCM and inject the Hekate payload. + - If you use a modchipped Switch, you can simply just turn your Switch on with the Hekate payload renamed to `payload.bin` on the root of your SD. +2. Navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. +2. Copy the contents of your microSD card somewhere to your PC. +4. Access your new microSD card via a microSD card reader or similar. +5. Format your new microSD card to FAT32 if it isn’t already. + - To do this, use [this guide](https://wiki.hacks.guide/wiki/Formatting_an_SD_card). +6. Copy the files from your PC or directly from your old microSD card to your new microSD card. +7. Eject the `UMS` device safely from within your computer's operating system. ----- -### If you are using a partition based emummc: - +### **If you are using a partition based emuMMC:** + !!!warning "Space for the backup" - You need at least 30GB of free space to be able to backup and restore the emuMMC! + You need at least 30GB (or 60GB if using an OLED Switch) of free space to be able to restore the emuMMC! -1. Inject the hekate payload. +1. Enter RCM and inject the Hekate payload. + - If you use a modchipped Switch, you can simply just turn your Switch on with the Hekate payload renamed to `payload.bin` on the root of your SD. 2. In the main menu, tap on `Tools`, then `Backup eMMC` and set `SD emuMMC Raw Partition` at the bottom of your screen to `ON`. -3. Backup both `SD emuMMC BOOT0 & BOOT1` and `SD emuMMC RAW GPP` (Note: raw gpp may take a while). -4. Once both are done, go back to the main menu, remove your SD card and insert it into your PC. +3. Backup both `SD emuMMC BOOT0 & BOOT1` and `SD emuMMC RAW GPP` (Note: `SD emuMMC RAW GPP` may take a while). +4. Once both are done, go back to the main menu, navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. 5. If Windows asks you to format a drive, discard it and select the drive with your SD contents. -6. Copy the contents of your SD card somewhere to your PC. -7. Follow only [this page](https://switchgui.de/switch-guide/user_guide/emummc/partitioning_sd/) to partition the new SD card for an emuMMC setup. -8. After it’s done, exit and insert your new SD card into your PC. -9. Copy the contents of your old SD card to your new one. -10. Navigate to `/backup/
+ +### **Troubleshooting** +#### **EdiZon isn't showing up when I open the Homebrew menu!:** + +Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files. + +This can be done by booting into Hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/ftpd.md b/docs/homebrew/ftpd.md new file mode 100644 index 00000000..03d3b19e --- /dev/null +++ b/docs/homebrew/ftpd.md @@ -0,0 +1,32 @@ +### **FTPD** + +FTPD is simply an FTP server for the Switch, it can be used to transfer files wirelessly to- and from- your microSD card. + +----- + +#### Usage requirements: + +- An FTP client such as [WinSCP](https://winscp.net/eng/download.php) (Windows) +- Any device that can connect to an FTP server with an FTP client + +#### Usage instructions: + +!!! note "Note" + This section assumes that the device running the FTP client and your Switch are connected to the same network. If it's not, make sure they are connected to the same network before continuing. + +1. Launch the FTPD Homebrew app from the Homebrew menu. +2. Open your FTP client of choice. +3. Add a new connection and in the `Host` field of your FTP client, put in the IP address of your Switch mentioned in the top left of FTPD. + - If applicable in your FTP client, check the `Anonymous` box. +4. Type in port `5000` for the port and attempt to connect to your Switch. +5. You should now be able to access your microSD card wirelessly and transfer files to- and from- the microSD card. + +#### FTPD's main menu: + + + +----- + +#### Additional information: + +FTPD can also run in the form of a background process (sysmodule), called sys-ftpd. It can be found [here](https://github.com/cathery/sys-ftpd), usage and configuration options are mentioned there as well. diff --git a/docs/homebrew/goldleaf.md b/docs/homebrew/goldleaf.md new file mode 100644 index 00000000..9a3c9bc1 --- /dev/null +++ b/docs/homebrew/goldleaf.md @@ -0,0 +1,23 @@ +### **Goldleaf** + +Goldleaf is primarily a very extensive file and console content manager. + +----- + +#### Common use cases for Goldleaf are: + +- Account management +- Browsing your microSD card +- Browsing the partitions of the internal storage +- Enabling access to the built-in Switch web browser +- Export Switch firmware +- Restoring games to their base game versions +- File management + +And a *lot* more, which you can view on Goldleaf's Github repository [here](https://github.com/XorTroll/Goldleaf). + +----- + +#### Goldleaf screenshots: + + diff --git a/docs/homebrew/img/ftpd.jpg b/docs/homebrew/img/ftpd.jpg new file mode 100755 index 00000000..1c2625d2 Binary files /dev/null and b/docs/homebrew/img/ftpd.jpg differ diff --git a/docs/homebrew/img/goldleaf.jpg b/docs/homebrew/img/goldleaf.jpg new file mode 100644 index 00000000..a7b75bf9 Binary files /dev/null and b/docs/homebrew/img/goldleaf.jpg differ diff --git a/docs/homebrew/img/ldn_mitm.jpg b/docs/homebrew/img/ldn_mitm.jpg new file mode 100644 index 00000000..dfa8c284 Binary files /dev/null and b/docs/homebrew/img/ldn_mitm.jpg differ diff --git a/docs/homebrew/img/nx-shell-main.jpg b/docs/homebrew/img/nx-shell-main.jpg new file mode 100644 index 00000000..ab7c5b7f Binary files /dev/null and b/docs/homebrew/img/nx-shell-main.jpg differ diff --git a/docs/homebrew/img/nx-shell-menu.jpg b/docs/homebrew/img/nx-shell-menu.jpg new file mode 100644 index 00000000..a29f6bc7 Binary files /dev/null and b/docs/homebrew/img/nx-shell-menu.jpg differ diff --git a/docs/homebrew/img/sysdvr1.png b/docs/homebrew/img/sysdvr1.png new file mode 100644 index 00000000..158d05e3 Binary files /dev/null and b/docs/homebrew/img/sysdvr1.png differ diff --git a/docs/homebrew/img/sysdvr2.png b/docs/homebrew/img/sysdvr2.png new file mode 100644 index 00000000..e2405c04 Binary files /dev/null and b/docs/homebrew/img/sysdvr2.png differ diff --git a/docs/homebrew/img/sysdvr3.png b/docs/homebrew/img/sysdvr3.png new file mode 100644 index 00000000..09fe5930 Binary files /dev/null and b/docs/homebrew/img/sysdvr3.png differ diff --git a/docs/homebrew/img/tesla-menu.jpg b/docs/homebrew/img/tesla-menu.jpg new file mode 100644 index 00000000..90d1117f Binary files /dev/null and b/docs/homebrew/img/tesla-menu.jpg differ diff --git a/docs/homebrew/index.md b/docs/homebrew/index.md new file mode 100644 index 00000000..110f52f0 --- /dev/null +++ b/docs/homebrew/index.md @@ -0,0 +1,29 @@ +### **Information** + +This page summarizes the included Homebrew apps and additional Homebrew you can check out. + +#### The guide includes a few Homebrew apps by default, these apps are: + +- [JKSV](jksv.md) +- [Goldleaf](goldleaf.md) +- [FTPD](ftpd.md) +- [NXTheme Installer](nxtheme-installer.md) +- [NX-Shell](nx-shell.md) + +#### Terminologies + +Homebrew is a general term, the term can be used for Homebrew apps (`.nro` files) or in the form of background processes, called "sysmodules". The Switch natively has sysmodules built into its firmware but you can run additional Homebrew sysmodules that can add functionality to your Switch. In the section below, you can find additional and commonly used Homebrew apps and sysmodules. + +Homebrew apps are stored in `sd:/switch` by default and Homebrew sysmodules are stored in `sd:/atmosphere/contents` by default. + +#### Additional Homebrew apps/sysmodules: + +- [EdiZon](edizon.md) (sysmodule and Homebrew app) +- [Tesla-Menu](tesla-menu.md) (sysmodule) +- [MissionControl](mission-control.md) (sysmodule) +- [sys-con](sys-con.md)(sysmodule) +- [sys-botbase](sys-botbase.md) (sysmodule) +- [SysDVR](sysdvr.md) (sysmodule and Homebrew app) +- [sys-clk](sys-clk.md) (sysmodule and Homebrew app) +- [ldn_mitm](ldn_mitm.md) (sysmodule and Homebrew app) + diff --git a/docs/homebrew/jksv.md b/docs/homebrew/jksv.md new file mode 100644 index 00000000..409d2ff1 --- /dev/null +++ b/docs/homebrew/jksv.md @@ -0,0 +1,44 @@ +# Save Management + +### **JKSV** + +For save management, [JKSV](https://github.com/J-D-K/JKSV) is recommended. It can be used to back up and restore game saves to your microSD card. + +### **Backing up save data using JKSV** + +#### Instructions: + +1. Launch JKSV from the homebrew menu. +2. Select your Switch user on the left side with the `A` button. +3. Select your desired game and press `A` to select it. +4. Press `A` again to create a new save backup +5. Enter a name for the save data folder containing the save data and press `+` or `OK`. +6. Wait for it to finish backing up your save data. + +----- + +### **Restoring save data using JKSV** + +#### Instructions: + +1. Launch JKSV from the homebrew menu. +2. Select your Switch user on the left side with the `A` button. +3. Select your desired game and press `A` to select it. +4. Hover over the save data folder containing the save data you want and press `Y`. +5. Hold the `A` button to restore the save data, keep holding it until it's finished. + +#### **JKSV Documentation** +Please read JKSV's [homepage](https://github.com/J-D-K/JKSV) for information on how to use it. + +{ width="600" } + +----- + +### **Checkpoint** + +[Checkpoint](https://github.com/FlagBrew/Checkpoint) is also a save manager. It can be used to back up and restore game saves to your microSD card. It also has the ability to share save data over FTP and WiFi. + +#### Checkpoint Documentation +Please read Checkpoint's [homepage](https://github.com/Flagbrew/Checkpoint) for information on how to use it. + +{ width="600" } diff --git a/docs/homebrew/ldn_mitm.md b/docs/homebrew/ldn_mitm.md new file mode 100644 index 00000000..19bd5574 --- /dev/null +++ b/docs/homebrew/ldn_mitm.md @@ -0,0 +1,46 @@ +### **Information** + +ldn_mitm is a [sysmodule](index.md#terminologies) that allows you to route the local wireless ad-hoc network traffic of the Switch via the network your Switch is connected to, essentially allowing "LAN" functionality between consoles and emulators using ldn_mitm. The official Github repository for ldn_mitm can be found [here](https://github.com/spacemeowx2/ldn_mitm). + +#### Common use cases for ldn_mitm: +- It can be used in combination with [lan-play](http://lan-play.com/install-switch) +- It can be used in combination with [XLink Kai](https://www.teamxlink.co.uk/wiki/Nintendo_Switch_XLink_Kai_Setup) +- It can be used in combination with real Switch consoles and emulators + +----- + +#### Installation requirements: +- An archive manager like [7-Zip](https://www.7-zip.org/) +- The latest release of [ldn_mitm](https://github.com/DefenderOfHyrule/ldn_mitm/releases) (the `ldn_mitm.zip` file) + +#### Installation instructions: +1. Boot into Hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. +2. Your microSD card should now be accessible on your PC, open it. +3. Extract the `.zip` file to a location on your computer. + - If your archive manager allows for it, you can also simply open the `.zip` file directly. +4. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. + - **Optional:** You can verify if you've installed ldn_mitm correctly, you should have a folder called `4200000000000010` (ldn_mitm) in `sd:/atmosphere/contents` and the `ldnmitm_config.nro` file in `sd:/switch/ldnmitm_config`. +5. Boot into CFW. + +----- + +### **Basic usage instructions** + +You can enable/disable ldn_mitm by opening the Homebrew menu, opening ldn_mitm's config app and pressing `Y` to toggle ldn_mitm. + + + +----- + +### **Troubleshooting** +#### **My Switch crashes on boot after I installed ldn_mitm!:** + +**Cause:** If your Switch crashes with Error `std::abort (0xFFE)` and Title ID `4200000000000010`, you're using a version of ldn_mitm that's incompatible with your Atmosphere version. The expected Atmosphere version is mentioned on each release page of an ldn_mitm release. + + + +#### **ldn_mitm isn't working!:** + +Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files. + +This can be done by booting into Hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/mission-control.md b/docs/homebrew/mission-control.md new file mode 100644 index 00000000..148538a0 --- /dev/null +++ b/docs/homebrew/mission-control.md @@ -0,0 +1,33 @@ +### **Information** + +MissionControl is a [sysmodule](index.md#terminologies) that allows you to pair normally-unsupported controllers as if they were natively supported, like PS3, PS4, PS5 and Xbox One S/X controllers via Bluetooth. The full supported controller list can be found on the official Github repository [here](https://github.com/ndeadly/MissionControl) including pairing instructions for the supported controllers. + +----- + +#### Installation requirements: +- An archive manager like [7-Zip](https://www.7-zip.org/) +- The latest release of [MissionControl](https://github.com/ndeadly/MissionControl/releases) (the `MissionControl-(version)-master.zip` file) + +#### Installation instructions: +1. Boot into Hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. +2. Your microSD card should now be accessible on your PC, open it. +3. Extract the `.zip` file to a location on your computer. + - If your archive manager allows for it, you can also simply open the `.zip` file directly. +4. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. + - **Optional:** You can verify if you've installed MissionControl correctly, you should have a folder called `010000000000BD00` (MissionControl) in `sd:/atmosphere/contents`. +5. Boot into CFW. + +----- + +### **Troubleshooting** +#### **My Switch crashes on boot after I installed MissionControl!:** + +**Cause:** If your Switch crashes with Error `std::abort (0xFFE)` and Title ID `010000000000BD00`, you're using a version of MissionControl that's incompatible with your Atmosphere version. The expected Atmosphere version is mentioned on each release page of a MissionControl release. + + + +#### **MissionControl isn't working!:** + +Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files. + +This can be done by booting into Hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/nx-shell.md b/docs/homebrew/nx-shell.md new file mode 100644 index 00000000..d7a1eabd --- /dev/null +++ b/docs/homebrew/nx-shell.md @@ -0,0 +1,24 @@ +### **NX-Shell** +NX-Shell is a file manager. + +----- + +#### Common use cases for NX-Shell + +- Copying files +- Moving files +- Deleting files +- View properties of files and folders +- Create new folders +- Create new files +- Set the archive bit on files and folders + +For more information, you can check out NX-Shell's Github repository [here](https://github.com/joel16/NX-Shell). + +----- + +#### NX-Shell screenshots: + + + + diff --git a/docs/homebrew/nxtheme-installer.md b/docs/homebrew/nxtheme-installer.md new file mode 100644 index 00000000..c9474d01 --- /dev/null +++ b/docs/homebrew/nxtheme-installer.md @@ -0,0 +1,115 @@ +# Theming + +Using NXTheme Installer, you can install and create unique styles and layouts for your Switch Home Menu. + +### **Index** + +- Follow the [Installing a theme](#installing-a-theme) section if you want to install a theme. + +- Follow the [Making a theme](#making-a-theme) section if you want to make a theme manually. + +- Follow the [Installing a custom font](#installing-a-custom-font) section if you want to install a custom font. + +- If you run into any issues, visit the [Troubleshooting](#troubleshooting) section. + +----- + +### **Installing a theme** + +!!! note "Community Themes" + If you want to use community made themes, for example from the r/NXThemes subreddit or [Themezer](https://themezer.net), you can follow the guide below to install a community provided `.nxtheme` file. + +#### **What you need:** + +- The latest release of [NXThemes Installer](https://github.com/exelix11/SwitchThemeInjector/releases) + +#### **Instructions:** + +1. Download `NXThemesInstaller.nro` and put it in `sd:/switch`. +1. Copy the `.nxtheme` files to the `themes` folder on your microSD card (It is recommended you put them into their own folders, e.g. `sd:/themes/awesome_theme/awesome.nxtheme`). + - Create the `themes` folder on the root of your microSD card if it does not exist. +2. Boot into sysCFW/emuMMC and launch the Homebrew Menu, then launch `NXThemes Installer` *with* an internet connection. + - NXTheme Installer will automatically download the required theme patches if it has a connection to the internet. These theme patches are required for themes to work. + If you don't want to or don't have the ability connect to a Wi-Fi network, installing the theme patches can be done manually. + See the instructions [here](https://github.com/exelix11/theme-patches#if-you-dont-want-to-connect-your-console-to-the-internet) on how to install them manually. +3. If you get prompted about extracting your home menu data, do so. + - You can always do this manually via the `Extract home menu` tab in `NXTheme Installer`. +3. You should now see the main menu of `NXTheme Installer`, the `Themes` tab is where you will find your themes. To install them, press the folder name of your theme and go through each home menu section to install the desired theme for that section (e.g. going to `/awesome_theme` and selecting your theme for the specific menu you want to change, do the same for the other menus). +4. Reboot into CFW via the `Reboot` tab to see the changes. + +!!! tip "An example of a Home Menu theme being installed" +  + +----- + +### **Making a theme** + +=== "**Windows**" + + #### **What you need:** + + The latest release of **Switch Theme Injector** + + - You need to download the `ReleaseVx.x.zip` on the download page + + #### **Making the theme** + + 1. Unzip `ReleaseVx.x.zip` to somewhere on your PC's drive. + 2. Open up the `SwitchThemes.exe` app. Navigate to `NXTheme Builder`. + 3. Select a Home menu part, A 720p image and a Layout patch. Click on `Build NXTheme` after selecting your home menu part, image and layout patch. + 4. Fill out the details in the window that pops up. After filling out this window and clicking ok, you will get asked where to save the NXTheme file. Save this file to a temporary folder. + 5. Repeat step 3 and 4 for every Home Menu part of the Switch you want to modify. + +=== "**Mac / Linux / ChromeOS**" + + #### **Making the theme** + + Make sure that the images you want to use are 1280x720 and in JPG! + + 1. Navigate to **Exelix's Web Injector**. + 2. Select a Theme Target you want to edit. After this, click the Open an Image button and select your background image. + 3. Choose a theme name and an author name and optionally a different layout, then click build NxTheme. + 4. Your browser will prompt you to download a file. Save this file to a temporary folder. + 5. Repeat step 2 to 4 for every Home Menu part of the Switch you want to modify. + +----- + +### **Installing a custom font** + +1. Put a font with the `.ttf` file type into the `themes` folder (It is recommended you put them into their own folders, e.g. `sd:/themes/cool_font/font.ttf`). +2. Boot into sysCFW/emuMMC, launch the Homebrew Menu and launch `NXThemes Installer`. +3. You should now see the main menu of `NXTheme Installer`, the `Themes` tab is where you will find your font(s). +4. Install your desired font by selecting the `.ttf` file in the font folder you created. +4. Reboot into CFW via the `Reboot` tab to see the changes. + + +----- + +### **Troubleshooting** +#### **My Switch crashes on boot after I installed a theme!:** + +**Cause 1:** You didn't install the required theme patches for your firmware version. You can remove your installed custom theme data by navigating to `sd:/atmosphere/contents` and deleting the `01000000000001000` folder. + +**Cause 2:** You didn't extract your home menu data when prompted. You can remove your installed custom theme data by navigating to `sd:/atmosphere/contents` and deleting the `01000000000001000` folder. + +**Cause 3:** You installed a bad theme. You can remove them by navigating to `sd:/atmosphere/contents` and deleting the `01000000000001000` folder. + +- **Note:** `contents` is called `titles` on Atmosphère versions 0.9.4 and below. + + + +#### **My Switch crashes on boot after I installed a font!:** + +**Cause 1:** You installed a font that was too large in file size (maximum file size being 1.9MB). You can remove your installed custom font data by navigating to `sd:/atmosphere/contents` and deleting the `0100000000000811` folder. + +**Cause 2:** You installed a font that wasn't the right file type (e.g. `.otf`). You can remove your installed custom font data by navigating to `sd:/atmosphere/contents` and deleting the `0100000000000811` folder. + +- **Note:** `contents` is called `titles` on Atmosphère versions 0.9.4 and below. + + + +#### **The NXTheme installer crashes when I launch it:** + +This is probably due to the archive bit being set on either the app or the `.nxtheme` files. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files. + +This can be done by booting into Hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/sys-botbase.md b/docs/homebrew/sys-botbase.md new file mode 100644 index 00000000..da4a05e4 --- /dev/null +++ b/docs/homebrew/sys-botbase.md @@ -0,0 +1,40 @@ +### **Information** + +sys-botbase is an advanced [sysmodule](index.md#terminologies) that allows users to interact with their Switch remotely, to "remote control" their Switch. This remote control allows users to create automated tasks, simulate button presses, simulate touchscreen input and read/write to the memory of the Switch while in-game. + +#### Common use cases for sys-botbase: +- Use ACNHPokerCore in combination with ACNH +- Controlling a game remotely +- Automation + +----- + +#### Installation requirements: +- An archive manager like [7-Zip](https://www.7-zip.org/) +- The latest release of [sys-botbase](https://github.com/olliz0r/sys-botbase/releases) (the `sys-botbase(version).zip` file) + +#### Installation instructions: +1. Boot into Hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. +2. Your microSD card should now be accessible on your PC, open it. +3. Extract the `.zip` file to a location on your computer. + - If your archive manager allows for it, you can also simply open the `.zip` file directly. +4. Copy the *contents* of each (extracted) `.zip` file to the root of your microSD card. + - **Optional:** You can verify if you've installed sys-botbase correctly, you should have a folder called `430000000000000B` (sys-botbase) in `sd:/atmosphere/contents`. +5. Boot into CFW. + +----- + +### **Troubleshooting** +#### **My Switch crashes on boot after I installed sys-botbase!:** + +**Cause:** While it's almost impossible for this to happen, if your Switch crashes with Error `2001-0123 (0xf601)` and Title ID `430000000000000B`, you're using a version of sys-botbase that's incompatible with your Atmosphere version. + +- **Note:** sys-botbase will almost never crash unless something is fundamentally wrong with the contents of your microSD card. If it does crash and need an update, an updated release will be mentioned here. + + + +#### **sys-botbase isn't working!:** + +Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files. + +This can be done by booting into Hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/sys-clk.md b/docs/homebrew/sys-clk.md new file mode 100644 index 00000000..73d6ab1a --- /dev/null +++ b/docs/homebrew/sys-clk.md @@ -0,0 +1,48 @@ +### **Information** + +sys-clk is a [sysmodule](index.md#terminologies) that allows you to overclock the hardware of your Switch. The usage, configuration and clock speed information can be found on the official Github repository [here](https://github.com/retronx-team/sys-clk) + +!!! danger "Limits of sys-clk" + sys-clk has limits for a reason, which is to not damage the hardware of your Switch. Using ***any*** modified version of sys-clk puts your Switch at risk of hardware failure. We do not support any modified version of sys-clk nor should you ever touch them. Overclocking is not something you should be doing 24/7 as overclocking in general will always degrade/wear out the hardware of your Switch faster and you should know what you're doing if you *do* decide to do so. + +----- + +#### Installation requirements: +- An archive manager like [7-Zip](https://www.7-zip.org/) +- The latest release of [sys-clk](https://github.com/retronx-team/sys-clk/releases) (the `sys-clk-(version).zip` file) + +#### Installation instructions: +1. Boot into Hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. +2. Your microSD card should now be accessible on your PC, open it. +3. Extract the `.zip` file to a location on your computer. + - If your archive manager allows for it, you can also simply open the `.zip` file directly. +4. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. + - **Optional:** You can verify if you've installed sys-clk correctly, you should have a folder called `00FF0000636C6BFF` (sys-clk) in `sd:/atmosphere/contents`. +5. Boot into CFW. + +----- + +### **Basic usage instructions** + +Open the Homebrew menu and open sys-clk's manager app. This app allows you to change the global clock speeds or clock speeds based on title. + +----- + +### **Troubleshooting** +#### **My Switch crashes on boot after I installed sys-clk!:** + +**Cause:** If your Switch crashes on boot, make sure you're using the latest release of sys-clk. If it continues to crash afterwards, see the troubleshooting step at the bottom of this page. + + + +#### **My Switch crashes while using sys-clk!:** + +**Cause:** You're either using a modified version of sys-clk and pushing the hardware of your Switch too far or your console is overheating. The cooling system of the Switch is *not* the best and overheating can be a cause of dried up thermal paste/lack of thermal paste. Overclock with caution and be careful, monitor the temperatures of your Switch using a Tesla-Menu overlay like [Status-Monitor-Overlay](https://github.com/masagrator/Status-Monitor-Overlay) (requires Tesla-Menu). + + + +#### **sys-clk isn't working!:** + +Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files. + +This can be done by booting into Hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/sys-con.md b/docs/homebrew/sys-con.md new file mode 100644 index 00000000..f4c2ab95 --- /dev/null +++ b/docs/homebrew/sys-con.md @@ -0,0 +1,35 @@ +### **Information** + +sys-con is a [sysmodule](index.md#terminologies) that allows you to use normally-unsupported controllers as if they were natively supported, like PS3, PS4, PS5 and Xbox One S/X controllers via USB. The full supported feature and controller list can be found on the official Github repository [here](https://github.com/cathery/sys-con) including usage instructions and configuration options. + +----- + +#### Installation requirements: +- An archive manager like [7-Zip](https://www.7-zip.org/) +- The latest release of [sys-con](https://github.com/cathery/sys-con/releases) (the `sys-con-(version).zip` file) + +#### Installation instructions: +1. Boot into Hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. +2. Your microSD card should now be accessible on your PC, open it. +3. Extract the `.zip` file to a location on your computer. + - If your archive manager allows for it, you can also simply open the `.zip` file directly. +4. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. + - **Optional:** You can verify if you've installed sys-con correctly, you should have a folder called `690000000000000D` (sys-con) in `sd:/atmosphere/contents`. +5. Boot into CFW. + +----- + +### **Troubleshooting** +#### **My Switch crashes on boot after I installed sys-con!:** + +**Cause:** While it's almost impossible for this to happen, if your Switch crashes with Error code `2162-0002 (0x4a2)` and Title ID `690000000000000D`, you're using a version of sys-con that's incompatible with your Switch firmware version. The expected firmware version is mentioned on each release page of a sys-con release. + +- **Note:** sys-con hasn't needed an update for years as of the moment of writing this. If it does need an update, an updated release will be mentioned here. + + + +#### **sys-con isn't working!:** + +Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files. + +This can be done by booting into Hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/homebrew/sysdvr.md b/docs/homebrew/sysdvr.md new file mode 100644 index 00000000..8584b2db --- /dev/null +++ b/docs/homebrew/sysdvr.md @@ -0,0 +1,17 @@ +### **Information** + +SysDVR is a [sysmodule](index.md#terminologies) that allows you to stream the screen of your Switch (while in-game/in an application) to your PC via the network or USB. + +### **SysDVR** + +Installation, usage, configuration and extensive troubleshooting information can be found on the [SysDVR Wiki](https://github.com/exelix11/SysDVR/wiki). + +----- + +#### SysDVR screenshots: + + + + + + diff --git a/docs/homebrew/tesla-menu.md b/docs/homebrew/tesla-menu.md new file mode 100644 index 00000000..8d1b3566 --- /dev/null +++ b/docs/homebrew/tesla-menu.md @@ -0,0 +1,76 @@ +### **Information** + +Tesla-Menu is an overlay menu developed by [WerWolv](https://github.com/WerWolv), Tesla-Menu is comparable to Rosalina menu on the 3DS and its purpose is to be able to load community made overlays for Homebrew apps and sysmodules that can be accessed at any time. Below you can find common use cases for Tesla-Menu. The official Github page for Tesla-Menu can be found [here](https://github.com/WerWolv/Tesla-Menu). + +!!! note "Dependencies" + Tesla-Menu is dependent on a [sysmodule](index.md#terminologies) called `nx-ovlloader`, this sysmodule is responsible for loading `ovlmenu.ovl` from `sd:/switch/.overlays`. + +#### Common use cases for Tesla-Menu: +- Load community made Tesla-Menu overlays +- Viewing the temperatures/clock speeds of your hardware +- Editing sysmodule configs on the fly (if applicable) +- Editing Homebrew app configs on the fly (if applicable) +- Toggling cheats easily +- Toggling sysmodules + +----- + +#### Installation requirements: +- An archive manager like [7-Zip](https://www.7-zip.org/) +- The latest release of [Tesla-Menu](https://github.com/WerWolv/Tesla-Menu/releases/tag/v1.2.3) (the `ovlmenu.zip` file) +- The latest release of [nx-ovlloader](https://github.com/WerWolv/nx-ovlloader/releases/tag/v1.0.7) (the `nx-ovlloader.zip` file) + +#### Installation instructions: +1. Boot into Hekate and go to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. +2. Your microSD card should now be accessible on your PC, open it. +3. Extract both `.zip` files to a location on your computer. + - If your archive manager allows for it, you can also simply open the `.zip` files directly. +4. Copy the *contents* of each (extracted) `.zip` file to the root of your microSD card. + - **Optional:** You can verify if you've installed Tesla-Menu and nx-ovlloader correctly, you should have a folder called `420000000007E51A` (nx-ovlloader) in `sd:/atmosphere/contents` and the `ovlmenu.ovl` (Tesla-Menu) file in `sd:/switch/.overlays`. +5. Boot into CFW. + +----- + +### **Opening Tesla-Menu** +Tesla-Menu can be opened by pressing `L` + `R Stick press (R3)` + `DPAD down`, assuming you use the default configuration. + + + +----- + +### **Commonly used Tesla-Menu overlays** +- [Status-Monitor-Overlay](https://github.com/masagrator/Status-Monitor-Overlay) +- [EdiZon overlay](https://github.com/proferabg/EdiZon-Overlay) +- [QuickNTP](https://github.com/nedex/QuickNTP) +- [Emuiibo](https://github.com/XorTroll/emuiibo) (this requires you to also install the Emuiibo sysmodule) +- [TriPlayer](https://github.com/DefenderOfHyrule/TriPlayer) (this requires you to also install the TriPlayer sysmodule) +- [ldn_mitm](https://github.com/DefenderOfHyrule/ldn_mitm) (this requires you to also install the ldn_mitm sysmodule) + +----- + +### **Troubleshooting** +#### **My Switch crashes on boot after I installed Tesla-Menu/nx-ovlloader!:** + +**Cause:** If your Switch crashes with Error code `2001-0123 (0xf601)` and Title ID `420000000007E51A`, you didn't successfully install Tesla-Menu or you aren't using the latest release of Tesla-Menu, re-follow the installation instructions above. + + + +#### **My Switch crashes when I open an overlay via Tesla-Menu!:** + +**Cause:** If your Switch crashes with Error code `2001-0123 (0xf601)` and Title ID `420000000007E51A`, the overlay you're trying to open/use isn't up to date. Check its source repository for updates. + +- If this overlay doesn't have an updated release, you may have to look for a forked (updated) release or compile it yourself using the latest `libtesla` library. The latter is for developers (or advanced users). + + + +#### **Tesla-Menu is only showing while on the main menu and not in-game!:** + +**Cause:** This issue will only happen when the Switch is docked, ensure that you've set the "Screen size" in `System Settings` > `TV Output` to 100%. Adjust your TV/monitor to fit the entirety of the screen of your Switch using its OSD (On Screen Display) or remote. + + + +#### **Tesla-Menu isn't opening when I press the correct button combination!:** + +Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files. + +This can be done by booting into Hekate and going to `Tools` > `Arch bit • RCM Touch • Pkg1/2` > `Fix Archive Bit`. diff --git a/docs/index.md b/docs/index.md index 6094f12a..6433e8b2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,82 +1,127 @@
-# NH Switch Guide
+# **NH Switch Guide**
-A guide collaboration between Nintendo Homebrew's Helpers and Staff, from stock to Atmosphere.
+The NH Switch Guide is a collaboration from Nintendo Homebrew's Discord community, getting you from a stock Switch to Atmosphère.
+For live support with this guide, visit us in **#switch-assistance-1** or **#switch-assistance-2** over at the [NH-Discord server](https://discord.gg/C29hYvh).
+
+Prepare to set aside a minimum of an hour to follow this guide. This is specifically for you to carefully read and understand each page for safe execution for the safety and longevity of your Switch console. Some required device backups can also take around ten to thirty minutes to create, depending on your Switch model and your microSD card specifications.
+
+-----
+
+### **What is Custom Firmware?**
+
+Custom FirmWare (“CFW”) is complex software that modifies the function of a device's operating system, also known as a system firmware.
+Atmosphère, for example, patches the Switch OS (named Horizon) on the fly.
+
+Custom firmware can be considered a holy grail in terms of device modding, as it allows nearly limitless control and freedoms than you would get with more primitive "userland" access.
-!!! tip "Discord Help"
- For live support with this guide please visit us in **#switch-assistance** over at the [Nintendo Homebrew Discord](https://discord.gg/C29hYvh).
+-----
+
+### **What is homebrew?**
-### What is homebrew?
+Homebrew refers to unofficial software written by hobbyists for locked down systems, like the Nintendo Switch. Homebrew can include original games, emulators, save-editing tools, and much, much more!
-!!! tip ""
- Homebrew is a term for unoffical software written by hobbyists and amateur developers for locked down systems (i.e. the Switch).
+On the Switch in particular, you need CFW to run almost all available homebrew. Some first-gen ("V1") consoles can run homebrew for free, while all other ("patched") consoles require specialized hardware installation beforehand.
+
- This can include save editing tools, games, emulators, and more.
+-----
- Homebrew can be run for free on your Switch through Custom Firmware as long as you have a "first-generation" system, and a USB-C cable.
+### **What are custom operating systems?**
+Custom operating systems (OSes) are alternative system software installations, like Android or Linux, that install alongside the default Switch OS. These are usually perfect for powerusers who want to extend the functionality of their console beyond that of a gaming console, transforming Nintendo Switch to a full-fledged hybrid tablet or desktop. These custom OSes run completely independent of the Switch OS, meaning that anything you do in a custom OS cannot be reported back to Nintendo. Custom operating systems are not "emulated"; they run natively on the Switch's Tegra X1 SoC.
-### What is Custom Firmware?
+This guide will give you the opportunity to set aside space on your microSD to install these custom OSes onto, if you desire. It is important to note that these installations are optional; you do not need to install any custom OS in order to complete this guide and install Atmosphère. However, it is better to decide sooner rather than later, as the installation process involves formatting your microSD card.
-!!! tip ""
- Custom Firmware (“CFW”) is a piece of software that modifies the system firmware.
- Atmosphere, for example, does this by running in the background and patching the OS on the fly.
+-----
- This allows one to extend the functionality of their system by giving homebrew higher levels of permission than most userland exploits and can be used to provide extra features for homebrew devs and users to take advantage of for various purposes, for instance, game modding using LayeredFS.
+### **What does this guide install?**
- CFW can be set up on any first-generation console on any version (but will require additional tools).
+This guide has the end-goal of taking a completely unmodified Switch from stock firmware to a custom firmware named Atmosphère.
-### What does this guide install?
+[fusee-gelee](files/extras/fusee_gelee_nvidia.pdf) is currently the most widespread software entrypoint of launching custom firmware. It utilizes a vulnerability in the bootROM of the first-generation Switch systems, allowing us to boot the console via any payload we choose, instead of only ones that Nvidia and Nintendo authorize. The result allows full baremetal control over your console, including system storage backups, recovery, custom firmwares, and custom operating systems.
+
-!!! tip ""
- This guide has the end goal of taking a completely unmodified Switch from Stock Firmware to Atmosphere Custom Firmware.
+-----
- fusee-gelee is currently the best method of launching Custom Firmware that gives us nearly full control of the system. It utilizes a vulnerability in the bootROM of the first-generation Switch systems, allowing us to send any payload we want to the Switch's recovery mode, instead of only ones that Nintendo have authorized.
+### **What can I do with custom firmware?**
-### What can I do with Custom Firmware?
+* Customize your HOME Menu with user-created themes and splash screens
+* Run “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
+* Safely update to the latest system version without fear of losing access to homebrew
+- Safely customise your device while retaining full access to Nintendo online services
-!!! tip ""
- * Customize your HOME Menu with user-created themes and splash screens
- * 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
- * Safely update to the latest system version without fear of losing access to homebrew
+More on this can be found later on in the guide.
-### What do I need to know before starting?
+-----
-!!! tip ""
- Before beginning the guide, you must know the risks of Switch 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.
+### **What do I need to know before starting?**
- This guide will work on first-generation Switch consoles in all regions on any firmware version.
+As previously mentioned, this guide will take a minimum of an hour to fully complete. Please responsibly set aside this time before your first run-through.
- You will need **one** of the following in order to successfully follow this guide:
+Acknowledge that EVERY time you modify your system, there is always the potential for an UNRECOVERABLE brick. A brick is a damaged device that no longer functions; something that becomes as "useful as a brick". On the Switch, they're rare, but still a possibility -- so make sure you read the directions carefully before performing them, and follow them EXACTLY.
- - A PC and a USB cable capable of data transfer between your Switch and your PC
- - An Android device and a USB cable capable of data transfer between your Switch and your Android device
- - This does not work on every android phone
- - A Lightning-OTG adapter, a jailbroken iOS device and a USB cable capable of data transfer between your Switch and the adapter
- - This method is not covered by the guide, but you can read more about it at [this website](https://mologie.github.io/nxboot/)
+This guide will work on first-generation (V1) and modchipped Switch consoles in all regions on any firmware version.
+!!! note "**You will need *one* of the following in order to successfully follow this guide:**"
- You will also need a micro SD card that is at least 64 gigabytes or larger if you plan on following this guide through the emummc path, which is safer and strongly recommended. If you must use a smaller SD card, it is possible with the sysmmc path, but strongly not recommended.
+ - A PC, and a USB-C cable capable of data transfer to connect them together
+ - An Android device, and a USB-C cable capable of data transfer to connect them together
+ - This does not work on every Android phone
+ - A Lightning OTG adapter, a jailbroken iOS device, and a USB cable, all capable of data transfer to connect everything together
+ - This method is not covered by the guide, but you can read more about it at [this website](https://mologie.github.io/nxboot/)
+ - A successfully modchipped Switch
+
+ If you choose the emuMMC path introduced later in the guide, you will also need a microSD card that is *at least* 128 gigabytes. In this path, it'll be important to disable the [Automatic Save Data Cloud](https://en-americas-support.nintendo.com/app/answers/detail/a_id/41209) function beforehand, as well as making sure [the Switch is set as the primary console](https://en-americas-support.nintendo.com/app/answers/detail/a_id/22453/~/how-to-change-the-primary-console-for-your-nintendo-account). + If you must use a smaller microSD card, you can choose to use the sysCFW path, after assuming the risks involved. - Finally, you will need a way to access Recovery Mode. (This will be further explained in the "Entering RCM section") + Additionally, on a V1 "unpatched" Switch, you will need a way to access the ReCovery Mode (this will be further explained in the "Entering RCM section"). While possible with household tools, you may want to shell money out for a "jig" that inserts into the Joy-Con rail to reliably enable RCM. -If everything goes according to plan, you will lose no data and end up with everything that you started with (games, Nintendo Account, saves, etc will be preserved). +Upon completion, you will lose no data, ending up with everything that you started with (games, Nintendo Account, saves, etc will be preserved). Your functionalities will only be enhanced. 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. +Custom firmware is not permanently installed and does not change anything on your console simply by running it. It will be entirely unloaded upon rebooting the console. However, CFW does allow you to make permanent changes to your console at your own will, so __be responsible and cautious with the abilities enabled by CFW__. 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. - +If something doesn't make sense while you follow the guide, please reach out and ask for clarification rather than fumble around on your own. If your English isn't the best, use a translator such as [Google Translate](https://translate.google.com/) to submit your questions, so we can help. -#### [Continue to Getting Started ](user_guide/getting_started.md) - +----- + +### **Click the button below to get started with the guide!** +[Continue to Getting Started :material-arrow-right:](user_guide/getting_started.md){ .md-button .md-button--primary } + + +----- + +Note: We are not currently, historically, or will we ever be, associated with Anton Retro, sthetix, Ely M., or other derivative or YouTube/TikTok guide publishers, especially any that claim relation to us. + +Furthermore, we resent any implication to the contrary. +??? "Frequently Asked Questions about this page" + - **Q: What are the differences between "first-generation" ("V1") consoles and "patched" consoles when it comes to running homebrew?**
+ A: Once you boot into Horizon, not much. The primary things to keep in mind is that only V1 consoles support Atmosphère's "Reboot to Payload" function, but modchips automatically load payloads during reboots on their own. + + - **Q: What is Horizon?**
+ A: Horizon is the name of the Switch's operating system. It is sometimes called "HorizonNX", because it is actually a derivative version of the Nintendo 3DS's operating system of the same name. + + - **Q: Why is it called Atmosphère?**
+ A: Atmosphère "runs on top of the Horizon" operating system. Each layer of Horizon's security is referenced via the atmosphere's different layers. For example, the EL1 "kernel" reimplementation is called mesosphère, while the EL3 "TrustZone" reimplementation is called exosphère.
Learn more about ARM Exception Levels [here](https://developer.arm.com/documentation/102412/0103/Privilege-and-Exception-levels/Exception-levels). + + - **Q: What exactly is the "emuMMC path," and why is it recommended for the microSD card to be at least 128GB for this path?**
+ A: The purpose of an emuMMC/emuNAND is to give you a safe place to use custom firmware functions without Nintendo catching sight. As it is an offline clone of your internal storage ran entirely from your microSD card, you will need to set allocate up to 64GB on your microSD card for it (depending on the size of your internal storage), plus a duplicate your of digital game data (emuMMC uses a separate Nintendo folder for game installs). + + - **Q: Why do I need to set my console as primary before starting this guide?**
+ A: The Switch will otherwise try to connect to Nintendo servers before starting apps, which can lead to unexpected delays and make emuMMCs completely unusable. + + - **Q: Can I follow this guide if I have a smaller microSD card, and what are the risks involved in choosing the sysCFW path?**
+ A: Nothing stops you from using sysCFW, but it is recommended for first-timers to get familiar with CFW by starting with an emuMMC. If used improperly, running sysCFW can cause software bricks and/or [bans](https://nx.eiphax.tech/ban.html). -Note: We are not now, nor have we ever been, nor will we ever be, associated with Anton Retro, sthetix, or any other YouTube/TikTok video guide makers. + - **Q: Are there any specific restrictions or limitations imposed by Nintendo on consoles running custom firmware and homebrew?**
+ A: Nintendo has shown a distinct tolerance for users using CFW while online. They __do not__ ban for the presence of CFW, they ban for misbehavior - such as piracy or cheating online. Otherwise, you are treated like all other users. -Furthermore, we resent any implication to the contrary. \ No newline at end of file + - **Q: Is there any community support or forums recommended for users who may have questions or issues during the process?**
+ A: Of course! As well as the [Nintendo Homebrew Discord server](https://discord.gg/C29hYvh), you can also try the [r/SwitchHacks subreddit](https://www.reddit.com/r/SwitchHacks/)! diff --git a/docs/user_guide/all/cfw_environment.md b/docs/user_guide/all/cfw_environment.md new file mode 100644 index 00000000..988f1b7c --- /dev/null +++ b/docs/user_guide/all/cfw_environment.md @@ -0,0 +1,105 @@ +### **CFW on sysMMC vs. CFW on emuMMC** + +A "CFW Environment" describes the context in which you are using custom firmware (CFW). +As a reminder, custom firmware is never permanently installed, and runs independently on top of the system firmware. This means that you never have to commit to where you want to use custom firmware. + +Atmosphère temporarily patches HOS (HorizonOS, operating system of the switch) to enable customisations. You can choose what version of HOS it patches, each time you turn on your system. Each option has its own benefits and drawbacks. + + - For the purposes of this guide, the suffix -NAND and -MMC are interchangeable. + +Generally, `sys-` refers to the physical storage chip (sysMMC/eMMC) inside of your Switch. It stands for "system". + +Generally, `emu-` refers to a virtual version of the eMMC (internal storage), running from a microSD card. It stands for "emulated". + +For more information on terminology, please refer to the [glossary](../../extras/glossary.md). + +**You get to decide!** Your choices are between using the internal storage or emulated storage. We will go over the advantages and disadvantages of either decision below. + +----- + +
+
+- ### **emuMMC CFW (Recommended)**
+ #### **CFW on emuMMC has the following benefits:**
+
+ * No risk of bans as long as emuMMC remains offline from Nintendo [[info]](../../extras/img/ban.png)
+ * A safe area to test dangerous or risky mods and homebrew
+ * No chance of bricking and losing console-unique information while using CFW
+
+ #### **The following drawbacks:**
+
+ * Large microSD size requirement (32GB or 64GB will be reserved, depending on if you use a Switch OLED or not). If you want a *decent* experience, a minimum of 128GB is required (unless you are an advanced user and can resize the USER partition of your NAND)
+ * Slower console response times due to the limitation of your microSD card's classifications/specifications
+ * No official online play while in CFW
+ * More microSD card wear over time
+ * Doubled digital game storage requirements
+
+ #### **And the following considerations:**
+ No parity between sysMMC and emuMMC (Game installs, save data, and system settings will be separated when you boot between the two)
+
+ #### **In particular, here are just *some* popular use-cases for CFW on emuMMC:**
+
+ * Restoring modified save data for any game
+ * Modding and cheating in any game
+ * Custom fonts and home menu theming
+ * Downgrading titles to base versions, without mandatory updates
+ * Enjoying CFW features such as custom sysmodules and homebrew apps
+
+ If you prefer foolproofing, and a separation between official features and custom features, you may consider using CFW on emuMMC. In this guide, emuMMC is assumed to be utilised for offline play.
+
+ !!! note "About this path"
+ This path of the guide ***also*** includes sysCFW as launch option.
+
+ -----
+
+ To proceed with CFW on **emuMMC**, click on the button below:
+
+ [Continue with the emuMMC path :material-arrow-right:](../all/partitioning_sd.md){ .md-button .md-button--primary }
+
+- ### **sysCFW (CFW on sysMMC)**
+ #### **CFW on sysMMC has the following benefits:**
+
+ * Parity of system settings, save data, and titles between CFW usage and standard usage (no need to duplicate digital games)
+ * Significantly lower microSD card storage requirements
+ * Possibility of online play during CFW use
+ * Fast console response time by not having to rely on the speed of your microSD card
+ * Longer microSD card lifespan
+
+
+ #### **The following drawbacks:**
+
+ * A brick risk for risky behaviors, especially for modchip users [[info]](#modchip-instability)
+ * A Nintendo server ban risk for misbehavior [[info]](https://nx.eiphax.tech/ban.html)
+ * No custom app installations on the HOME Menu (guaranteed ban)
+ * No possibility of custom profile pictures (guaranteed ban)
+
+ #### **In particular, here are just *some* popular use-cases for sysCFW:**
+
+ * Enjoying CFW features such as custom sysmodules and homebrew apps
+ * Dumping eShop games, saves, and encryption keys for preservation or installation on emuMMC or external Switch emulators
+ * Restoring modified save data for many games
+ * Custom fonts and home menu theming
+ * Modifying and cheating in most offline games (and some online games; [[info]](../../homebrew/edizon.md))
+
+ If you prefer snappiness, online play, and a seamless transition between official features and custom features, you may consider using CFW on sysMMC. In this guide, sysMMC is assumed to be utilised for online play.
+
+ -----
+
+ To proceed with CFW on **sysMMC**, click on the button below:
+
+ [Continue with the sysCFW path :material-arrow-right:](../all/partitioning_sd_syscfw.md){ .md-button .md-button--primary }
+
+
+
+-----
+
+##### Modchip Instability
+!!! danger "About Modchipped Switch console users"
+ Modchips directly infiltrate communication with the internal storage chip. Due to this, there are slight chances of NAND backups being tainted with corrupted data. If a bad backup is restored to sysNAND, the console can be bricked, and a modchip alone won't be able to fix it. To be safe, we recommend setting up an emuMMC on a console with a modchip, verify BOOT0/1 backups using tools like [NXNandManager (Windows)](https://github.com/eliboa/NxNandManager) or test NAND backups by running them as emuMMCs before you flash them to the sysNAND.
+
+??? "Frequently Asked Questions about this page"
+ - **Q: Why is CFW referred to as being "never permanently installed"?** + A: Unless you have a modchip of any kind, turning the console off will disactivate the custom firmware. There is no current method for Atmosphère to install-to or permanently replace any part of the Nintendo Switch, so it will need to be triggered by an exploit every time you turn on the console. Atmosphère will then patch Horizon to bring you custom firmware features. + + - **Q: Should I personally use sys/emuMMC?**
+ A: These questions are answered in detail within the webpage. Please make sure that you are fully reading the page before jumping here. diff --git a/docs/user_guide/all/img/hekate-partitioning-emu.png b/docs/user_guide/all/img/hekate-partitioning-emu.png new file mode 100644 index 00000000..7966a140 Binary files /dev/null and b/docs/user_guide/all/img/hekate-partitioning-emu.png differ diff --git a/docs/user_guide/all/img/hekate-partitioning-sys.png b/docs/user_guide/all/img/hekate-partitioning-sys.png new file mode 100644 index 00000000..c239efb3 Binary files /dev/null and b/docs/user_guide/all/img/hekate-partitioning-sys.png differ diff --git a/docs/user_guide/img/launching-cfw-emummc-settings.jpg b/docs/user_guide/all/img/launching-cfw-emummc-settings.jpg similarity index 100% rename from docs/user_guide/img/launching-cfw-emummc-settings.jpg rename to docs/user_guide/all/img/launching-cfw-emummc-settings.jpg diff --git a/docs/user_guide/img/launching_cfw_atmosphere_version_string.jpg b/docs/user_guide/all/img/launching_cfw_atmosphere_version_string.jpg similarity index 100% rename from docs/user_guide/img/launching_cfw_atmosphere_version_string.jpg rename to docs/user_guide/all/img/launching_cfw_atmosphere_version_string.jpg diff --git a/docs/user_guide/all/img/launching_cfw_atmosphere_version_string2.jpg b/docs/user_guide/all/img/launching_cfw_atmosphere_version_string2.jpg new file mode 100644 index 00000000..9fafc6ee Binary files /dev/null and b/docs/user_guide/all/img/launching_cfw_atmosphere_version_string2.jpg differ diff --git a/docs/user_guide/all/img/launching_cfw_atmosphere_version_string3.jpg b/docs/user_guide/all/img/launching_cfw_atmosphere_version_string3.jpg new file mode 100644 index 00000000..d72c94ac Binary files /dev/null and b/docs/user_guide/all/img/launching_cfw_atmosphere_version_string3.jpg differ diff --git a/docs/user_guide/all/img/nandbackup.bmp b/docs/user_guide/all/img/nandbackup.bmp new file mode 100644 index 00000000..6ced3f6b Binary files /dev/null and b/docs/user_guide/all/img/nandbackup.bmp differ diff --git a/docs/user_guide/all/img/nyx.bmp b/docs/user_guide/all/img/nyx.bmp new file mode 100644 index 00000000..b6f81b7c Binary files /dev/null and b/docs/user_guide/all/img/nyx.bmp differ diff --git a/docs/user_guide/all/img/nyx20240205_162533.bmp b/docs/user_guide/all/img/nyx20240205_162533.bmp new file mode 100644 index 00000000..774e9a27 Binary files /dev/null and b/docs/user_guide/all/img/nyx20240205_162533.bmp differ diff --git a/docs/user_guide/all/img/nyx20240205_162541.bmp b/docs/user_guide/all/img/nyx20240205_162541.bmp new file mode 100644 index 00000000..a5b6c2b1 Binary files /dev/null and b/docs/user_guide/all/img/nyx20240205_162541.bmp differ diff --git a/docs/user_guide/img/sdfiles.png b/docs/user_guide/all/img/sdfiles.png similarity index 100% rename from docs/user_guide/img/sdfiles.png rename to docs/user_guide/all/img/sdfiles.png diff --git a/docs/user_guide/all/img/sdfiles2.png b/docs/user_guide/all/img/sdfiles2.png new file mode 100644 index 00000000..6ba42ab1 Binary files /dev/null and b/docs/user_guide/all/img/sdfiles2.png differ diff --git a/docs/user_guide/all/img/sdfiles3.png b/docs/user_guide/all/img/sdfiles3.png new file mode 100644 index 00000000..ac9c33e1 Binary files /dev/null and b/docs/user_guide/all/img/sdfiles3.png differ diff --git a/docs/user_guide/all/launching_cfw.md b/docs/user_guide/all/launching_cfw.md new file mode 100644 index 00000000..5ef83d5c --- /dev/null +++ b/docs/user_guide/all/launching_cfw.md @@ -0,0 +1,68 @@ +# Launching CFW + +Now that the preparation work is out of the way, we're finally ready to launch custom firmware on the Switch. + +Unlike systems such as the DSi, Wii, or 3DS, Switch CFW is currently volatile. It will only work as long as your Switch is on. As soon as your Switch completely loses power for any reason (shutting down, battery dying, etc.), CFW will no longer be active and you will need to follow these instructions again. + +!!! danger "Keep emuMMC offline at all times" + Your emuMMC (emuNAND) should never connect to Nintendo. For online play, eShop browsing, or any other Nintendo online activity, use your sysNAND. Using both emuMMC and sysNAND online will likely result in a ban. + +=== "Instructions for emuMMC" + + #### Instructions: + + 1. From Hekate's `Home` menu, navigate to the `Launch` menu. + 2. Find `Atmosphere FSS0 emuMMC` and launch it. + + Hekate is now booting into your emuMMC. To verify that your emuMMC launched properly, open System Settings and navigate to System. You should see `AMS` next to the version number (`AMS` indicating that you're booted into Atmosphere), as well as an `E` at the end (indicating you are booted into emuMMC). + +  + +=== "Instructions for sysCFW" + + #### Instructions: + + 1. From Hekate's `Home` menu, navigate to the `Launch` menu. + 2. Find `Atmosphere FSS0 sysMMC` and launch it. + + Hekate is now booting into sysCFW. To verify that sysCFW launched properly, open System Settings and navigate to System. You should see `AMS` next to the version number (`AMS` indicating that you're booted into Atmosphere), as well as an `S` at the end (indicating you are booted into sysCFW). + + - **Note:** You will also have the `Atmosphere FSS0 EmuMMC` launch option in Hekate, launching it will just result in an error and is expected because you don't have an emuMMC. + +  + +!!! tip "Rebooting to Hekate" + Once booted into CFW, you can easily get back to Hekate by holding the power button, and selecting `Restart` in the power menu or by using the "reboot to payload" homebrew app in the homebrew menu. (Note that while the Reboot to Payload *app* app does *not* work on modchipped Switch consoles, those already automatically run payloads upon reboot in the first place by default.) + +----- + +### **Launching the Homebrew Menu** + +You will now be able to launch the Homebrew Menu by opening the album or by holding the R button while launching any game (including demos/cartridges), or application (e.g. YouTube/Hulu). If R is not held, the game or application will launch like normal. + +!!! warning "A note about using the album for the Homebrew Menu" + - Using Album for the Homebrew Menu instead of a game or application has several limitations, including but not limited to: a smaller amount of available memory (RAM), as well as being unable to launch a full-featured web browser. It is strongly recommended to launch homebrew through applications or games instead. + + +### **About the included Homebrew apps** + +See the [Homebrew](../../homebrew/index.md) tab for information about what the included Homebrew apps do and if you want to check out more Homebrew apps and read about sysmodules like MissionControl, ldn_mitm, sys-con and more. + +If you wish to install more homebrew apps, place them (`.nro` files) in the `switch` folder on your microSD card. + +----- + +### **Installing Android/Linux** + +If you've partitioned your microSD card for preparation of Android/Linux earlier, you can continue with the installation of Android/Linux here with the guides below: + +[Android installation guide :material-arrow-right:](../../extras/installing_android.md){ .md-button .md-button--primary } [Linux installation guide :material-arrow-right:](../../extras/installing_linux.md){ .md-button .md-button--primary } + +??? "Frequently Asked Questions about this page" + - **Q: How can you verify that sysCFW / emuMMC launched properly?**
+ A: Once you boot into the Switch's HOME Menu, navigate to Settings > System. The system version should be prefixed with an S or E, standing for SysMMC or EmuMMC respectively. Seeing either of these confirms which environment you are using. + - **Q: What options do you have for rebooting to Hekate while booted into CFW?**
+ A: If you use a modchip, your console will automatically boot into whatever payload that your modchip would normally boot into via a coldboot, after clicking the restart button in the power-off menu. This can be any payload, but ideally is Hekate. + If you use no modchip (and you're using a V1 console), your console will "reboot-to-payload" by default, triggering whatever fusee payload is located in `atmosphere/reboot_to_payload.bin`. This can be any payload, but ideally is Hekate. + - **Q: Where can I find additional homebrew apps?**
+ A: One of the more convenient sources is the (Homebrew App Store)[https://github.com/fortheusers/hb-appstore/releases], hosted by (4TU)[https://gitlab.com/4TU]. You can also browse the (r/SwitchHacks)[https://www.reddit.com/r/SwitchHacks/] subreddit. diff --git a/docs/user_guide/all/making_essential_backups.md b/docs/user_guide/all/making_essential_backups.md new file mode 100644 index 00000000..d69aa13c --- /dev/null +++ b/docs/user_guide/all/making_essential_backups.md @@ -0,0 +1,58 @@ +# Making Essential Backups + +### **Making a NAND Backup** + +!!! danger "Important" + A NAND backup is crucial to have, it's a full backup of the internal storage of your Switch and can be used to restore the device to a working state in case of emergencies. **DO NOT SKIP THIS STEP** + + Once the backup is finished, **keep it somewhere safe.** The best backup is the one you have but never need, and the worst backup is the one you need but never made. To save space, it's recommended to compress the end-result with a `.zip` file or something similar. + + It's highly recommended that you use an microSD card that is formatted to FAT32 and has at least 32 gigabytes of space free. This will still work on smaller cards, but it's not ideal. + +#### **Instructions:** + +1. Enter RCM and inject the Hekate payload. + - If you use a modchipped Switch, you can simply just turn your Switch on with the Hekate payload renamed to `payload.bin` on the root of your microSD card. +2. Use the touch screen or Joy-Cons to navigate to `Tools` > `Backup eMMC`. +3. Tap on `eMMC BOOT0 & BOOT1` + - This should only take a few seconds, but if your microSD card is very slow, it may take around a minute. +4. Tap on `Close` to continue, then tap on `eMMC RAW GPP` + - This will take a long time. Expect it to take between 10 minutes to an hour (or more, if your microSD card is very slow). + - If your microSD card has less than 32GB of space available, please follow [these instructions](#on-fat32-formatted-microsd-cards-or-cards-that-have-less-than-32-gigabytes-of-space-available-the-nand-backup-will-be-split-into-1-or-2-gigabyte-parts) instead. +5. Go to the top right and press `Close` > `Home`. +6. Navigate to `Tools` > `USB tools` > `SD card` and plug your Switch into your PC via USB. +7. Copy the `backup` folder on your microSD card to a safe location on your PC. +8. Once done, you may delete the `backup` folder from the root of your microSD card and eject the `UMS` device safely from within your computer's operating system, then return to Hekate's `Home` menu. + +??? note "About microSD cards with less than 32GB of free space" + + #### On FAT32 formatted microSD cards or cards that have less than 32 gigabytes of space available, the NAND backup will be split into 1 or 2 gigabyte parts. + Hekate will stop producing these parts when it runs out of space. When this happens, do the following: + + 1. Press `OK` when Hekate tells you to back up your stuff. + { width=600 } + 2. Press `Close` > `Close` > `USB Tools` > `SD Card` and connect your Switch to your PC via USB. + 3. Your microSD card should now be accessible on your PC, move the `backup` folder on the root of your microSD card to a safe location on your PC. + - *If* you are prompted to merge folders, do so. + 4. Eject the `UMS` device safely from within your computer's operating system and close the UMS window in Hekate. + 5. Press `Close` > `Backup eMMC` > `eMMC RAW GPP` and continue backing up your NAND. + 6. Repeat step 2-5 until the NAND is completely dumped. + 7. Once done, return to Hekate's `Home` menu. + +----- + +##### **Booting into CFW** + +
+
+- Click the button below to continue to Launching **emuMMC**!
+ [Launching CFW (emuMMC) :material-arrow-right:](launching_cfw.md#__tabbed_1_1){ .md-button .md-button--primary }
+
+- Click the button below to continue to Launching **sysCFW**!
+ [Launching CFW (sysCFW) :material-arrow-right:](launching_cfw.md#__tabbed_1_2){ .md-button .md-button--primary }
+
+
+
+??? "Frequently Asked Questions about this page"
+ - **Q: Why is making a NAND backup considered crucial?** + A: A NAND backup contains a complete snapshot of the internal files of your Switch, including console-specific files that cannot be regenerated if accidentally lost. This is why it is **mandatory** to keep at least one copy of your NAND backup in a safe place, even if it takes a lot of space. The consequence to not having one is, at best, a Switch that cannot connect to Nintendo Network, or at worst, a full brick. However, it is important to note that it is nearly impossible to permanently brick a hackable Nintendo Switch. diff --git a/docs/user_guide/all/partitioning_sd.md b/docs/user_guide/all/partitioning_sd.md new file mode 100644 index 00000000..e99221c4 --- /dev/null +++ b/docs/user_guide/all/partitioning_sd.md @@ -0,0 +1,30 @@ +# Partitioning the microSD Card and creating the emuMMC + +### **What you need:** + +- Your Switch loaded into Hekate + +### **Instructions:** + +1. Navigate to `Tools` > `Partition SD card` +2. Set the `emuMMC (RAW)` slider to `29 FULL` in the middle of the bar. + - Set the `emuMMC (RAW)` slider to `58 FULL` if you're on an OLED Switch. + - If you wish to install Android and/or Linux later, partition your microSD card here accordingly by moving the sliders you see during this step. We recommend setting the `Android (USER)` and `Linux (EXT4)` sliders to 16GB minimum. + - For Android; Select `Legacy` partitioning if you wish to install Android 10/11 and `Dynamic` partitioning if you wish to install Android 13+. Legacy and Dynamic partitioning are **NOT** intercompatible. +3. Navigate to `Next Step` at the bottom right, then select `Start` in the menu that appears. +4. From hekate's `Home` menu, navigate to `emuMMC` > `Create emuMMC` > `SD Partition` > `Part 1` and wait for Hekate to complete creating the emuMMC. +5. Close the emuMMC creation menu by navigating to the `Close` button, then navigate to `Change emuMMC` > `SD RAW 1` and press the `Close` button twice in the top right to return to hekate's `Home` menu. +6. Once done, go to `Tools` > `USB tools` > `SD card` and plug your Switch into your PC via USB. +7. Continue with the next step of the guide. + - Your microSD card should now be accessible on your PC, if not, consult the warning message below. + +!!! warning "Your microSD card is not showing up or Windows complaining about an unreadable drive" + If you get the issue that Windows says the microSD card is unreadable and wants to format it, do not format! This is likely your emuMMC partition. After partitioning your SD, your microSD will show up as 2 drives on your PC. Use the accessible drive. + If your microSD card isn't showing up at all, ensure that you're using a USB cable capable of data transfer and that, if you use Windows, Windows has assigned a drive letter to the FAT32 partition of your SD. If you still experience errors, join the NH-Discord server for support. + + + + + + +[Continue to SD Preparations :material-arrow-right:](sd_preparation.md){ .md-button .md-button--primary } diff --git a/docs/user_guide/all/partitioning_sd_syscfw.md b/docs/user_guide/all/partitioning_sd_syscfw.md new file mode 100644 index 00000000..a04e37e3 --- /dev/null +++ b/docs/user_guide/all/partitioning_sd_syscfw.md @@ -0,0 +1,24 @@ +# Formatting and/or partitioning the microSD Card + +### **What you need:** + +- Your Switch loaded into Hekate + +### **Instructions:** + +1. Navigate to `Tools` > `Partition SD card` +2. Navigate to `Next Step` at the bottom right, then select `Start` in the menu that appears. + - If you wish to install Android and/or Linux later, partition your microSD card here accordingly by moving the sliders you see during this step. We recommend setting the `Android (USER)` and `Linux (EXT4)` sliders to at least 16GB. + - For Android; Select `Legacy` partitioning for Android 10/11 and `Dynamic` partitioning for Android 13+. Legacy and Dynamic partitioning are **NOT** intercompatible. +3. Once done, go to Hekate's `Home` menu and then `Tools` > `USB tools` > `SD card` and plug your Switch into your PC via USB. +4. Continue with the next step of the guide. + - Your microSD card should now be accessible on your PC. If not, consult the warning message below. + +!!! warning "Your microSD card is not showing up" + If your microSD card isn't showing up at all, ensure that you're using a USB cable capable of data transfer and that if you use Windows, Windows has assigned a drive letter to the FAT32 partition of your microSD card. If you still experience errors, join the NH-Discord server for support. + + + + + +[Continue to SD Preparations :material-arrow-right:](sd_preparation.md){ .md-button .md-button--primary } diff --git a/docs/user_guide/all/sd_preparation.md b/docs/user_guide/all/sd_preparation.md new file mode 100644 index 00000000..83ec3a84 --- /dev/null +++ b/docs/user_guide/all/sd_preparation.md @@ -0,0 +1,47 @@ +# **microSD Card preparations** + +### **Information** + +We will now place the required files for the Atmosphère custom firmware and some additional homebrew files on the microSD card. + +Atmosphere has its own bootloader, called fusee. For the purposes of this guide we will be using Hekate instead, so that we can back up the system's NAND (internal storage) and take advantage of other advanced features in the future. + +!!! warning "File name extensions" + If you use Windows, you should enable file name extensions before continuing. See [this link](../../extras/showing_file_extensions.md) for a guide on how to do this. + +----- + +#### **What you need:** +- The latest release of Hekate (Download the `hekate_ctcaer_(version).zip` release of hekate) +- The Hekate config file: hekate_ipl.ini +- The DNS.MITM DNS redirection config: emummc.txt +- The bootlogo zip folder: bootlogos.zip +- The latest release of Atmosphere. Download the `atmosphere-(version)-master-(version)+hbl-(version)+hbmenu-(version).zip` release of Atmosphere. +- The latest release of JKSV (Download the `JKSV.nro` release of JKSV) +- The latest release of FTPD (Download the `ftpd.nro` release of FTPD) +- The latest release of NXThemesInstaller (Download the `NXThemesInstaller.nro` release of NXThemesInstaller) +- The latest release of NX-Shell (Download the `NX-Shell.nro` release of nx-shell) +- The latest release of Goldleaf (Download the `Goldleaf.nro` release of Goldleaf) + +#### **Instructions:** +1. Navigate to the accessible drive. +2. Copy *the contents of* the Atmosphère`.zip` file to the root of your microSD card. +3. Copy the `bootloader` folder from the Hekate `.zip` file to the root of your microSD card. +4. Copy the `bootloader` folder from the `bootlogos.zip` file to the root of your microSD card. + - If you're asked to merge the bootloader folders, do so. +5. Copy `hekate_ipl.ini` to the `bootloader` folder on your microSD card. +6. Create a folder named `hosts` inside the `atmosphere` folder on your microSD card, and put `emummc.txt` in it. +7. Copy `JKSV.nro`, `ftpd.nro`, `NxThemesInstaller.nro`, `NX-Shell.nro` and `Goldleaf.nro` to the `switch` folder on your microSD card. +8. If you were already using your microSD card as a storage device for your games and backed up the Nintendo folder before partitioning your microSD card, please place it back on the root of your microSD card now. + - If you created an emuMMC on the previous page, don't forget to copy the Nintendo folder to `sd:/emuMMC/RAW1/`! + + !!! danger "About emummc.txt" + Putting the `emummc.txt` file provided by this guide into `/atmosphere/hosts` will prevent your emuMMC (emuNAND) from connecting to Nintendo. Not doing this will likely result in a ban. + + !!! tip "" + Your microSD card should look similar to the image below. The `Nintendo` folder will not be present if your Switch has not already booted with the microSD card inserted and the `emuMMC` folder will not be present if you're following the sysCFW path of the guide/you haven't created an emuMMC! + `payload.bin` will not be present if you're using an unpatched Switch. + +  + +[Continue to Making Essential Backups :material-arrow-right:](making_essential_backups.md){ .md-button .md-button--primary } diff --git a/docs/user_guide/emummc/entering_rcm.md b/docs/user_guide/emummc/entering_rcm.md deleted file mode 100644 index 28f6c758..00000000 --- a/docs/user_guide/emummc/entering_rcm.md +++ /dev/null @@ -1,152 +0,0 @@ -# Entering RCM - -As the Switch uses a Tegra X1 processor, it has a special recovery mode that is, in most scenarios, useless for the end-user. Fortunately, due to the fusee-gelee vulnerability, this special mode acts as our gateway into CFW. - -There are several methods of entering RCM (**R**e**C**overy **M**ode). The most affordable of these require nothing more than common household items, while the most reliable are very cheap ($10). - - - -!!! danger "Patched Switch" - Note that patched units **can** enter RCM, but it is not possible to send a payload on those systems. Also note that RCM is a different recovery mode than the one accessed by holding Volume Up, Volume Down, and Power. - -!!! snippet "Note" - The order of methods on this page is in the order of ease. The easiest to immediately accomplish are listed at the top, and the most advanced/difficult methods are at the bottom. - - - -### Instructions - -!!! tip "" - 1. Power off the Switch and use one of the methods listed below to short the pins on the right joycon rail. - 2. Hold Volume Up and press the Power button. - - If your Switch displays the Nintendo logo and boots normally or immediately shuts down, you didn't successfully enter RCM and should try again. Otherwise, if your console did not turn on normally, and the screen remained black with no backlight, your Switch is in RCM. - -!!! tip "" - ### RCM Jig (Easiest for beginners) -
-
-
-!!! tip ""
- ### Soldered Joy-Con Pads - Physical RCM Button (Safest)
- Click to expand!
- - !!! snippet "Note" - Some jig designs use paperclips, inheriting the same risks as the Metal Bridge / Paperclip method. - - !!! snippet "Note" - Once you have successfully entered RCM, you can take the jig out of the joycon rail. - - This method is similar to the Metal Bridge / Paperclip method, but is more reliable and safer in many cases. Jigs hold a wire in place so the correct pins (10 and a ground) are shorted every time. - - !!! tip "" -  - - In the case you plan to make you own jig, this image lays out the pads numbers on the console. Make sure your jig NEVER touches pin 4. Pin 4 provides 5v power to the Joycons, if connected to any other pin you will fry the console. - - !!! tip "" -  - -
-
-
-!!! tip ""
- ### Soldered Joy-Con Pads - 7 & 10
- Click to expand!
- - !!! snippet "Note" - This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart. - - This method comes to us from the mind of pbanj#9188 on Discord. All pictures of this method in action were provided by him, with some supplementary images provided by eip ∞#3283 on Discord. - - The goal of this method is to open the right handed Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however you will be soldering wires to pins 7 and 10 (shown below) and wiring them to the "Joycon release button" at the top back of the right hand Joycon. - - !!! tip "" -  - - In order to start this method you will want to take two lengths of wire, and wrap one end of each into a small circle. - - !!! tip "" -  - - You will then want to take the circular end of one of the wires and add a small amount of solder, keeping it mostly flat (ONLY DO THIS TO ONE OF THE WIRES!). You will then glue this wire down to the below point on the Joycon release button. Make sure glue doesn't cover the top of the solder/wire as it will act as a contact point. Also, ensure that you leave enough space for the button to function correctly. Try pushing the button from the outside and observing its travel path so that you can see where and how you should safely glue the solder glob. - - !!! tip "" -  - - !!! tip "" -  - - The first wire should now be in place as seen by the green circle below. The second wire does not need any solder, instead you will hold it in place using the screw as shown by the red circle in the picture below. - - !!! tip "" -  - - Pressing the Joycon button in you should now notice the solder point you created making contact with the piece of metal held in by the screw. Once you have these elements in place you want to connect one wire to pad 7 and the other to pad 10 (it doesn't matter which is which). After that you have successfully created an RCM button on your Joycon. You will now need to hold down the Joycon release button when attempting to boot RCM. - - !!! tip "" -  -
-
-
-!!! tip ""
- ### Soldered Joy-Con Pads - 9 & 10
- Click to expand!
- - !!! snippet "Note" - This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart. - - The goal of this method is to open the right handed Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however the goal is to solder pins 7 and 10 (shown below) together with a surface-mount 0805 10k resistor. Apart from using a physical switch/button, this is currently considered the safest method that involves soldering to pads. - - !!! tip "" -  - - Here is an example from stuckpixel#3421 on the ReSwitched Discord server. - - !!! tip "" -  -
-
-
-!!! tip ""
- ### Bent Joy-Con Pins (Not recommended)
- Click to expand!
- - !!! snippet "Note" - This method will result in the right Joy-Con being detected as in wireless mode while attached to the Switch, and this method may result in the Joy-Con being permanently detected as wireless if you update the Joy-Con firmware while this mod is installed. In the latter case, fixing this requires opening up the Joy-Con and reseating the battery. It is recommended to solder pads 7 and 10 together with a resistor instead. - - !!! snippet "Note" - This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart. - - The goal of this method is to open the right handed Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however the goal is to solder pads 9 and 10 (seen below) together. This can either be done using a small wire, or directly bridging the pads with solder. - - !!! tip "" -  - - Here is an example from YyAoMmIi#3705 on our Discord server. - - !!! tip "" -  -
-
-
-
-
-#### [Continue to Sending a Payload ](sending_payload.md)
diff --git a/docs/user_guide/emummc/launching_cfw.md b/docs/user_guide/emummc/launching_cfw.md
deleted file mode 100644
index 92febdcf..00000000
--- a/docs/user_guide/emummc/launching_cfw.md
+++ /dev/null
@@ -1,65 +0,0 @@
-# Launching CFW
-
-Now that the preparation work is out of the way, we're finally ready to launch custom firmware on the Switch.
-
-Unlike systems such as the DSi, Wii, or 3DS, Switch CFW is currently volatile. It will only work as long as your Switch is on. As soon as your Switch completely loses power for any reason (shutting down, battery dying, etc.), CFW will no longer be active and you will need to follow these instructions again.
-
-
-
-!!! danger "Keep emuMMC offline at all times"
- Your emuMMC (emuNAND) should never connect to Nintendo. For online play, eShop browsing, or any other Nintendo online activity, use your sysNAND. Using both emuMMC and sysNAND online will likely result in a ban.
-
-### Instructions
-
-!!! tip ""
- 1. Power on your Switch into RCM, and inject the Hekate payload
- 2. Navigate to `Launch` using the touch screen
- 3. Find `Atmosphere FSS0 emuMMC` and launch it
-
-Your Switch is now booting into Atmosphere.
-
-To verify Atmosphere launched properly, open the Settings applet, and navigate to System. You should see `AMS` next to the version number, as well as an `E` at the end, indicating you are booted into emuMMC.
-
-
-
-!!! tip ""
- 
-
-
-
-!!! tip "Reboot to Hekate"
- Once booted into emuMMC, you can easily get back to Hekate by holding the power button, and selecting `Restart` in the power menu.
-
-
-
-### Launching the Homebrew Menu
-
-You will now be able to launch the Homebrew Menu by opening the album or by holding the R button while launching any game (including demos/cartridges), or application (e.g. Youtube/Hulu). If R is not held, the game or application will launch like normal.
-
-!!! warning "A note about using the album for the Homebrew Menu"
- - Using the album for the Homebrew Menu instead of a game or application has several limitations, including but not limited to: a smaller amount of available memory (RAM), as well as being unable to launch a full-featured web browser. It is strongly recommended to launch homebrew through applications or games instead.
-
-!!! tip "Adding new applications"
- - Place homebrew applications (`.nro` files) into the `switch` folder on your SD card.
-
-
-
-### What the included homebrew applications do
-
-!!! tip ""
- - JKSV is a save manager, it can dump and restore saves from/to your system. For more information, see [Save Management](../../extras/save_management.md)
-
- - FTPD is a ftp tool for connecting your Switch's sd card wirelessly to your pc. Tools like WinSCP can connect to your switch on `(ip of switch):5000`
-
- - NX-Shell is a file explorer for the Switch. You can move files, listen to mp3's, view images etc.
-
- - NXThemeInstaller is a theme installer app. See the [Theming section of our guide](../../extras/theming.md) for more information
-
- - hbappstore is a homebrew app store where a large collection of switch homebrew is kept.
-
-
-
-### Updating your setup
-
-!!! tip ""
- Whenever a new Switch firmware update releases you may need to update your files to be able to use CFW on the new version. Make sure to follow the instructions on [this page](../../extras/updating.md) to update your setup correctly.
diff --git a/docs/user_guide/emummc/linux_partitioning.md b/docs/user_guide/emummc/linux_partitioning.md
deleted file mode 100644
index 57c65c68..00000000
--- a/docs/user_guide/emummc/linux_partitioning.md
+++ /dev/null
@@ -1,48 +0,0 @@
-## Manual Linux Preperations
-
-!!! danger "SD card identification"
- Make 100% sure you get your microSD card during the following steps. If you are not careful, you can end up wiping your entire linux filesystem. We are not responsible for data loss when doing this.
-
-!!! warning "Who is this for?"
- This section is for the people who do not want to let a tool automatically modify their sd, and want to do it manually for more control over what gets created. This section helps with that
-
-!!! tip "What you will need (Linux)"
- - The latest version of `gparted`
- - The latest version of `fdisk`
- - Access to an administrator account.
-
-### Manual instructions (Linux)
-
-1. Open a terminal.
-2. Run `sudo fdisk -l`. Enter your password if prompted. This will print information about all drives connected to your computer. Use the information about the file size to identify your microSD card. Specifically, take note of the line after `Disk `. This will look something like `/dev/xxx`, where `xxx` will differ on your system (can also be longer than three characters). It does NOT end with a number.
-3. Run `sudo gparted Click to expand!
- - !!! snippet "Note" - This method will result in the right Joy-Con being detected as in wireless mode while attached to the Switch, and this method may result in the Joy-Con being permanently detected as wireless if you update the Joy-Con firmware while this mod is installed. In the latter case, fixing this requires opening up the Joy-Con and reseating the battery. - - !!! snippet "Note" - This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart. - - The goal of this method is to open the right handed Joy-Con to the point that you can reach the contact pads easily, and use a thin object such as a knife to gently bend pin 9 and 10 (shown below) slightly up and towards each other so they touch, shorting them. - - !!! tip "" -  - - Here is an example from Sonlen#1414 on our Discord server. - - !!! tip "" -  -Once you obtain any bootable title, you are prepared to continue on with the guide. -!!! note "Note" - Nereba and Caffeine how-to guides are currently a Work-In-Progress (WIP)! +----- -!!! note "Note" - While the "New" Switch (HAC-001-01)'s earliest possible firmware is 7.0.1, it is **not** vulnerable to *déjà vu*, the exploit used by Nereba and Caffeine, because of hardware differences from the "Old" Switch (HAC-001). +
-
+- #### If your Switch is not patched, click the button below to follow the RCM path of the guide.
-| Firmware Version | Unpatched Switches (HAC-001) | Patched Switches (HAC-001) | "New" Switch (HAC-001-01) | Switch Lite (HDH-001) |
-|:---------------|:--------------------------------|:---------------------------|:----------------------------|:-----------------------|
-| 1.0.0 | Nereba or [**RCM**](rcm.md) | **N/A** | **N/A** | **N/A** |
-| 2.0.0 - 3.0.2 | Caffeine or [**RCM**](rcm.md) | **N/A** | **N/A** | **N/A** |
-| 4.0.0 - 4.1.0 | Caffeine or [**RCM**](rcm.md) | Caffeine | **N/A** | **N/A** |
-| 5.0.0 - 7.0.0 | [**RCM**](rcm.md) | Wait for CFW | **N/A** | **N/A** |
-| 7.0.1 | [**RCM**](rcm.md) | Wait for CFW | Cart update to 8.0.1 | **N/A** |
-| 8.0.1 | [**RCM**](rcm.md) | Wait for homebrew | Wait for homebrew | Wait for homebrew |
-| 8.1.0 and up | [**RCM**](rcm.md) | Unhackable (currently) | Unhackable (currently) | Unhackable (currently) |
+ [Continue to RCM :material-arrow-right:](rcm/index.md){ .md-button .md-button--primary }
-
+- #### If your Switch is patched and modchipped, click the button below to follow the Modchip path of the guide.
-!!! note "About OLED"
- OLED Switches (HEG-001) are currently unhackable via software.
+ [Continue to Modchip introduction :material-arrow-right:](modchip/index.md){ .md-button .md-button--primary }
-
+
+
+??? "Frequently Asked Questions about this page"
-#### [If your Switch is not patched, continue to RCM ](rcm.md)
+ - **Q: How reliable is the crowdsourced list of vulnerable serial numbers, and what if my serial number is not listed?** + A: To our knowledge, there hasn't been a single console which has disproved the trends documented here. Unless your serial is potentially patched, you can be certain that the table is accurate to reality. + - **Q: Why is it essential to install at least one eShop title before setting up homebrew, and what is "title takeover"?**
+ A: By default, the homebrew menu and its apps inherit the resources of the Album applet. Applets don't have as many system resources as full apps, and as such have inconsistent behavior when used for homebrew purposes. Title takeover ensures the best performance, and is required for some homebrew. + - **Q: Why is the "New" Switch (HAC-001(-01) not vulnerable to *déjà vu*, and what are the implications for Switch Lite (HDH-001) and OLED Switch consoles?**
+ A: Despite being exploitable via software, *déjà vu* is actually a bootROM exploit that isn't present in the new bootROM of the Tegra X1+. diff --git a/docs/user_guide/img/ability.png b/docs/user_guide/img/ability.png new file mode 100644 index 00000000..7c1c66cb Binary files /dev/null and b/docs/user_guide/img/ability.png differ diff --git a/docs/user_guide/img/emummc_final_minitool.png b/docs/user_guide/img/emummc_final_minitool.png deleted file mode 100644 index 66392ad6..00000000 Binary files a/docs/user_guide/img/emummc_final_minitool.png and /dev/null differ diff --git a/docs/user_guide/img/gparted.png b/docs/user_guide/img/gparted.png deleted file mode 100644 index 21fc57fd..00000000 Binary files a/docs/user_guide/img/gparted.png and /dev/null differ diff --git a/docs/user_guide/img/minitool1.png b/docs/user_guide/img/minitool1.png deleted file mode 100644 index 8ff09e63..00000000 Binary files a/docs/user_guide/img/minitool1.png and /dev/null differ diff --git a/docs/user_guide/img/minitool2.png b/docs/user_guide/img/minitool2.png deleted file mode 100644 index 2d33523c..00000000 Binary files a/docs/user_guide/img/minitool2.png and /dev/null differ diff --git a/docs/user_guide/modchip/index.md b/docs/user_guide/modchip/index.md new file mode 100644 index 00000000..a41f8eef --- /dev/null +++ b/docs/user_guide/modchip/index.md @@ -0,0 +1,55 @@ +### **Introduction to Modchips** + +!!! info "information" + Unlike "unpatched" consoles, modchips enable CFW via CPU voltage glitching, which bypass bootROM firmware verifications. It allows a ``payload.bin`` file to be launched in place of BOOT0, loaded via a modchip firmware module named `sdloader`. This is much different from RCM and its exploit, [fusee-gelee](https://github.com/Qyriad/fusee-launcher/blob/master/report/fusee_gelee.md), which "unpatched" consoles use. + Modchips allow any console (like all "patched" consoles) to run CFW! + +### **General knowledge** + +Patched Switch consoles, except certain original V1 consoles made from 2017 to mid-2018, are immune to the fusee-gelee exploit in RCM. Attempting to inject a payload on a Patched console will be unsuccessful. + +Depending on your modchip's firmware, you may not be able to boot the console without a microSD card inserted. +This means without a microSD inserted at all times, your Switch becomes *unusable*. + +If you do turn on your Switch without a microSD card inserted, you should end up at a splash screen saying something along the lines of `NO SD`. + +???+ note "About modchips and their firmware versions" + Some modchip firmwares (e.g., Spacecraft-NX, Hwfly-NX and the Picofly firmware) allow bypassing `sdloader` by holding one - or both - of the volume buttons during power-on, enabling normal boot without a microSD card. Not all modchips support manual firmware updates. + +Modchipped Switch consoles allow untethered, coldboot CFW loading, directly entering custom firmware without external devices like dongles or jigs. This is in contrast to the tethered coldboot "RCM" entrypoint. + +- "Untethered coldboot" means being able to turn on your console from a fully-off ("cold") state directly into custom firmware, without external devices such as a dongle, payload injector, or jig. + +Running CFW on modchipped consoles is more simplistic, as it only requires you to have `payload.bin` present on the root of your microSD card when you turn on the system. + +Furthermore, this guide assumes you have a functional modchip installation. + +----- + +### **Important** +If you do decide to follow the recommended emuMMC path later in the guide, make sure you disable [Automatic Save Data Cloud backups/downloads](https://www.nintendo.co.uk/Support/Nintendo-Switch/How-to-Enable-Disable-Automatic-Save-Data-Backups-and-Downloads-1434310.html) beforehand as well as making sure [the Switch is set as Primary Console](https://en-americas-support.nintendo.com/app/answers/detail/a_id/22453/~/how-to-change-the-primary-console-for-your-nintendo-account). + + +!!! danger "Disclaimer" + We **ONLY** support the Picofly modchip (the `RP2040 Zero` development board and the "modchip variant" of it). Installing a modchip safely is your responsibility, so if you don't trust yourself, get someone trusted to perform the install. + There is always a risk of your Switch being rendered dysfunctional when messing with its hardware without proper experience. + The NH-Discord server is not for fixing bad modchip installations. + We can give advice and installation tips for the installation as long as it's for a Picofly modchip. + +[Continue to Preparing Hekate :material-arrow-right:](preparing_hekate.md){ .md-button .md-button--primary } + +??? "Frequently Asked Questions about this page" + - **Q: Can you provide more information about modchip firmwares, specifically regarding their impact on the boot process and the ability to bypass the sdloader?**
+ A: Modchip firmwares indirectly determine the functionality of your system. Modern modchips (such as Picofly) typically have firmware flashed to them that support all hardware configurations (namely eMMC brands like Hynix, Samsung and Toshiba) "out-of-the-box" and also allow you to bypass `sdloader`. If this is not the case however, flashing the firmware manually is required by opening up the Switch and using the USB debug port that comes with the modchip to flash the modchip directly. This is especially required in the cases where the eMMC brand is not supported, as your Switch wouldn't boot whatsoever and the modchip would be stuck while trying to glitch/train and write its payload to the `BOOT0` partition of the internal storage. + + - **Q: What different types of modchips are there?**
+ A: There are three main types of modchips for the Nintendo Switch. Only two of them are relevant for this guide.
+ On the V1 Nintendo Switch, a chip can be installed which automatically injects a payload whenever the console is detected in RCM. This type of modchip is **not** supported by this guide.
+ On all other Switch consoles, there are DIY "Picofly" modchips which can be created with Raspberry Pi parts and custom cables. These use special firmwares, and are not compatible with firmwares intended for other modchips.
+ There are also other "commercial" modchips of dubious origin by the name of "hwfly" or "SX Core/Lite"; we only will help with flashing new firmwares onto these, if you happen to already have one of them installed. Do not ask for assistance installing or sourcing this type of modchip. + + - **Q: Can you further explain the concept of running homebrew "over a title" and why it allows for higher resource allocation?**
+ A: The default way to run homebrew within Atmosphère is via the Album applet on the HOME Menu. However, applets have significantly less resources compared to full applications, and homebrew tools often run into constraints with these limits. By holding a button while launching normal apps while in CFW, you can load the Homebrew menu in their stead with full resources. + + - **Q: What makes Picofly the only supported modchip, and what are the potential risks associated with installing a modchip on your Switch without proper experience?**
+ A: Picofly is a fully open-source modchip, from the firmware to the RP2040 microcontroller it uses. Other "commercial" modchips have dubious origins, or were manufactured by [established illegal piracy groups](https://www.justice.gov/opa/pr/two-members-notorious-videogame-piracy-group-team-xecuter-custody) that have no place in the homebrew community. For the safety of your console and to respect the law of where NH Server is based, we will not assist with sourcing these types of modchips. diff --git a/docs/user_guide/modchip/preparing_hekate.md b/docs/user_guide/modchip/preparing_hekate.md new file mode 100644 index 00000000..6cb3cb25 --- /dev/null +++ b/docs/user_guide/modchip/preparing_hekate.md @@ -0,0 +1,51 @@ +# **Payload and bootloader folder placement** + +To get ready for formatting and/or partitioning your microSD card, we will need to prepare and place the required files on the microSD card. + +!!! danger "Following the guide will delete everything on your microSD card!" + Later in the guide, you will be formatting and/or partitioning your microSD card. This means that all data on the microSD card will be lost. Now is a good time to back up *all* of its data to a safe place (for example, on your PC or external drive) so that you can restore it later. You can do this by following the instructions below. + +----- + + +#### **What you need:** +- The latest release of Hekate (Download the `hekate_ctcaer_(version).zip` release of Hekate) +- Your microSD card + +#### **Instructions:** + +1. Extract the Hekate `.zip` to a location on your computer. +2. Insert your microSD card into your computer. +3. Copy the `Nintendo` folder (and any other important data) from the root of your microSD card to a safe space on your device. +4. Inside of the extracted Hekate folder, you will find the `bootloader` folder and the `hekate_ctcaer_(version).bin` payload. +5. Copy the `bootloader` folder and `hekate_ctcaer_(version).bin` payload to the root of your microSD card. +6. Rename the `hekate_ctcaer_(version).bin` payload to `payload.bin` +7. Insert your microSD card back into your Switch, then turn it on. +8. You should now be loaded into the Hekate GUI (Nyx), pictured below, within seconds. +{ width="600" } + - If you are unable to load into Nyx, consult the warning message below. + +!!! warning + If your Switch does not load into the Hekate GUI, or shows a `No SD Card`/`No Payload` screen when turning on the console, ensure that you inserted your microSD card and that Hekate's `payload.bin` is on the root of the microSD card. + + +[Continue to choosing your CFW environment :material-arrow-right:](../all/cfw_environment.md){ .md-button .md-button--primary } + +??? "Frequently Asked Questions about this page" + **Q: Can I use a microSD card with existing data, or does it need to be formatted specifically for this process?**
+ A: It is recommended that you use a microSD that is already formatted as FAT32 before starting. In addition, it is important that the microSD card does not have any data from other Switch consoles already on it. + + **Q: What makes Hekate the recommended choice in this guide?**
+ A: Hekate is a polished, multi-purpose bootloader for the Switch. It has the tools to facilitate simple usage of custom firmware and custom operating systems, and aids with organisation and formatting later on in this guide.
+ + **Q: How do you pronounce "Hekate"?**
+ A: Hekate comes from Greek. The most commonly accepted pronunciations are "HEK-ate", "HEK-uh-tee", and "hek-AH-tay". + + **Q: What role does the `/bootloader` folder play in the overall functionality of Hekate?**
+ A: The bootloader folder contains crucial parts of Hekate that can't fit in the injectable RCM/modchip payload, such as Nyx; Hekate's touch-enabled GUI. If you start Hekate without these files on your microSD, Hekate's functionality will be severely limited. + + **Q: How often should I check for updates to Hekate, and what benefits do newer releases bring to the process?**
+ A: Nintendo Homebrew's #announcements channel will automatically poll for updates to Atmosphère and Hekate, letting you know when updates are available for them. In general, you'll want to look for updates whenever a major Switch system update is launched, as major updates will stop Horizon from booting until Hekate and Atmosphère are updated accordingly. + + **Q: Does this process have any effect on the Switch's system or data?**
+ A: No, nothing in the guide has had any permanent effect on the Switch so far. diff --git a/docs/user_guide/rcm.md b/docs/user_guide/rcm.md deleted file mode 100644 index 6b8e21e9..00000000 --- a/docs/user_guide/rcm.md +++ /dev/null @@ -1,37 +0,0 @@ -# RCM - -RCM (short for ReCovery Mode) is a mode for the switch that allows nintendo to send the switch commands to do various things. People found out that on unpatched switches, you could send a payload, and then quickly copy it into the memory buffer behind the stack, overflowing the memory buffer into the stack, meaning you smash the stack and get full access to everything on the system. We use it here to launch atmosphere. - -!!!tip "emuNAND vs emuMMC vs sysNAND" - - sysNAND stands for System NAND, meaning the internal storage in your actual Switch. - - emuNAND stands for emulated NAND, this means that your entire NAND (system memory) will run off your microSD card with Custom Firmware (CFW). This NAND's contents (games, applications, saves, etc.) are *completely separate* from your sysNAND. - - emuMMC is the name for the currently used implementation of emuNAND on Switch. It has no difference from emuNAND besides name. - ----- - -### emuNAND CFW (**Recommended for new users**) - -!!!tip "What's needed for emuNAND" - - A microSD card that's 64GB or larger - - #### Pros of using emuNAND over sysNAND CFW: - - - Using homebrew applications and CFW features in a safe environment that won't connect to Nintendo services, while the sysNAND can be used online. - - Allowing users on patched Switches using Caffeine to update their emuNAND to latest and use it online, keeping sysNAND at a lower vulnerable version. - - - -#### [Continue to Entering RCM (emuNAND) ](emummc/entering_rcm.md) ------ - - -### sysNAND CFW - -This is for the people who don't have an 64GB microSD card or larger, or who don't need/want an emuNAND. - -!!!note "Note" - If you set up an emuNAND you may still have CFW on your sysNAND if you choose to use it. You do not have to follow the guide linked below; all the files are the same, you simply select "sysNAND CFW" from Hekate/Nyx. - - - -#### [Continue to SD preparations (sysNAND CFW) ](sysnand/sd_preparation.md) diff --git a/docs/user_guide/rcm/entering_rcm.md b/docs/user_guide/rcm/entering_rcm.md new file mode 100644 index 00000000..007b3469 --- /dev/null +++ b/docs/user_guide/rcm/entering_rcm.md @@ -0,0 +1,132 @@ +### **Entering RCM** + +The Switch's Tegra X1 processor has a recovery mode referred to shorthand as RCM, intended to be useless for end-users. Fortunately, due to the fusee-gelee vulnerability, this special mode acts as our gateway into CFW. + +Methods to enter RCM can require nothing more than household items (not recommended) to affordable tools ($5-10) available on platforms like AliExpress and Amazon. Avoid the "metal bridge" or "paperclip method" as it can damage your console. You can also consider 3D printing necessary tools. + +!!! danger "Patched Switch" + Note that patched units **can** enter RCM, but it is not possible to send a payload on those systems. Also note that RCM is a different recovery mode than the one accessed by holding Volume Up, Volume Down and powering on your console. + +!!! note "Information about the methods below" + The order of methods on this page is in the order of ease. The easiest method to immediately accomplish is the `RCM Jig` method. The most advanced/difficult methods are mentioned in the other tabs and should not be attempted by most people as they require voiding your warranty and/or soldering. + **USING A PAPERCLIP OR TIN FOIL CAN/WILL DAMAGE YOUR CONSOLE, DO NOT DO THIS!** + +----- + +#### **Instructions:** + +1. Power off the Switch and short the pins on the Joy-Con rail using one of the methods listed below. +2. While holding the `Volume Up` button, press the `Power` button once while holding `Volume Up`. + - If your Switch displays the Nintendo logo and boots normally (or the screen was on and goes black), you didn't successfully enter RCM and should try again. Otherwise, if your console still has a black screen (even after tapping the power button again), your Switch is in RCM and you can let go of the `Volume Up` button. +3. Once your Switch is in RCM, remove the RCM jig (if applicable) and continue with the next page of the guide by clicking on the button at the bottom of this page. + +----- + +=== "RCM Jig" + + Some jig designs use paperclips, inheriting the same risks as the "metal bridge" / "paperclip method" and should not be done. + + Once you have successfully entered RCM, you can take the jig out of the Joy-Con rail. + + This method is similar to the "metal bridge" / "paperclip method", but is more reliable and safer in many cases. Jigs hold a wire in place so the correct pins (10 and a ground) are reliably shorted. + + #### The RCM jig pictured below is the model we recommend: + + { width="250"} + + ----- + + !!! note "Making your own RCM Jig" + If you plan on making your own jig, the second image lays out the right Joy-Con pad out on the console. Make sure your jig NEVER touches pin 4. Pin 4 provides 5 volts of power to the Joy-Con, and can permanently damage the rail or console if shorted. + { width="600"} + + { width="600"} + + +=== "Soldered Joy-Con Pads - Physical RCM Button" + + This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart. + + This method comes to us from the mind of `pbanj` on Discord. All pictures of this method in action were provided by him, with some supplementary images provided by `eip618` on Discord. + + The goal of this method is to open the right Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however you will be soldering wires to pins 7 and 10 (shown below) and wiring them to the "rail release button" at the top back of the right Joy-Con. + + #### JoyCon pad pinout: + { width="600"} + + In order to start this method you will want to take two lengths of wire, and wrap one end of each into a small circle. + + #### Wire reference: + { width="675"} + + You will then want to take the circular end of one of the wires and add a small amount of solder, keeping it mostly flat (ONLY DO THIS TO ONE OF THE WIRES!). You will then glue this wire down to the below point on the rail release button. Make sure glue doesn't cover the top of the solder/wire as it will act as a contact point. Also, ensure that you leave enough space for the button to function correctly. Try pushing the button from the outside and observing its travel path so that you can see where and how you should safely glue the solder glob. + + #### Joy-Con button: + { width="650"} + + #### Joy-Con button: + { width="650"} + + The first wire should now be in place as seen by the green circle below. The second wire does not need any solder, instead you will hold it in place using the screw as shown by the red circle in the picture below. + + #### Joy-Con button in place: + { width="650"} + + Pressing the Joy-Con button in you should now notice the solder point you created making contact with the piece of metal held in by the screw. Once you have these elements in place you want to connect one wire to pad 7 and the other to pad 10 (it doesn't matter which is which). After that you have successfully created an RCM button on your Joycon. You will now need to hold down the Joycon release button when attempting to boot RCM. + + #### Successful installation: + { width="650"} + + + +=== "Soldered Joy-Con Pads - 7 & 10" + + This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart. + + The goal of this method is to open the right handed Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however the goal is to solder pins 7 and 10 (shown below) together with a surface-mount `0805 10k` resistor. Apart from using a physical switch/button, this is currently considered the safest method that involves soldering to pads. + + #### JoyCon pad pinout: + { width="600"} + + Here is an example from `stuck_pixel` from the ReSwitched Discord server. + + #### Successful installation: + { width="650"} + + + +=== "Soldered Joy-Con Pads - 9 & 10" + + This method will result in the right Joy-Con being seen as "detached" while physically connected to the Switch, so it will not be able to charge. This method may result in the Joy-Con being permanently detected as wireless if you update the Joy-Con firmware while this mod is installed. In the latter case, fixing this requires opening up the Joy-Con and reseating the battery. It is recommended to solder pads 7 and 10 together with a resistor instead. + + This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart. + + The goal of this method is to open the right Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however the goal is to solder pads 9 and 10 (seen below) together. This can either be done using a small wire, or directly bridging the pads with solder. + + #### JoyCon pad pinout: + { width="600"} + + Below is an example from `yami0666` from our Discord server. + + #### Successful soldering job: + { width="650" } + + +=== "Bent Joy-Con Pins (Not recommended)" + + This method will result in the right Joy-Con being detected as in wireless mode while attached to the Switch, and this method may result in the Joy-Con being permanently detected as wireless if you update the Joy-Con firmware while this mod is installed. In the latter case, fixing this requires opening up the Joy-Con and reseating the battery. + + This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart. + + The goal of this method is to open the right handed Joy-Con to the point that you can reach the contact pads easily, and use a thin object such as a knife to gently bend pin 9 and 10 (shown below) slightly up and towards each other so they touch, shorting them. + + #### JoyCon pinout: + { width="600"} + + Here is an example from `sonlen` on our Discord server. + + #### Bent Joy-Con pins: + { width="650"} + + +[Continue to Sending a Payload :material-arrow-right:](sending_payload.md){ .md-button .md-button--primary } diff --git a/docs/user_guide/img/entering_rcm_bent_pins.jpg b/docs/user_guide/rcm/img/entering_rcm_bent_pins.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_bent_pins.jpg rename to docs/user_guide/rcm/img/entering_rcm_bent_pins.jpg diff --git a/docs/user_guide/img/entering_rcm_button_1.jpg b/docs/user_guide/rcm/img/entering_rcm_button_1.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_button_1.jpg rename to docs/user_guide/rcm/img/entering_rcm_button_1.jpg diff --git a/docs/user_guide/img/entering_rcm_button_2.jpg b/docs/user_guide/rcm/img/entering_rcm_button_2.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_button_2.jpg rename to docs/user_guide/rcm/img/entering_rcm_button_2.jpg diff --git a/docs/user_guide/img/entering_rcm_button_3.jpg b/docs/user_guide/rcm/img/entering_rcm_button_3.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_button_3.jpg rename to docs/user_guide/rcm/img/entering_rcm_button_3.jpg diff --git a/docs/user_guide/img/entering_rcm_button_4 (unused).jpg b/docs/user_guide/rcm/img/entering_rcm_button_4 (unused).jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_button_4 (unused).jpg rename to docs/user_guide/rcm/img/entering_rcm_button_4 (unused).jpg diff --git a/docs/user_guide/img/entering_rcm_button_5.jpg b/docs/user_guide/rcm/img/entering_rcm_button_5.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_button_5.jpg rename to docs/user_guide/rcm/img/entering_rcm_button_5.jpg diff --git a/docs/user_guide/img/entering_rcm_button_6.jpg b/docs/user_guide/rcm/img/entering_rcm_button_6.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_button_6.jpg rename to docs/user_guide/rcm/img/entering_rcm_button_6.jpg diff --git a/docs/user_guide/img/entering_rcm_jig.jpg b/docs/user_guide/rcm/img/entering_rcm_jig.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_jig.jpg rename to docs/user_guide/rcm/img/entering_rcm_jig.jpg diff --git a/docs/user_guide/img/entering_rcm_joycon_pins.jpg b/docs/user_guide/rcm/img/entering_rcm_joycon_pins.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_joycon_pins.jpg rename to docs/user_guide/rcm/img/entering_rcm_joycon_pins.jpg diff --git a/docs/user_guide/img/entering_rcm_pads_numbered.jpg b/docs/user_guide/rcm/img/entering_rcm_pads_numbered.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_pads_numbered.jpg rename to docs/user_guide/rcm/img/entering_rcm_pads_numbered.jpg diff --git a/docs/user_guide/img/entering_rcm_paperclip_hdk_1.jpg b/docs/user_guide/rcm/img/entering_rcm_paperclip_hdk_1.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_paperclip_hdk_1.jpg rename to docs/user_guide/rcm/img/entering_rcm_paperclip_hdk_1.jpg diff --git a/docs/user_guide/img/entering_rcm_paperclip_hdk_2.jpg b/docs/user_guide/rcm/img/entering_rcm_paperclip_hdk_2.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_paperclip_hdk_2.jpg rename to docs/user_guide/rcm/img/entering_rcm_paperclip_hdk_2.jpg diff --git a/docs/user_guide/img/entering_rcm_solder_710_stuckpixel.jpg b/docs/user_guide/rcm/img/entering_rcm_solder_710_stuckpixel.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_solder_710_stuckpixel.jpg rename to docs/user_guide/rcm/img/entering_rcm_solder_710_stuckpixel.jpg diff --git a/docs/user_guide/img/entering_rcm_solder_910_yyaommii.jpg b/docs/user_guide/rcm/img/entering_rcm_solder_910_yyaommii.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_solder_910_yyaommii.jpg rename to docs/user_guide/rcm/img/entering_rcm_solder_910_yyaommii.jpg diff --git a/docs/user_guide/img/entering_rcm_solder_numbered.jpg b/docs/user_guide/rcm/img/entering_rcm_solder_numbered.jpg similarity index 100% rename from docs/user_guide/img/entering_rcm_solder_numbered.jpg rename to docs/user_guide/rcm/img/entering_rcm_solder_numbered.jpg diff --git a/docs/user_guide/img/enterting_rcm_pins_numbered.jpg b/docs/user_guide/rcm/img/enterting_rcm_pins_numbered.jpg similarity index 100% rename from docs/user_guide/img/enterting_rcm_pins_numbered.jpg rename to docs/user_guide/rcm/img/enterting_rcm_pins_numbered.jpg diff --git a/docs/user_guide/rcm/img/recommended_jig.jpg b/docs/user_guide/rcm/img/recommended_jig.jpg new file mode 100644 index 00000000..97a1bd43 Binary files /dev/null and b/docs/user_guide/rcm/img/recommended_jig.jpg differ diff --git a/docs/user_guide/img/unused image 1.jpg b/docs/user_guide/rcm/img/unused image 1.jpg similarity index 100% rename from docs/user_guide/img/unused image 1.jpg rename to docs/user_guide/rcm/img/unused image 1.jpg diff --git a/docs/user_guide/img/unused image 2.png b/docs/user_guide/rcm/img/unused image 2.png similarity index 100% rename from docs/user_guide/img/unused image 2.png rename to docs/user_guide/rcm/img/unused image 2.png diff --git a/docs/user_guide/rcm/index.md b/docs/user_guide/rcm/index.md new file mode 100644 index 00000000..4b757180 --- /dev/null +++ b/docs/user_guide/rcm/index.md @@ -0,0 +1,17 @@ +# RCM + +### **About RCM** + +RCM (short for **R**e**C**overy **M**ode) is a pre-boot mode for Tegra processors that allows NVIDIA and Nintendo to send the Switch tiny programs for various internal uses. On unpatched consoles, once a payload was sent, then quickly copied into the memory buffer behind the stack, it overflowed the memory buffer into the stack. This leads to a "smashed stack" and unsigned code execution within a bootROM context, giving us access to nearly everything on the console. We use it here to launch Atmosphère. + +If you choose the emuMMC path introduced later in the guide, it'll be important to disable the [Automatic Save Data Cloud](https://en-americas-support.nintendo.com/app/answers/detail/a_id/41209) function beforehand, as well as making sure [the Switch is set as the primary console](https://en-americas-support.nintendo.com/app/answers/detail/a_id/22453/~/how-to-change-the-primary-console-for-your-nintendo-account).
+ + +[Continue to Entering RCM :material-arrow-right:](entering_rcm.md){ .md-button .md-button--primary } + +??? "Frequently Asked Questions about this page" + - **Q: How does the RCM exploit work on unpatched Nintendo Switch consoles?**
+ A: For more information, please reference [this link](https://github.com/Qyriad/fusee-launcher/blob/master/report/fusee_gelee.md). There is also a Medium article about it [here](https://medium.com/@SoyLatteChen/inside-fus%C3%A9e-gel%C3%A9e-the-unpatchable-entrypoint-for-nintendo-switch-hacking-26f42026ada0). + + - **Q: Does RCM work on patched consoles?**
+ A: Yes. RCM is an intended mode for all Switch consoles. The exploit is the unintended effect that only some consoles can use. Consoles with the Tegra X1+ have a completely new bootROM with no evidence of the exploit, while "patched" V1 systems have an IROM patch to the bootROM applied that effectively removes fusee-gelee as well. diff --git a/docs/user_guide/rcm/sending_payload.md b/docs/user_guide/rcm/sending_payload.md new file mode 100644 index 00000000..bc095232 --- /dev/null +++ b/docs/user_guide/rcm/sending_payload.md @@ -0,0 +1,145 @@ + + +# Sending a Payload + +!!! warning "If you are here to test if your Switch is patched" + Make sure you have [put your device into RCM](entering_rcm.md) and downloaded Hekate. Once finished, if your console is **not** patched, continue with the "Preparing Hekate" section at the bottom of the page. + + +Now that the device is in RCM, we will need to send it a payload. The methods are mostly the same but slightly differ depending on what hardware you have available. + + + +=== "Windows" + + #### **What you need:** + + - The latest release of TegraRcmGUI (either the MSI or zip) + - A USB-A to USB-C cable (or a standard USB-C cable if your computer natively supports USB-C) + - The latest release of Hekate. The Hekate payload (`hekate_ctcaer_(version).bin`) is located inside of the `hekate_ctcaer_(version).zip`. + + #### **Instructions:** + + 1. Install and run TegraRcmGUI. + 2. Navigate to the `Settings` tab, then press `Install Driver` and follow the on-screen instructions. + - If you face issues when installing the driver, follow the [driver installation with Zadig](#driver-installation-with-zadig) section below. + 3. Connect your Switch in RCM to your PC using the USB cable. + 4. Navigate to the `Payload` tab of TegraRcmGUI. + - Your Switch should be shown as detected in the bottom left corner. + 5. Press the file button next to `Inject payload`, and navigate to and select the `hekate_ctcaer_X.X.X.bin` file. + 6. Click `Inject payload` to launch the payload you selected. + + #### **Driver installation with Zadig** + + Follow these steps if you face issues when installing the driver with TegraRcmGUI. You will need the latest version of Zadig. + + 1. Launch Zadig. In the `Options` menu, be sure that `List All Devices` is enabled. + 2. Connect your Switch in RCM to your PC using the USB cable. + 3. In Zadig, select "APX" in the device list. + 4. Select `libusbK (v3.1.0.0)` in the driver list. + 5. Click `Install Driver` and wait for the installation to finish. + +=== "Linux" + + #### **What you need:** + + - The latest release of [fusee-nano](https://github.com/DefenderOfHyrule/fusee-nano/releases) (also available on the [AUR](https://aur.archlinux.org/packages/fusee-nano)) + - If you use Arch Linux or a derivative distro, the AUR package is recommended. + - A USB-A to USB-C cable (or a standard USB-C cable if your computer natively supports USB-C) + - The latest release of Hekate. The Hekate payload (`hekate_ctcaer_(version).bin`) is located inside of the `hekate_ctcaer_(version).zip`. + + #### **Instructions:** + + 1. Download and run the payload injector from your terminal. You will need to run the injector as root, unless you follow the instructions at [Linux injection without root](../../extras/adding_udev.md). + 2. Connect your Switch in RCM to your PC using the USB cable. + 3. Run fusee-nano with: `./fusee-nano /path/to/hekate-ctcaer_X.X.X.bin` + - As mentioned earlier, unless you have followed the instructions at [Linux injection without root](../../extras/adding_udev.md), this will require root to run. For most systems, this is done with `sudo` + + +=== "Mac" + + #### **What you need:** + + - The latest release of [CrystalRCM](https://github.com/prayerie/CrystalRCM/releases) (the `CrystalRCM.(version).dmg` file) + - A USB-A to USB-C cable (or a standard USB-C cable if your computer natively supports USB-C) + - The latest release of Hekate. The Hekate payload (`hekate_ctcaer_(version).bin`) is located inside of the `hekate_ctcaer_(version).zip`. + + #### **Instructions:** + + 1. Download the latest release of CrystalRCM. + 2. Connect your Switch in RCM to your PC using the USB cable, make sure it's also detected in CrystalRCM. + 2. Mount the `CrystalRCM.(version).dmg` file, open the mounted disk image in File Explorer and copy the `CrystalRCM.app` file inside of the mounted disk image to any location on your Mac. + 3. Open the `CrystalRCM.app` app, then click `Payload...` and select the `hekate_ctcaer_X.X.X.bin` file. + 4. Once selected, click `Push!`. The payload should now be injected successfully. + +=== "Android" + + #### **What you need:** + + - The latest release of Rekado + - You will need to enable Unknown Sources in your device settings to install this + - A USB-C cable + - If your device has a USB-C port, you may use a C-C cable + - If your device only has a Micro USB port, you will need a USB OTG adapter and a USB A-C cable + - This **will not work** on every phone! + - The latest release of Hekate. The Hekate payload (`hekate_ctcaer_(version).bin`) is located inside of the `hekate_ctcaer_(version).zip`. + + #### **Instructions:** + + 1. Copy the hekate_ctcaer `.bin` file from the Hekate `.zip` file to a location on your phone. + - A tool such as Amaze File Manager can do this. + 2. Launch Rekado on your phone. + 3. Navigate to `Payloads` (Signified by a downwards arrow with a line), then press the `+` button at the bottom right. + 4. Navigate to your hekate_ctcaer `.bin` file and tap it to add it to Rekado's menu. + 5. **Optional, but recommended**: Navigate to Rekado's settings in the top right and enable `Hide bundled`. + 6. Connect your Switch in RCM to your phone using the USB cable. + 7. If prompted, grant Rekado access to the Switch. + 8. Select the `hekate_ctcaer_X.X.X.bin` file in the dialog that pops up. + +=== "Chromebook" + + #### **What you need:** + + - A USB-A to USB-C cable + !!! warning "About USB-C" + If your Chromebook has a USB-C port, do note that this will not work using a C-C cable. + + - The latest release of Hekate. The Hekate payload (`hekate_ctcaer_(version).bin`) is located inside of the `hekate_ctcaer_(version).zip`. + + #### **Instructions:** + + 1. Go to the injection [website](https://fusee.eiphax.tech/) and scroll all the way down + 2. Select the "Upload Payload" option and upload the `hekate_ctcaer_X.X.X.bin` file from the Hekate `.zip` file. + 3. Connect your Switch in RCM to your Chromebook using the USB cable. + 4. Select "Do the thing". A pop-up will appear. Click the `APX` option. + 5. Press the Connect button and the payload will be injected. + +!!! danger "If nothing happens after you send the payload" + If your console's screen remains black after you've sent Hekate (or any other payload), it's possible your payload was corrupted, or that your console is patched. If your payload injector program shows that zero or 0x0000 bytes were sent, then it is patched. This isn't a one-time glitch or up for debate; it is patched. Consider an alternate method that isn't via RCM. + +----- + +### **Preparing Hekate** +We will prepare the microSD card for formatting/partitioning before going to the next page. Removing the microSD card while in Hekate is safe so turning off the console is not necessary and keeping it on will save time that would be spent reinjecting the payload. + +!!! danger "Following the guide will delete everything on your microSD card!" + Later in the guide, you will be formatting and/or partitioning your microSD card. This means that all data on the microSD card will be lost. Now is a good time to back up *all* of its data to a safe place (for example, on your PC or external drive) so that you can restore it later. You can do this by following the instructions below. + +----- + +#### **What you need:** +- The latest release of Hekate. +- Your microSD card + +#### **Instructions:** +1. Without turning your Switch off, remove the microSD card from the Switch. +2. Insert your microSD card into your computer. +3. Copy the `Nintendo` folder (and any other important data) from the root of your microSD card to a safe space on your device. +4. Extract the Hekate `.zip` to a location on your computer +5. Inside the extracted Hekate folder you will find a folder named `bootloader`. +6. Copy the `bootloader` folder to the root of your microSD card. +7. Put your microSD card back into your Switch. +8. Use volume up and volume down to navigate the Hekate menu. Hover over 'reload' and press the power button to select. Your screen should now have the Hekate GUI (Nyx) pictured below. +{ width="600" } + +[Continue to choosing your CFW environment :material-arrow-right:](../all/cfw_environment.md){ .md-button .md-button--primary } diff --git a/docs/user_guide/sysnand/entering_rcm.md b/docs/user_guide/sysnand/entering_rcm.md deleted file mode 100644 index 7096bbb6..00000000 --- a/docs/user_guide/sysnand/entering_rcm.md +++ /dev/null @@ -1,152 +0,0 @@ -# Entering RCM - -As the Switch uses a Tegra X1 processor, it has a special recovery mode that is, in most scenarios, useless for the end-user. Fortunately, due to the fusee-gelee vulnerability, this special mode acts as our gateway into CFW. - -There are several methods of entering RCM (**R**e**C**overy **M**ode). The most affordable of these require nothing more than common household items, while the most reliable are very cheap ($10). - - - -!!! danger "Patched Switch" - Note that patched units **can** enter RCM, but it is not possible to send a payload on those systems. Also note that RCM is a different recovery mode than the one accessed by holding Volume Up, Volume Down, and Power. - -!!! snippet "Note" - The order of methods on this page is in the order of ease. The easiest to immediately accomplish are listed at the top, and the most advanced/difficult methods are at the bottom. - - - -### Instructions - -!!! tip "" - 1. Power off the Switch and use one of the methods listed below to short the pins on the right joycon rail. - 2. Hold Volume Up and press the Power button. - - If your Switch displays the Nintendo logo and boots normally or immediately shuts down, you didn't successfully enter RCM and should try again. Otherwise, if your console did not turn on normally, and the screen remained black with no backlight, your Switch is in RCM. - -!!! tip "" - ### RCM Jig (Easiest for beginners) -
-
-
-!!! tip ""
- ### Soldered Joy-Con Pads - Physical RCM Button (Safest)
- Click to expand!
- - !!! snippet "Note" - Some jig designs use paperclips, inheriting the same risks as the Metal Bridge / Paperclip method. - - !!! snippet "Note" - Once you have successfully entered RCM, you can take the jig out of the joycon rail. - - This method is similar to the Metal Bridge / Paperclip method, but is more reliable and safer in many cases. Jigs hold a wire in place so the correct pins (10 and a ground) are shorted every time. - - !!! tip "" -  - - In the case you plan to make you own jig, this image lays out the pads numbers on the console. Make sure your jig NEVER touches pin 4. Pin 4 provides 5v power to the Joycons, if connected to any other pin you will fry the console. - - !!! tip "" -  - -
-
-
-!!! tip ""
- ### Soldered Joy-Con Pads - 7 & 10
- Click to expand!
- - !!! snippet "Note" - This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart. - - This method comes to us from the mind of pbanj#9188 on Discord. All pictures of this method in action were provided by him, with some supplementary images provided by eip ∞#3283 on Discord. - - The goal of this method is to open the right handed Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however you will be soldering wires to pins 7 and 10 (shown below) and wiring them to the "Joycon release button" at the top back of the right hand Joycon. - - !!! tip "" -  - - In order to start this method you will want to take two lengths of wire, and wrap one end of each into a small circle. - - !!! tip "" -  - - You will then want to take the circular end of one of the wires and add a small amount of solder, keeping it mostly flat (ONLY DO THIS TO ONE OF THE WIRES!). You will then glue this wire down to the below point on the Joycon release button. Make sure glue doesn't cover the top of the solder/wire as it will act as a contact point. Also, ensure that you leave enough space for the button to function correctly. Try pushing the button from the outside and observing its travel path so that you can see where and how you should safely glue the solder glob. - - !!! tip "" -  - - !!! tip "" -  - - The first wire should now be in place as seen by the green circle below. The second wire does not need any solder, instead you will hold it in place using the screw as shown by the red circle in the picture below. - - !!! tip "" -  - - Pressing the Joycon button in you should now notice the solder point you created making contact with the piece of metal held in by the screw. Once you have these elements in place you want to connect one wire to pad 7 and the other to pad 10 (it doesn't matter which is which). After that you have successfully created an RCM button on your Joycon. You will now need to hold down the Joycon release button when attempting to boot RCM. - - !!! tip "" -  -
-
-
-!!! tip ""
- ### Soldered Joy-Con Pads - 9 & 10
- Click to expand!
- - !!! snippet "Note" - This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart. - - The goal of this method is to open the right handed Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however the goal is to solder pins 7 and 10 (shown below) together with a surface-mount 0805 10k resistor. Apart from using a physical switch/button, this is currently considered the safest method that involves soldering to pads. - - !!! tip "" -  - - Here is an example from stuckpixel#3421 on the ReSwitched Discord server. - - !!! tip "" -  -
-
-
-!!! tip ""
- ### Bent Joy-Con Pins (Not recommended)
- Click to expand!
- - !!! snippet "Note" - This method will result in the right Joy-Con being detected as in wireless mode while attached to the Switch, and this method may result in the Joy-Con being permanently detected as wireless if you update the Joy-Con firmware while this mod is installed. In the latter case, fixing this requires opening up the Joy-Con and reseating the battery. It is recommended to solder pads 7 and 10 together with a resistor instead. - - !!! snippet "Note" - This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart. - - The goal of this method is to open the right handed Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however the goal is to solder pads 9 and 10 (seen below) together. This can either be done using a small wire, or directly bridging the pads with solder. - - !!! tip "" -  - - Here is an example from YyAoMmIi#3705 on our Discord server. - - !!! tip "" -  -
-
-
-
-
-#### [Continue to Sending a Payload ](sending_payload.md)
diff --git a/docs/user_guide/sysnand/launching_cfw.md b/docs/user_guide/sysnand/launching_cfw.md
deleted file mode 100644
index 48d57e37..00000000
--- a/docs/user_guide/sysnand/launching_cfw.md
+++ /dev/null
@@ -1,62 +0,0 @@
-# Launching CFW
-
-Now that the preparation work is out of the way, we're finally ready to launch custom firmware on the Switch.
-
-Unlike systems such as the DSi, Wii, or 3DS, Switch CFW is currently volatile. It will only work as long as your Switch is on. As soon as your Switch completely loses power for any reason (shutting down, battery dying, etc.), CFW will no longer be active and you will need to follow these instructions again.
-
-
-
-### Instructions
-
-!!! tip ""
- 1. Power on your Switch into RCM, and inject the Hekate payload
- 2. Navigate to `Launch` using the touch screen
- 3. Find `Atmosphere FSS0 sysMMC` and launch it
-
-Your Switch is now booting into Atmosphere.
-
-To verify Atmosphere launched properly, open the Settings applet, and navigate to System. You should see `AMS` next to the version number, as well as an `S` at the end, indicating you are booted into sysMMC.
-
-
-
-!!! tip ""
- 
-
-
-
-!!! tip "Reboot to Hekate"
- Once booted into sysMMC with CFW, you can easily get back to Hekate by holding the power button, and selecting `Restart` in the power menu.
-
-
-
-### Launching the Homebrew Menu
-
-You will now be able to launch the Homebrew Menu by opening the album or by holding the R button while launching any game (including demos/cartridges), or application (e.g. Youtube/Hulu). If R is not held, the game or application will launch like normal.
-
-!!! warning "A note about using the album for the Homebrew Menu"
- - Using the album for the Homebrew Menu instead of a game or application has several limitations, including but not limited to: a smaller amount of available memory (RAM), as well as being unable to launch a full-featured web browser. It is strongly recommended to launch homebrew through applications or games instead.
-
-!!! tip "Adding new applications"
- - Place homebrew applications (`.nro` files) into the `switch` folder on your SD card.
-
-
-
-### What the included homebrew applications do
-
-!!! tip ""
- - JKSV is a save manager, it can dump and restore saves from/to your system. For more information, see [Save Management](../../extras/save_management.md)
-
- - FTPD is a ftp tool for connecting your Switch's sd card wirelessly to your pc. Tools like WinSCP can connect to your switch on `(ip of switch):5000`
-
- - NX-Shell is a file explorer for the Switch. You can move files, listen to mp3's, view images etc.
-
- - NXThemeInstaller is a theme installer app. See the [Theming section of our guide](../../extras/theming.md) for more information
-
- - hbappstore is a homebrew app store where a large collection of switch homebrew is kept.
-
-
-
-### Updating your setup
-
-!!! tip ""
- Whenever a new Switch firmware update releases you may need to update your files to be able to use CFW on the new version. Make sure to follow the instructions on [this page](../../extras/updating.md) to update your setup correctly.
diff --git a/docs/user_guide/sysnand/making_essential_backups.md b/docs/user_guide/sysnand/making_essential_backups.md
deleted file mode 100644
index 0aaa0210..00000000
--- a/docs/user_guide/sysnand/making_essential_backups.md
+++ /dev/null
@@ -1,42 +0,0 @@
-# Making Essential Backups
-!!! danger "Important"
- It is critical to make these backups. Do not skip these steps.
-
-
-
-## Making a NAND Backup
-
-!!! danger "Important"
- A NAND backup is crucial. They can be used to restore the device to a working state in case of emergencies.
-
- Once the backup is finished, **keep it somewhere safe.** The best backup is the one you have but never need, and the worst backup is the one you need but never made. To save space, it's recommended to compress the end-result with a `.zip` file or something similar.
-
- It's highly recommended that you use an SD card that is formatted to FAT32 and has at least 32 gigabytes of space free. This will still work on smaller cards, but it's not ideal.
-
-### Instructions
-
-!!! tip ""
-
- 1. Enter RCM and inject the Hekate payload
- 2. Use the touch screen to navigate to `Tools` and then `Backup eMMC`
- 3. Tap on `eMMC BOOT0 & BOOT1`
- - This should only take a few seconds, but if your SD card is very slow, it may take around a minute.
- 4. Tap on `Close` to continue, then tap on `eMMC RAW GPP`
- - This will take a long time. Expect it to take between 10 minutes to an hour (or more, if your SD card is very slow).
- - On FAT32 SD cards or cards that have less than 32 gigabytes of space available, the NAND will be split into 1 or 2 gigabyte parts.
- - Hekate will stop producing these parts when it runs out of space. When this happens, do the following:
- - Power off your system
- - Insert your SD card into your PC
- - Move all files from the `backup` folder on your SD card to a safe location on your PC
- - Insert your SD card into your Switch
- - Enter RCM again, inject Hekate again, and continue the backup by tapping on `Tools` > `Backup eMMC` > `eMMC RAW GPP`
- - Repeat the process until the NAND is completely dumped
- 5. Press `Close` > `Home` > `Power Off`
- 6. Insert your SD card into your PC
- 7. Copy the `backup` folder on your SD card to a safe location on your PC
-
-
-
------
-
-#### [Continue to Launching CFW ](launching_cfw.md)
diff --git a/docs/user_guide/sysnand/sd_preparation.md b/docs/user_guide/sysnand/sd_preparation.md
deleted file mode 100644
index d8abc317..00000000
--- a/docs/user_guide/sysnand/sd_preparation.md
+++ /dev/null
@@ -1,51 +0,0 @@
-# SD Preparation
-
-We will now place the required files for the Atmosphere custom firmware and some additional homebrew files on the SD card.
-
-Atmosphere has its own bootloader, called fusee. For the purposes of this guide we will be using Hekate instead, so that we can back up the system's NAND (internal storage) and take advantage of other advanced features in the future.
-
-
-
-!!! danger "FAT32 vs exFAT"
- Your SD card will need to be formatted as either FAT32 or exFAT, but FAT32 is recommended as it is more stable and will work out of the box with the Switch's operating system. Using exFAT on the Switch should be avoided due to the filesystem being prone to corruption, and sometimes preventing custom firmware from booting. You will also need to install the exFAT update for your Switch, which is downloaded when you insert an exFAT formatted SD card in to your Switch. Note that this will update your console and requires an internet connection.
-
-
-!!! warning "File name extensions"
- If you use Windows, you should enable file name extensions before continuing. See [this link](../../extras/showing_file_extensions.md) for a guide on how to do this.
-
-
-
-### What you need
-
-!!! tip ""
- - The latest release of Hekate (Download the `hekate_ctcaer_(version).zip` release of hekate)
- - The hekate config file: hekate_ipl.ini
- - The bootlogo zip folder: bootlogos.zip
- - The latest release of Atmosphere. Download the `atmosphere-(version)-master-(version)+hbl-(version)+hbmenu-(version).zip` release of Atmosphere.
- - The latest release of JKSV (Download the `JKSV.nro` release of JKSV)
- - The latest release of FTPD (Download the `ftpd.nro` release of FTPD)
- - The latest release of NXThemeInstaller (Download the `NxThemesInstaller.nro` release of NxThemeInstaller)
- - The latest release of NX-Shell (Download the `NX-Shell.nro` release of nx-shell)
- - The latest release of the hbappstore (Download the `appstore.nro` release of hbappstore)
-
-
-### Instructions
-
-!!! tip ""
- 1. Insert your Switch's SD card into your PC
- 2. Copy *the contents of* the Atmosphere `.zip` file to the root of your SD card
- 3. Copy the `bootloader` folder from the Hekate `.zip` file to the root of your SD card
- 4. Copy the `bootloader` folder from the `bootlogos.zip` file to the root of your SD card
- - If you're asked to merge the bootloader folders, do so.
- 5. Copy `hekate_ipl.ini` to the `bootloader` folder on your SD card
- 6. Create a folder named `appstore` inside the `switch` folder on your SD card, and put `appstore.nro` in it
- 7. Copy `JKSV.nro`, `ftpd.nro`, `NX-Shell.nro` and `NxThemesInstaller.nro` to the `switch` folder on your SD card
- 8. Reinsert your SD card back into your Switch
-
- !!! tip ""
- Your SD card should look similar to this. The `Nintendo` folder will not be present if your switch has not already booted with the microSD card inserted.
- 
-
-
-
-#### [Continue to Entering RCM ](entering_rcm.md)
diff --git a/docs/user_guide/sysnand/sending_payload.md b/docs/user_guide/sysnand/sending_payload.md
deleted file mode 100644
index 27955c62..00000000
--- a/docs/user_guide/sysnand/sending_payload.md
+++ /dev/null
@@ -1,122 +0,0 @@
-
-
-# Sending a Payload
-
-!!! warning "If you were sent here directly"
- Make sure you've [put your device into RCM](entering_rcm.md), and downloaded Hekate (extract its zip file if necessary) before continuing.
-
-Now that the device is in RCM, we will need to send it a payload. The methods are mostly the same, but slightly differs depending on what hardware you have available.
-
-
-
-## Windows
-
-### What you need
-
-!!! tip ""
- - The latest release of TegraRcmGUI (either the MSI or zip).
- - The latest release of Hekate. The Hekate payload (hekate_ctcaer bin) is located in the hekate_ctcaer zip.
- - A USB-A to USB-C cable (or a standard USB-C cable if your computer natively supports USB-C).
-
-### Instructions
-
-!!! tip ""
- 1. Install and run TegraRCMGUI.
- 2. Navigate to the `Settings` tab, then press `Install Driver` and follow the on-screen instructions.
- - If you face issues when installing the driver, follow the [driver installation with Zadig](#driver-installation-with-zadig) section below.
- 3. Connect your Switch in RCM to your PC using the USB cable.
- 4. Navigate to the `Payload` tab of TegraRcmGUI.
- - Your Switch should be shown as detected in the bottom left corner.
- 5. Press the file button next to `Inject payload`, and navigate to and select your hekate_ctcaer `.bin` file.
- 6. Click `Inject payload` to launch Hekate.
-
-### Driver installation with Zadig
-
-!!! tip ""
- Follow these steps if you face issues when installing the driver with TegraRcmGUI. You will need the latest version of Zadig.
-
- 1. Launch Zadig. In the `Options` menu, be sure that `List All Devices` is enabled.
- 2. Connect your Switch in RCM to your PC using the USB cable.
- 3. In Zadig, select "APX" in the device list.
- 4. Select `libusbK (v3.1.0.0)` in the driver list.
- 5. Click `Install Driver` and wait for the installation to finish.
-
-
-
-## Mac / Linux
-
-### What you need
-
-!!! tip ""
- - The latest release of fusee-interfacee-tk
- - The latest release of Hekate. The Hekate payload (hekate_ctcaer bin) is located in the hekate_ctcaer zip.
- - A USB-A to USB-C cable (or a standard USB-C cable if your computer natively supports USB-C)
-
-### Instructions
-
-!!! tip ""
- 1. Download and run the payload injector (if you're on Linux, you will need to run this program as root, use `sudo`, or follow the instructions at [Linux injection without root](../../extras/adding_udev.md)).
- 2. Connect your Switch in RCM to your PC using the USB cable
- 3. Wait for your Switch to be shown as found in the injector
- 4. Press `Select Payload`, and navigate to and select your hekate_ctcaer `.bin` file
- 5. Click `Send Payload!` to launch Hekate
-
-
-
-## Android
-
-### What you need
-
-!!! tip ""
- - The latest release of Rekado
- - You will need to enable Unknown Sources in your device settings to install this
- - The latest release of Hekate. The Hekate payload (hekate_ctcaer bin) is located in the hekate_ctcaer zip.
- - A USB-C cable
- - If your device has a USB-C port, you may use a C-C cable
- - If your device only has a Micro USB port, you will need a USB OTG adapter and a USB A-C cable
- - This **will not work** on every phone!
-
-### Instructions
-
-!!! tip ""
- 1. Copy the hekate_ctcaer `.bin` file from the Hekate `.zip` file to a location on your phone
- - A tool such as Amaze File Manager can do this
- 2. Launch Rekado on your phone
- 3. Navigate to `Payloads`, then press the `+` button at the bottom right
- 4. Navigate to your hekate_ctcaer `.bin` file, and tap it to add it to Rekado's menu
- 5. **Optional, but recommended**: Navigate to Rekado's settings and enable `Hide bundled`
- 6. Connect your Switch in RCM to your phone using the USB cable
- 7. If prompted, grant Rekado access to the Switch
- 8. Select your hekate_ctcaer `.bin` file in the dialog that pops up
-
-
-
-## Chromebook
-
-### What you need
-
-!!! tip ""
- - A USB-C cable
- - If your chromebook has a USB-C port, do note that this will not work using a C-C cable.
-
- Payloads you'll need for this guide:
-
- - The latest release of Hekate. The Hekate payload (hekate_ctcaer bin) is located in the hekate_ctcaer zip.
-
-### Instructions
-
-!!! tip ""
- 1. Go to the injection [website](https://fusee.eiphax.tech/) and scroll all the way down
- 2. Select the "Upload Payload" option and upload the hekate_ctcaer `.bin` file from the Hekate `.zip` file.
- 3. Connect your Switch in RCM to your Chromebook using the USB cable.
- 4. Select "Do the thing". A pop up will appear. Click the `APX` option.
- 5. Press the Connect button and the payload will be injected.
-
-
-
-!!! danger "If nothing happens after you send the payload"
- If your console's screen remains black after you've sent Hekate (or any other payload), it's possible your payload was corrupted, or that your console is patched. If your payload injector program shows that 0 bytes were sent, then it is definitely patched, so you'll be unable to proceed with the rest of the guide.
-
-
-
-#### [Continue to Making Essential Backups ](making_essential_backups.md)
diff --git a/mkdocs.yml b/mkdocs.yml
index f7b64dcc..10e31264 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,29 +1,80 @@
site_name: NH Switch Guide
-theme: slate
-copyright: Copyright © 2023 Nintendo Homebrew, Maintained by the NH Discord Server.
+copyright: Copyright © 2024 Nintendo Homebrew, Maintained by the NH Discord Server.
site_description: Switch CFW Guide.
site_author: NH Discord Server.
site_url: https://nh-server.github.io/switch-guide/
+repo_url: https://github.com/nh-server/switch-guide
+repo_name: NH Switch Guide
+
+theme:
+ name: material
+ favicon: img/favicon.ico
+ features:
+ - toc.integrate
+ - navigation.instant
+ - navigation.expand
+ - navigation.sections
+ - navigation.tabs
+ - navigation.tracking
+
+ palette:
+ # Palette toggle for light mode
+ - media: "(prefers-color-scheme: light)"
+ scheme: default
+ toggle:
+ icon: material/brightness-7
+ name: Switch to dark mode
+
+ # Palette toggle for dark mode
+ - media: "(prefers-color-scheme: dark)"
+ scheme: slate
+ toggle:
+ icon: material/brightness-4
+ name: Switch to system preference
+
+ icon:
+ repo: fontawesome/brands/github
+ logo: fontawesome/solid/wrench
nav:
- Home: index.md
- User Guide:
- 'Getting Started': 'user_guide/getting_started.md'
- - 'RCM': 'user_guide/rcm.md'
- - 'Entering RCM': 'user_guide/emummc/entering_rcm.md'
- - 'Sending a payload': 'user_guide/emummc/sending_payload.md'
- - 'Partitioning the SD': 'user_guide/emummc/partitioning_sd.md'
- - 'SD preparations': 'user_guide/emummc/sd_preparation.md'
- - 'Making the emuMMC': 'user_guide/emummc/making_emummc.md'
- - 'Launching CFW': 'user_guide/emummc/launching_cfw.md'
- - Extras:
+ - RCM:
+ - 'Introduction': 'user_guide/rcm/index.md'
+ - 'Entering RCM': 'user_guide/rcm/entering_rcm.md'
+ - 'Sending a payload': 'user_guide/rcm/sending_payload.md'
+ - Modchip:
+ - 'Introduction': 'user_guide/modchip/index.md'
+ - 'Preparing Hekate': 'user_guide/modchip/preparing_hekate.md'
+ - Finalizing Setup:
+ - 'Choosing an Environment': 'user_guide/all/cfw_environment.md'
+ - 'Partitioning the microSD for emuMMC': 'user_guide/all/partitioning_sd.md'
+ - 'Partitioning the microSD for sysCFW': 'user_guide/all/partitioning_sd_syscfw.md'
+ - 'microSD Preparations': 'user_guide/all/sd_preparation.md'
+ - 'Making Essential Backups': 'user_guide/all/making_essential_backups.md'
+ - 'Launching CFW': 'user_guide/all/launching_cfw.md'
+ - Homebrew:
+ - 'Homebrew': 'homebrew/index.md'
+ - 'JKSV': 'homebrew/jksv.md'
+ - 'Goldleaf': 'homebrew/goldleaf.md'
+ - 'FTPD': 'homebrew/ftpd.md'
+ - 'NXTheme Installer': 'homebrew/nxtheme-installer.md'
+ - 'NX-Shell': 'homebrew/nx-shell.md'
+ - 'EdiZon': 'homebrew/edizon.md'
+ - 'Tesla-Menu': 'homebrew/tesla-menu.md'
+ - 'MissionControl': 'homebrew/mission-control.md'
+ - 'sys-con': 'homebrew/sys-con.md'
+ - 'sys-botbase': 'homebrew/sys-botbase.md'
+ - 'SysDVR': 'homebrew/sysdvr.md'
+ - 'sys-clk': 'homebrew/sys-clk.md'
+ - 'ldn_mitm': 'homebrew/ldn_mitm.md'
+ - Tutorials:
+ - 'Extras': 'extras/index.md'
- 'Blocking Nintendo servers': 'extras/blocking_nintendo.md'
- 'Restoring a NAND Backup': 'extras/nandrestore.md'
- 'AutoRCM': 'extras/autorcm.md'
- - 'Theming': 'extras/theming.md'
- - 'Save Management': 'extras/save_management.md'
- 'Game Modding': 'extras/game_modding.md'
- - 'Game Cheats': 'extras/cheats.md'
- 'Linux injection without root': 'extras/adding_udev.md'
- 'Showing File Name Extensions (Windows)': 'extras/showing_file_extensions.md'
- 'Alternate Boot Setups': 'extras/alternate_bootsetups.md'
@@ -31,12 +82,28 @@ nav:
- 'Updating CFW': 'extras/updating.md'
- 'Changing SD cards': 'extras/transfer_sd.md'
- 'Glossary': 'extras/glossary.md'
+ - 'Installing Android': 'extras/installing_android.md'
+ - 'Installing Linux': 'extras/installing_linux.md'
- FAQ: faq.md
- About: about.md
-
+
markdown_extensions:
- - admonition
- - fontawesome_markdown
+ - admonition
+ - pymdownx.details
+ - pymdownx.superfences
+ - def_list
+ - attr_list
+ - md_in_html
+ - pymdownx.emoji:
+ emoji_index: !!python/name:material.extensions.emoji.twemoji
+ emoji_generator: !!python/name:material.extensions.emoji.to_svg
+ - pymdownx.tasklist:
+ custom_checkbox: true
+ - pymdownx.tabbed:
+ alternate_style: true
+ - toc:
+ permalink: true
+ toc_depth: 3
extra_css:
- css/custom.css
diff --git a/requirements.txt b/requirements.txt
index 20308642..1c36fb88 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,3 +1 @@
-mkdocs==1.4.3
-fontawesome-markdown==0.2.6
-mkdocs-bootswatch==1.1
+mkdocs-material==9.5.5