diff --git a/.gitignore b/.gitignore index 1320f90e..712be594 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ site +venv diff --git a/docs/about.md b/docs/about.md index cab97fe0..c8556f39 100644 --- a/docs/about.md +++ b/docs/about.md @@ -1,4 +1,4 @@ - + # About this guide diff --git a/docs/extras/adding_udev.md b/docs/extras/adding_udev.md index 7c9453a9..de617f8b 100644 --- a/docs/extras/adding_udev.md +++ b/docs/extras/adding_udev.md @@ -20,22 +20,22 @@ The following instructions are not for beginners. Only do this if you understand To start, we will create a new group and add ourselves to it. The group the Nintendo Switch device will be owned by on Linux will be set to this group. 1. Open a terminal. -2. Enter the following command: `sudo groupadd nintendo_switch`. -3. Enter your password when prompted. -4. Enter the following command: `sudo usermod -a -G nintendo_switch $USER`. Make sure that the `G` is capitalized! -5. Close the terminal. +1. Enter the following command: `sudo groupadd nintendo_switch`. +1. Enter your password when prompted. +1. Enter the following command: `sudo usermod -a -G nintendo_switch $USER`. Make sure that the `G` is capitalized! +1. Close the terminal. #### **Adding a udev rule** Next we're gonna add a new `udev` rule. `udev` is a device manager for the linux kernel. The rule we're gonna specify is that if the Switch is connected in `RCM`, the group the Switch belongs to will be the group we made in the previous section. 1. Open a terminal. -2. Change to the root user with the following command: `sudo -i`. Enter your password when prompted. -3. Enter the following command: `mkdir -p /etc/udev/rules.d`. -4. Enter the following command: `echo 'SUBSYSTEMS=="usb", ATTRS{manufacturer}=="NVIDIA Corp.", ATTRS{product}=="APX", GROUP="nintendo_switch"' > /etc/udev/rules.d/10-switch.rules`. -5. Enter the following command: `udevadm control --reload`. -6. Enter the following command: `udevadm trigger`. -7. Logout and log back in. +1. Change to the root user with the following command: `sudo -i`. Enter your password when prompted. +1. Enter the following command: `mkdir -p /etc/udev/rules.d`. +1. Enter the following command: `echo 'SUBSYSTEMS=="usb", ATTRS{manufacturer}=="NVIDIA Corp.", ATTRS{product}=="APX", GROUP="nintendo_switch"' > /etc/udev/rules.d/10-switch.rules`. +1. Enter the following command: `udevadm control --reload`. +1. Enter the following command: `udevadm trigger`. +1. Logout and log back in. You should now be able to run the payload sender without having to use `sudo`. @@ -45,11 +45,10 @@ You should now be able to run the payload sender without having to use `sudo`. These rules will actually allow _ANY_ user to access your Switch via USB, not only _your_ user. -You may just follow the instructions at nx-udev, or if you're on Ubuntu / Debian: +You may just follow the instructions at [nx-udev](https://github.com/pheki/nx-udev), or if you're on Ubuntu / Debian: -1. Download nx-udev_latest_all.deb. -2. Open a terminal in the same directory as your download. -3. Run `sudo dpkg -i nx-udev_latest_all.deb` to install the package +1. Download [nx-udev_latest_all.deb](https://github.com/pheki/nx-udev/releases/latest/download/nx-udev_latest_all.deb). +1. Open a terminal in the same directory as your download. +1. Run `sudo dpkg -i nx-udev_latest_all.deb` to install the package You should now be able to run the payload injector and homebrew with USB communication without having to use `sudo`. diff --git a/docs/extras/alternate_bootsetups.md b/docs/extras/alternate_bootsetups.md index adc1c255..50e3564e 100644 --- a/docs/extras/alternate_bootsetups.md +++ b/docs/extras/alternate_bootsetups.md @@ -3,7 +3,7 @@ If you need to troubleshoot something, or need to try a different boot setup, read on. !!! danger "Do I need any of these?" - Unless you are experiencing problems with booting or Atmosphère itself, it's strongly recommended to use the main guide instead of these. They are provided for the sake of completeness. + Unless you are experiencing problems with booting or Atmosphère itself, it's strongly recommended to use the main guide instead of these. They are provided for the sake of completeness.   @@ -16,11 +16,11 @@ If you need to troubleshoot something, or need to try a different boot setup, re #### **Instructions:** 1. Insert your Switch's microSD card into your PC. -2. Copy *the contents of* the Atmosphere `.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 `fusee.bin` to the `sd:/bootloader/payloads` folder on your microSD card. -5. The setup is complete, you can inject the Hekate payload (Unpatched Switch users) or place the Hekate payload on the root of your microSD card and rename it to `payload.bin` (Modchipped Switch users). -6. Navigate to and select `Payloads` > `fusee.bin`. +1. Copy *the contents of* the Atmosphere `.zip` file to the root of your microSD card. +1. Copy the `bootloader` folder from the Hekate `.zip` file to the root of your microSD card. +1. Copy `fusee.bin` to the `sd:/bootloader/payloads` folder on your microSD card. +1. The setup is complete, you can inject the Hekate payload (Unpatched Switch users) or place the Hekate payload on the root of your microSD card and rename it to `payload.bin` (Modchipped Switch users). +1. Navigate to and select `Payloads` > `fusee.bin`. - Note: `fusee` uses a set boot order that is not as easily configurable as Hekate. Its boot order is `emuMMC` > `sysCFW` > `stock`. If an emuMMC isn't present, it will boot into sysCFW for example. Make sure you have a method of blocking Nintendo's servers set up (such as [DNS-MITM](../extras/blocking_nintendo.md/#instructions-ams-dns-redirection)) if you do use `fusee` and have an `emuMMC`. @@ -37,7 +37,7 @@ This method will *not* work for Modchipped Switch users. #### **Instructions:** 1. Insert your Switch's microSD card into your PC. -2. Copy *the contents of* the Atmosphere `.zip` file to the root of your microSD card. -3. The setup is complete, you can inject the `fusee.bin` payload. +1. Copy *the contents of* the Atmosphere `.zip` file to the root of your microSD card. +1. The setup is complete, you can inject the `fusee.bin` payload. - Note: `fusee` uses a set boot order that is not as easily configurable as Hekate. Its boot order is `emuMMC` > `sysCFW` > `stock`. If an emuMMC isn't present, it will boot into sysCFW for example. Make sure you have a method of blocking Nintendo's servers set up (such as [DNS-MITM](../extras/blocking_nintendo.md/#instructions-ams-dns-redirection)) if you do use `fusee` and have an `emuMMC`. diff --git a/docs/extras/autorcm.md b/docs/extras/autorcm.md index ed03b87c..f83437d8 100644 --- a/docs/extras/autorcm.md +++ b/docs/extras/autorcm.md @@ -5,18 +5,18 @@ AutoRCM causes the console to believe it is bricked, and will automatically laun - Note: If the console screen stays black when pressing the power button after activating AutoRCM, remember that it's not broken. It's in RCM. !!! warning "If you don't have a BOOT0/1 backup yet..." - You really want to kill your console, huh? If you haven't made a BOOT0/1 backup yet, it is recommended to make one **right now**. + You really want to kill your console, huh? If you haven't made a BOOT0/1 backup yet, it is recommended to make one **right now**. - 1. Boot into Hekate - 2. Go to `Tools`, and select `Backup eMMC` - 3. Then tap `eMMC BOOT0 & BOOT1` and let the process complete. + 1. Boot into Hekate + 1. Go to `Tools`, and select `Backup eMMC` + 1. Then tap `eMMC BOOT0 & BOOT1` and let the process complete. ### **Disadvantages of AutoRCM** There are some disadvantages you should consider before installing AutoRCM: - Please keep in mind that the console can no longer boot on its own, so you'll need a PC, phone, or other payload injector to start the console after letting the console fully shut off. (AutoRCM by itself is considered a "tethered jailbreak"). - - Note: Sleep Mode is not considered "powering off/on" the console. Sleep Mode will still work as intended and is fully unchanged with AutoRCM. + - Note: Sleep Mode is not considered "powering off/on" the console. Sleep Mode will still work as intended and is fully unchanged with AutoRCM. - When completely discharged, your Switch will take a very long time to charge while in RCM. To solve this, charge the console for approximately twenty minutes before booting into Hekate and selecting a boot option. After it's done booting, the console will now charge at a normal speed with a battery icon in the corner. - When a system update is completed while stock firmware is running, AutoRCM becomes disabled so you need to turn it on again. AutoRCM can be preserved by updating while CFW is active. @@ -26,11 +26,11 @@ AutoRCM can be used for good as well: - If you were having trouble getting into RCM before (i.e you were using the tinfoil method), now you can get into RCM without any hassle. - If you want to keep fuses unburned, you can do so with AutoRCM, as the Switch never gets the chance to burn them. Nintendo's bootloaders burn the fuses, but those bootloaders cannot be used if AutoRCM is enabled. - - Note: updating the console while booted into Hekate's "stock" configuration will clear AutoRCM on the next reboot. Please update while using custom firmware, or be sure to use a jig after the console reboots. + - Note: updating the console while booted into Hekate's "stock" configuration will clear AutoRCM on the next reboot. Please update while using custom firmware, or be sure to use a jig after the console reboots. - It's easier to inject a payload using a payload injector, as using your jig and booting into RCM manually is no longer required. !!! tip "Other information..." - - This method corrupts a single byte in both your BOOT0 and your BOOT1 partitions. This is why a backup of those is recommended. + - This method corrupts a single byte in both your BOOT0 and your BOOT1 partitions. This is why a backup of those is recommended. - This software version of AutoRCM can almost always be reversed, so don't freak out if it doesn't work out the way you'd like it to. ### **Enable/Disable AutoRCM** @@ -38,7 +38,7 @@ AutoRCM can be used for good as well: If, despite all of the information above, you still wish to enable (or disable) AutoRCM, and understand the risks, do the following: 1. Boot into Hekate -2. Go to `Tools` -3. At the bottom of the page, tap `Arch Bit • AutoRCM • Touch • Pkg1/2` -4. Then tap `AutoRCM`. It will show a little `ON` next to the option once you have done this. +1. Go to `Tools` +1. At the bottom of the page, tap `Arch Bit • AutoRCM • Touch • Pkg1/2` +1. Then tap `AutoRCM`. It will show a little `ON` next to the option once you have done this. - If you wish to disable it instead, follow these same steps and ensure the `AutoRCM` option is set to `OFF`. diff --git a/docs/extras/blocking_nintendo.md b/docs/extras/blocking_nintendo.md index 66d0ded9..f8a46212 100644 --- a/docs/extras/blocking_nintendo.md +++ b/docs/extras/blocking_nintendo.md @@ -13,13 +13,13 @@ You can configure Atmosphère to automatically redirect any requests directed to 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. Enter the `atmosphere` folder. -4. If it doesn't exist already, create a folder named `hosts` in the `atmosphere` folder. +1. Navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. +1. Enter the `atmosphere` folder. +1. If it doesn't exist already, create a folder named `hosts` in the `atmosphere` folder. - You should end up with the `sd:/atmosphere/hosts` directory. -5. Copy the `emummc.txt` file into the hosts folder. +1. Copy the `emummc.txt` file into the hosts folder. - If you want to apply the DNS redirection to sysmmc instead of emummc, rename the file to `sysmmc.txt` -6. Eject the `UMS` device safely from within your computer's operating system and boot into CFW. +1. Eject the `UMS` device safely from within your computer's operating system and boot into CFW. !!! note "Verify functionality" You can verify the functionality of the DNS redirection by booting into emummc (or sysmmc if you applied the config to sys), and powering off after. @@ -42,33 +42,33 @@ Enter the console's System Settings, and then proceed to the Internet tab. From Not all WiFi networks require a password to connect. If your network does not use one, you can use the `Manual Setup` option, located at the very bottom of the `Internet Settings` screen below all other WiFi networks. 1. Select your WiFi network from the list of networks. -2. Enter an **incorrect** password that is 8 characters long and press `OK`. -3. After a few moments of attempting to connect, the console will display a connection error. -4. Press `OK` to close the error message. -5. Press `Close` when it offers to display more details about the error. -6. When asked if you want to re-enter the password, pick `View Settings`. -7. Change `DNS Settings` to `Manual`. -8. Pick the server that is the closest to your location out of the below chart and enter its `Primary` and `Secondary` DNS into your connection settings. -9. Enter the correct password for your WiFi connection. -10. Save the settings and test the connection. +1. Enter an **incorrect** password that is 8 characters long and press `OK`. +1. After a few moments of attempting to connect, the console will display a connection error. +1. Press `OK` to close the error message. +1. Press `Close` when it offers to display more details about the error. +1. When asked if you want to re-enter the password, pick `View Settings`. +1. Change `DNS Settings` to `Manual`. +1. Pick the server that is the closest to your location out of the below chart and enter its `Primary` and `Secondary` DNS into your connection settings. +1. Enter the correct password for your WiFi connection. +1. Save the settings and test the connection. ----- #### **Editing an existing WiFi connection** 1. Select your existing WiFi network from the list of networks. -2. Select `Change Settings`. -3. Pick the server that is the closest to your location out of the below chart and enter its Primary and Secondary DNS into your connection settings. -4. Save the settings and test the connection. +1. Select `Change Settings`. +1. Pick the server that is the closest to your location out of the below chart and enter its Primary and Secondary DNS into your connection settings. +1. Save the settings and test the connection. ----- #### **Using homebrew to set 90DNS on all existing WiFi networks** 1. Download [switch-90dns-setter](https://github.com/suchmememanyskill/switch-90dns-setter/releases) and put it in the `/switch` folder. -2. Launch CFW and open the homebrew menu. -3. Launch `90DNS Setter`. -4. Press X to apply 90DNS to all WiFi networks. -5. Press Y to reboot the Switch. -6. Check in system settings if networks have a custom DNS applied. +1. Launch CFW and open the homebrew menu. +1. Launch `90DNS Setter`. +1. Press X to apply 90DNS to all WiFi networks. +1. Press Y to reboot the Switch. +1. Check in system settings if networks have a custom DNS applied. | Location | Primary DNS | Secondary DNS | @@ -88,13 +88,13 @@ Enter the console's System Settings, and then proceed to the Internet tab. From #### **Testing via the eShop (Stock)** 1. Open the eShop. Wait until it either opens or displays an error. -2. If it displays "Unable to display page.", you seem to have blocked Nintendo's servers. +1. If it displays "Unable to display page.", you seem to have blocked Nintendo's servers. #### **Testing via a homebrew app (CFW)** 1. Download the latest release of the [90DNS Tester](https://github.com/meganukebmp/Switch_90DNS_tester/releases) -2. Place the `Switch_90DNS_tester.nro` in the `switch` folder on your SD. -3. Enter the homebrew menu and run the 90DNS Tester. -4. After the test finished it should look similar to the below picture, with every `nintendo` domain being blocked. +1. Place the `Switch_90DNS_tester.nro` in the `switch` folder on your SD. +1. Enter the homebrew menu and run the 90DNS Tester. +1. After the test finished it should look similar to the below picture, with every `nintendo` domain being blocked. !!! tip "" ![tester example](../extras/img/90dns_tester_switch.jpg) diff --git a/docs/extras/game_modding.md b/docs/extras/game_modding.md index c7023855..ed78c418 100644 --- a/docs/extras/game_modding.md +++ b/docs/extras/game_modding.md @@ -7,12 +7,12 @@ LayeredFS, a tool built into Atmosphere, allows you to (temporarily) replace a g Check the section below to find your mod's folder/file structure, then install your mod accordingly. !!! note "**Checking folder/file structures**" - * If the mod solely includes a `romfs` (and/or `exefs` folder), you will need to place that folder inside of `sd:/atmosphere/contents//`. + - If the mod solely includes a `romfs` (and/or `exefs` folder), you will need to place that folder inside of `sd:/atmosphere/contents//`. - **Note:** The title ID folder has to be created manually in this case. This is game specific and the title ID of every game can be found on the following websites: [switchbrew](https://switchbrew.org/wiki/Title_list/Games) and [nswdb](https://nswdb.com/). - * If the mod solely includes a `contents` folder, you can simply copy that folder to `sd:/atmosphere/` on your microSD card and merge folders if prompted. + - If the mod solely includes a `contents` folder, you can simply copy that folder to `sd:/atmosphere/` on your microSD card and merge folders if prompted. - * If the mod has the complete folder structure set up (i.e. `atmosphere/contents//romfs`), you can simply copy the `atmosphere` folder (likely inside of a mod's `.zip` file) to the root of your microSD card and merge folders if prompted. + - If the mod has the complete folder structure set up (i.e. `atmosphere/contents//romfs`), you can simply copy the `atmosphere` folder (likely inside of a mod's `.zip` file) to the root of your microSD card and merge folders if prompted. !!! warning "Atmosphere 0.9.4 and below" **Note: On Atmosphère 0.9.4 and below, `contents` is called `titles`** @@ -32,11 +32,11 @@ If you want to disable mods on launch of a game, hold the `L` button before laun While most games only require Atmosphere's LayeredFS to enable game modding, there are some games that may require more specialized setup. For example: -* Modding Super Smash Bros. requires [ARCropolis](https://github.com/Raytwo/ARCropolis/releases) and [skyline](https://github.com/skyline-dev/skyline/releases). Skyline's `exefs` folder goes into the `atmosphere/contents/01006A800016E000/` directory. ARCropolis looks for mods in the `sd:/ultimate/mods` directory on your microSD card. +- Modding Super Smash Bros. requires [ARCropolis](https://github.com/Raytwo/ARCropolis/releases) and [skyline](https://github.com/skyline-dev/skyline/releases). Skyline's `exefs` folder goes into the `atmosphere/contents/01006A800016E000/` directory. ARCropolis looks for mods in the `sd:/ultimate/mods` directory on your microSD card. -* Modding Breath of the Wild and Tears of the Kingdom with multiple mods requires the use of [BCML](https://github.com/NiceneNerd/BCML) or [UKMM](https://github.com/NiceneNerd/UKMM/releases) (Recommended) and [TKMM](https://github.com/TKMM-Team/Tkmm/releases) respectively. +- Modding Breath of the Wild and Tears of the Kingdom with multiple mods requires the use of [BCML](https://github.com/NiceneNerd/BCML) or [UKMM](https://github.com/NiceneNerd/UKMM/releases) (Recommended) and [TKMM](https://github.com/TKMM-Team/Tkmm/releases) respectively. -* Animal Crossing: New Horizons requires some extra setup for mods to work. The folder that would normally be called `romfs` has to be called `romFs` and you'll need to create an empty file inside of `atmosphere/contents/01006F8002326000/romFs/System/Resource/` called `ResourceSizeTable.srsizetable`. More information on this can be found on the [ac-modding website](https://ac-modding.com/ACNH/mods.html). +- Animal Crossing: New Horizons requires some extra setup for mods to work. The folder that would normally be called `romfs` has to be called `romFs` and you'll need to create an empty file inside of `atmosphere/contents/01006F8002326000/romFs/System/Resource/` called `ResourceSizeTable.srsizetable`. More information on this can be found on the [ac-modding website](https://ac-modding.com/ACNH/mods.html). ----- diff --git a/docs/extras/glossary.md b/docs/extras/glossary.md index 3178fbab..9351f05a 100644 --- a/docs/extras/glossary.md +++ b/docs/extras/glossary.md @@ -16,7 +16,7 @@ The following list is in alphabetical order. - **DNS**: [Domain Name System](https://en.wikipedia.org/wiki/Domain_Name_System). Basically, the internet's addressbook. If you visit a website, the DNS lookup is what tells you what server the site is hosted on. - **Dongle**: Device you can plug in the USB-C of your Switch to automatically send a payload if your Switch is in RCM. - **Encryption keys**: Keys used to encrypt data from the Nintendo Switch. - - **BIS keys**: Built-in Storage keys. They are used to encrypt/decrypt the NAND's contents. + - **BIS keys**: Built-in Storage keys. They are used to encrypt/decrypt the NAND's contents. - **[fusee-gelee](https://github.com/Qyriad/fusee-launcher/blob/master/report/fusee_gelee.md)/[ShofEL2](https://github.com/fail0verflow/shofel2)**: Two names for two different implementations of the [same exploit](https://nvd.nist.gov/vuln/detail/CVE-2018-6242). This is an exploit that grants full bootROM access to the Nintendo Switch from the Tegra X1's RCM, and permitting us to run CFW. This exploit requires an external device or a tiny hardware modification. fusee-gelee is developed by an ex-ReSwitched developer, while ShofEL2 is developed by the failoverfl0w team. This guide uses fusee-gelee. - **[hactool](https://github.com/SciresM/hactool)**: Software used to decrypt Nintendo Switch files like .XCI and .NSP files. - **[Hekate](https://github.com/CTCaer/hekate)**: A bootloader for the Nintendo Switch. The current guide uses this in combination with essential files from Atmosphère to boot CFW. diff --git a/docs/extras/nandrestore.md b/docs/extras/nandrestore.md index 48bffc89..a02f5730 100644 --- a/docs/extras/nandrestore.md +++ b/docs/extras/nandrestore.md @@ -1,15 +1,15 @@ ## 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 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. + - 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. + - 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 + - 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](https://github.com/CTCaer/hekate/releases/) Payload - A microSD card larger than 32GB ### Instructions: @@ -17,29 +17,29 @@ 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 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. + 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 microSD card. Continue with step 1 of the instructions below. + 1. Launch the latest Hekate payload on your Switch. + 1. Navigate to `Tools` > `Backup eMMC` > `eMMC BOOT0 & BOOT1` and let it do its thing. + 1. 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. 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. +1. Navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. +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 microSD card. +1. Eject the `UMS` device safely from within your computer's operating system. +1. Navigate to `Tools` > `Restore eMMC`. Select `Restore eMMC BOOT0 & BOOT1`. Wait for this process to complete. +1. 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. + 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. + - 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**. + A system update is considered a security version when a fuse is burned, you can check **[which versions burn fuses here](https://switchbrew.org/wiki/Fuses#Anti-downgrade)**. - 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. + 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` + 1. Select the `AutoRCM` buttom and you will see `ON` written next to it. This means it is enabled. diff --git a/docs/extras/showing_file_extensions.md b/docs/extras/showing_file_extensions.md index fd98b523..52b636a0 100644 --- a/docs/extras/showing_file_extensions.md +++ b/docs/extras/showing_file_extensions.md @@ -5,14 +5,14 @@ By default, Microsoft Windows 10 and 11 do not show file extensions for known fi ### **Instructions for Windows 10:** 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. +1. Switch to the View tab/ribbon. +1. On this tab, if the `File name extensions` checkbox is not ticked, 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. +1. Click the `View` hamburger menu/dropdown menu. +1. Go to `Show` at the bottom and ensure that `File name extensions` is ticked. !!! tip "" ![Visual for the above instructions](img/file_extensions.png) diff --git a/docs/extras/transfer_sd.md b/docs/extras/transfer_sd.md index f7ba0339..0b57cc3c 100644 --- a/docs/extras/transfer_sd.md +++ b/docs/extras/transfer_sd.md @@ -10,8 +10,8 @@ You should first check whether you have a file or partition based 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 microSD card. -2. Tap on the `emuMMC` button. -3. Under `emuMMC Info & Selection`, check the text next to `Type`. +1. Tap on the `emuMMC` button. +1. Under `emuMMC Info & Selection`, check the text next to `Type`. - If you have one it should be either `SD Raw Partition` or `SD File`. ----- @@ -19,13 +19,13 @@ You should first check whether you have a file or partition based 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 microSD card. -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. +1. Navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. +1. Copy the contents of your microSD card somewhere to your PC. +1. Access your new microSD card via a microSD card reader or similar. +1. 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. +1. Copy the files from your PC or directly from your old microSD card to your new microSD card. +1. Eject the `UMS` device safely from within your computer's operating system. ----- ### **If you are using a partition based emuMMC:** @@ -35,20 +35,20 @@ You should first check whether you have a file or partition based 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. 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: `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 open the accessible drive containing the contents of your microSD card. -6. Copy the contents of your old microSD card somewhere to your PC. -7. Follow the `Preparing Hekate` section at the bottom of [this page](../user_guide/rcm/sending_payload.md) (Unpatched Switch users only) to prepare your new SD card with Hekate's files. +1. In the main menu, tap on `Tools`, then `Backup eMMC` and set `SD emuMMC Raw Partition` at the bottom of your screen to `ON`. +1. Backup both `SD emuMMC BOOT0 & BOOT1` and `SD emuMMC RAW GPP` (Note: `SD emuMMC RAW GPP` may take a while). +1. 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. +1. If Windows asks you to format a drive, discard it and open the accessible drive containing the contents of your microSD card. +1. Copy the contents of your old microSD card somewhere to your PC. +1. Follow the `Preparing Hekate` section at the bottom of [this page](../user_guide/rcm/sending_payload.md) (Unpatched Switch users only) to prepare your new SD card with Hekate's files. - If you have a modchipped Switch, follow [this page](../user_guide/modchip/preparing_hekate.md) instead. -8. Follow only steps 1-3 on [this page](../user_guide/all/partitioning_sd.md) to partition the new microSD card for an emuMMC setup. -8. After it’s done, boot into Hekate and navigate to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. -9. Copy the backup you made of your old microSD card on your PC to your new microSD card. -10. Navigate to `/backup//emummc` on your microSD card and move `BOOT0`, `BOOT1` and the `rawnand.bin.xx` files to `/backup//restore/emummc`. -11. Eject the `UMS` device safely from within your computer's operating system. -12. Tap on `Tools`, `Restore eMMC`, set `SD emuMMC Raw Partition` at the bottom of your screen to `ON`. -13. Restore the backup by tapping on both `SD emuMMC BOOT0 & BOOT1` and `SD emuMMC RAW GPP` (Note: `SD emuMMC RAW GPP` may take a while). +1. Follow only steps 1-3 on [this page](../user_guide/all/partitioning_sd.md) to partition the new microSD card for an emuMMC setup. +1. After it’s done, boot into Hekate and navigate to `Tools` > `USB Tools` > `SD Card`, then plug your Switch into your PC via USB. +1. Copy the backup you made of your old microSD card on your PC to your new microSD card. +1. Navigate to `/backup//emummc` on your microSD card and move `BOOT0`, `BOOT1` and the `rawnand.bin.xx` files to `/backup//restore/emummc`. +1. Eject the `UMS` device safely from within your computer's operating system. +1. Tap on `Tools`, `Restore eMMC`, set `SD emuMMC Raw Partition` at the bottom of your screen to `ON`. +1. Restore the backup by tapping on both `SD emuMMC BOOT0 & BOOT1` and `SD emuMMC RAW GPP` (Note: `SD emuMMC RAW GPP` may take a while). - It is very important that for both of these the `SD emuMMC Raw Partition` option is enabled, otherwise you will be altering your sysMMC which is not what you want. -14. Your emuMMC is now restored on the new microSD card and you should be able to launch it from `Launch` -> `Atmosphere FSS0 emuMMC` in Hekate. +1. Your emuMMC is now restored on the new microSD card and you should be able to launch it from `Launch` -> `Atmosphere FSS0 emuMMC` in Hekate. diff --git a/docs/extras/updating.md b/docs/extras/updating.md index c29aa3f9..1dfb8e46 100644 --- a/docs/extras/updating.md +++ b/docs/extras/updating.md @@ -16,12 +16,12 @@ When a new version of Atmosphère releases, you can update Atmosphère by follow 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. Navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. -3. Download the latest release of Atmosphere (Download the `atmosphere-(version)-master-(version)+hbl-(version)+hbmenu-(version).zip` release of Atmosphere.) -4. Copy *the contents of* the Atmosphere `.zip` file to the root of your microSD card. +1. Navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. +1. Download the latest release of [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere/releases) (Download the `atmosphere-(version)-master-(version)+hbl-(version)+hbmenu-(version).zip` release of Atmosphere.) +1. Copy *the contents of* the Atmosphere `.zip` file to the root of your microSD card. - If you are prompted to overwrite files, do so. -5. Eject the `UMS` device safely from within your computer's operating system. -6. (If your Hekate is not on the latest version) update Hekate via the steps below. +1. Eject the `UMS` device safely from within your computer's operating system. +1. (If your Hekate is not on the latest version) update Hekate via the steps below. ### **Updating Hekate** @@ -31,12 +31,12 @@ When a new version of Hekate releases, you can update by following these steps: 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. Navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. -3. Download the latest version of Hekate (Download the `hekate_ctcaer_(version).zip` release of hekate). -4. Copy the `bootloader` folder from the Hekate `.zip` file to the root of your microSD card. If you are asked to overwrite or merge files while copying, say yes to merge/overwrite them. -5. Eject the `UMS` device safely from within your computer's operating system. -6. Go back to Hekate's main menu and press `Reload` > `Reload` to reload Hekate from your microSD card. -7. From here, you're done and you can boot into CFW. +1. Navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. +1. Download the latest version of [Hekate](https://github.com/CTCaer/Hekate/releases/) (Download the `hekate_ctcaer_(version).zip` release of hekate). +1. Copy the `bootloader` folder from the Hekate `.zip` file to the root of your microSD card. If you are asked to overwrite or merge files while copying, say yes to merge/overwrite them. +1. Eject the `UMS` device safely from within your computer's operating system. +1. Go back to Hekate's main menu and press `Reload` > `Reload` to reload Hekate from your microSD card. +1. From here, you're done and you can boot into CFW. ### **Updating your firmware** @@ -85,14 +85,14 @@ If you keep your emuMMC offline, you will have to use a gamecard to update your This guide is made for updating your emuMMC. It is **not** for downgrading. Downgrading at all, sysMMC or emuMMC, is not recommended and not worth it. Downgrading is also very dangerous and can lead to serious complications even when performed correctly. #### **What you need:** -- The latest release of TegraExplorer -- The latest release of Atmosphere +- The latest release of [TegraExplorer](https://github.com/suchmememanyskill/TegraExplorer/releases) +- The latest release of [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere/releases) #### **Preparing your microSD card** 1. Boot into Hekate. -2. Go to `Tools` > `USB Tools` > `SD Card` and connect your Switch to your PC via USB. -3. Download the latest release of `TegraExplorer.bin` and place it `sd:/bootloader/payloads`. +1. Go to `Tools` > `USB Tools` > `SD Card` and connect your Switch to your PC via USB. +1. Download the latest release of `TegraExplorer.bin` and place it `sd:/bootloader/payloads`. Make sure your sysMMC is updated before moving onto the instructions below. @@ -100,24 +100,24 @@ Make sure your sysMMC is updated before moving onto the instructions below. 1. Make sure your sysMMC is up to date. If your sysMMC is not up-to-date, boot into Stock or sysCFW and update it through the System Settings. - sysCFW is recommended since it preserves e-fuses and preserves AutoRCM (if applicable). -2. Inject `TegraExplorer.bin` using your favourite payload injector (Like you would with Hekate). +1. Inject `TegraExplorer.bin` using your favourite payload injector (Like you would with Hekate). - If you are using a modchipped Switch, you can simply put `TegraExplorer.bin` in `sd:/bootloader/payloads` on your microSD card, then turn on your console and load TegraExplorer via Hekate's payloads menu (`Payloads` > `TegraExplorer.bin`). -3. Using the joystick and the A buttons, select `FirmwareDump.te`, then select `Dump sysmmc`. +1. Using the joystick and the A buttons, select `FirmwareDump.te`, then select `Dump sysmmc`. - If navigation doesn't work with your Joycons, navigating using the volume buttons and selecting using the power button also works. (This is also required for Switch Lite console users.) -4. Wait about 1-2 minutes for the script to dump your firmware. -5. When the script finishes, press any button. -6. Select `Reboot to bootloader/update.bin`. +1. Wait about 1-2 minutes for the script to dump your firmware. +1. When the script finishes, press any button. +1. Select `Reboot to bootloader/update.bin`. #### **Updating your emuMMC with Daybreak** 1. In Hekate go to `Launch -> Atmosphere FSS0 emuMMC`. -2. Once booted, hold `R` while launching a game to boot into the homebrew menu. -3. Find Daybreak in the homebrew menu and launch it. -4. Tap on `Install` and navigate to `sd:/tegraexplorer/Firmware/`. -5. Tap on `Continue` and then `Preserve settings`. +1. Once booted, hold `R` while launching a game to boot into the homebrew menu. +1. Find Daybreak in the homebrew menu and launch it. +1. Tap on `Install` and navigate to `sd:/tegraexplorer/Firmware/`. +1. Tap on `Continue` and then `Preserve settings`. - If you see the message `Warning: exFAT firmware is missing or corrupt`, you likely don't have the exFAT drivers installed on your sysMMC. Just press continue if this is the case. -6. If it is available choose `Install (FAT32 + exFAT)`, otherwise `Install (FAT32)` and then `Continue`. -7. Wait until Daybreak completes installing the dumped firmware. -8. Once it completes, it will ask if you want to reboot. Tap `Reboot`. -9. Once rebooted, launch into emuMMC and verify your system works. You can verify your system has been properly updated in `Settings -> System`. +1. If it is available choose `Install (FAT32 + exFAT)`, otherwise `Install (FAT32)` and then `Continue`. +1. Wait until Daybreak completes installing the dumped firmware. +1. Once it completes, it will ask if you want to reboot. Tap `Reboot`. +1. Once rebooted, launch into emuMMC and verify your system works. You can verify your system has been properly updated in `Settings -> System`. diff --git a/docs/faq.md b/docs/faq.md index f95afbe1..0c9388f0 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -8,7 +8,7 @@ Any console purchased after approximately August 2018 is **likely** to be patche Currently the only way to know if your Switch is hackable is by trying to send the payload in RCM. Even with this exploit fixed, many Switch consoles on 8.0.1 and below will be hackable to some degree in the future (see [Should I update my Firmware?](#should-i-update-my-firmware) for much more detailed information). The serial number on the back of the box can possibly tell you which consoles are patched and which aren't. -See here for an up to date list. +See [here](https://gbatemp.net/threads/switch-informations-by-serial-number.481215/) for an up to date list. ### **How do I use fusee-gelee? How can I boot into RCM?** @@ -58,7 +58,7 @@ This will not work on an unpatched system, and is practically useless for most u On every boot the Switch firmware checks how many e-fuses have been burned and how many e-fuses the Switch expects to be burned. Major updates to the Switch, or updates in which a large vulnerability has been patched, irreversibly burn one of the Switch's 64 "e-fuses". *If the Switch ever detects that more e-fuses have been burned than expected (meaning a downgrade happened), it will refuse to boot. Replacing e-fuses is not an option.* -You can find more information about fuses here +You can find more information about fuses [here](https://switchbrew.org/wiki/Fuses#Anti-downgrade) Atmosphèreis maintained to support the latest firmware updates on unpatched units. The situation for patched and new units is as follows: - **"Old"** *Patched Switch (HAC-001): Do NOT update past 7.0.1. Units on 7.0.1 and below will eventually get CFW. Patched units that have upgraded to 8.0.0 or 8.0.1 will likely get homebrew.* @@ -77,7 +77,7 @@ As long as the Switch is connected to the internet, Nintendo gets a report about Even if the Switch is offline and connects to the internet at a later point, Nintendo still recieves information about what happened while the Switch was disconnected. To disable some of this telemetry, it is advised to disable the sending of error reports in the System Settings of the Switch. -Additionally if you live in the EU you can set the "do not share" option on Nintendo's website to prevent your Switch from sending a lot of telemetry, although the effectiveness of this is questionable. +Additionally if you live in the EU you can set the "do not share" option on [Nintendo's website](https://accounts.nintendo.com/setting) to prevent your Switch from sending a lot of telemetry, although the effectiveness of this is questionable. Nintendo still receives a lot of information, even with those options disabled. We also cannot know if Nintendo decides to look for something in the logs and ban people in retrospect. @@ -134,7 +134,7 @@ These microSD cards are often fake and do not have the advertised amount of stor Amazon has had some problems with fake microSD cards, so we recommend buying them at a physical store. Even on trustworthy sites, *always, always check reviews on a product before buying!!* -If you suspect your microSD card is fake or damaged, see the instructions here to verify the integrity of your microSD card. +If you suspect your microSD card is fake or damaged, see the instructions [here](https://wiki.hacks.guide/wiki/Checking_SD_card_integrity) to verify the integrity of your microSD card. @@ -145,9 +145,9 @@ This is an issue primarily affecting macOS users, but may occur on other devices 1. Inject the Hekate payload using your favorite payload injector. - If you have a modchipped Switch, place the Hekate payload on the root of your microSD card and rename it to payload.bin, reinsert your microSD card into your Switch and turn it on. -2. Press `Tools` on the top menu bar. -3. In the bottom right corner, press `Arch Bit • AutoRCM • Touch • Pkg1/2`. -4. Press `Fix Archive bit` - this might take a while. -5. Press `Close` in the top right corner. -6. Press `Home` in the top menu bar to get back from where you started. -7. Follow the instructions at the Launching CFW page [here](user_guide/all/launching_cfw.md) to launch Atmosphere. +1. Press `Tools` on the top menu bar. +1. In the bottom right corner, press `Arch Bit • AutoRCM • Touch • Pkg1/2`. +1. Press `Fix Archive bit` - this might take a while. +1. Press `Close` in the top right corner. +1. Press `Home` in the top menu bar to get back from where you started. +1. Follow the instructions at the Launching CFW page [here](user_guide/all/launching_cfw.md) to launch Atmosphere. diff --git a/docs/homebrew/edizon.md b/docs/homebrew/edizon.md index 88164307..4a301c50 100644 --- a/docs/homebrew/edizon.md +++ b/docs/homebrew/edizon.md @@ -15,18 +15,18 @@ For cheats management, [EdiZon](https://github.com/WerWolv/EdiZon) and/or [EdiZo === "Installation instructions (EdiZon):" 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. Put the `EdiZon.nro` in `sd:/switch`. - 4. Boot into CFW. + 1. Your microSD card should now be accessible on your PC, open it. + 1. Put the `EdiZon.nro` in `sd:/switch`. + 1. Boot into CFW. === "Installation instructions (EdiZon-SE):" 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 EdiZon-SE correctly, you should have a folder called `054e4f4558454000` (EdiZon-SE) in `sd:/atmosphere/contents` and an `EdiZon.nro` file in `sd:/switch/EdiZon`. - 5. Boot into CFW. + 1. Your microSD card should now be accessible on your PC, open it. + 1. 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. + 1. Copy the *contents* of the (extracted) `.zip` file to the root of your microSD card. + - **Optional:** You can verify if you've installed EdiZon-SE correctly, you should have a folder called `054e4f4558454000` (EdiZon-SE) in `sd:/atmosphere/contents` and an `EdiZon.nro` file in `sd:/switch/EdiZon`. + 1. Boot into CFW. ----- @@ -52,7 +52,7 @@ Once the title is launched while in Atmosphere, your cheats should be applied. To prevent cheats from being enabled by default, you can change your Atmosphère configuration by following the steps below. 1. Copy `system_settings.ini` from `sd:/atmosphere/config_templates` to `sd:/atmosphere/config` if it's not already there. -2. Open the `system_settings.ini` file with a text editor and edit the line `; dmnt_cheats_enabled_by_default = u8!0x1` to `dmnt_cheats_enabled_by_default = u8!0x0`. +1. Open the `system_settings.ini` file with a text editor and edit the line `; dmnt_cheats_enabled_by_default = u8!0x1` to `dmnt_cheats_enabled_by_default = u8!0x0`. - Make sure you remove the space and the semicolon "`; `" in front of `dmnt_cheats_enabled_by_default`. diff --git a/docs/homebrew/ftpd.md b/docs/homebrew/ftpd.md index 03d3b19e..775068be 100644 --- a/docs/homebrew/ftpd.md +++ b/docs/homebrew/ftpd.md @@ -15,11 +15,11 @@ FTPD is simply an FTP server for the Switch, it can be used to transfer files wi 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. +1. Open your FTP client of choice. +1. 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. +1. Type in port `5000` for the port and attempt to connect to your Switch. +1. You should now be able to access your microSD card wirelessly and transfer files to- and from- the microSD card. #### FTPD's main menu: diff --git a/docs/homebrew/jksv.md b/docs/homebrew/jksv.md index 409d2ff1..6eb332c5 100644 --- a/docs/homebrew/jksv.md +++ b/docs/homebrew/jksv.md @@ -9,11 +9,11 @@ For save management, [JKSV](https://github.com/J-D-K/JKSV) is recommended. It ca #### 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. +1. Select your Switch user on the left side with the `A` button. +1. Select your desired game and press `A` to select it. +1. Press `A` again to create a new save backup +1. Enter a name for the save data folder containing the save data and press `+` or `OK`. +1. Wait for it to finish backing up your save data. ----- @@ -22,10 +22,10 @@ For save management, [JKSV](https://github.com/J-D-K/JKSV) is recommended. It ca #### 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. +1. Select your Switch user on the left side with the `A` button. +1. Select your desired game and press `A` to select it. +1. Hover over the save data folder containing the save data you want and press `Y`. +1. 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. diff --git a/docs/homebrew/ldn_mitm.md b/docs/homebrew/ldn_mitm.md index 19bd5574..257503dd 100644 --- a/docs/homebrew/ldn_mitm.md +++ b/docs/homebrew/ldn_mitm.md @@ -15,12 +15,12 @@ ldn_mitm is a [sysmodule](index.md#terminologies) that allows you to route the l #### 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. +1. Your microSD card should now be accessible on your PC, open it. +1. 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. +1. 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. +1. Boot into CFW. ----- diff --git a/docs/homebrew/mission-control.md b/docs/homebrew/mission-control.md index 148538a0..a6a0b0d0 100644 --- a/docs/homebrew/mission-control.md +++ b/docs/homebrew/mission-control.md @@ -10,12 +10,12 @@ MissionControl is a [sysmodule](index.md#terminologies) that allows you to pair #### 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. +1. Your microSD card should now be accessible on your PC, open it. +1. 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. +1. 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. +1. Boot into CFW. ----- diff --git a/docs/homebrew/nxtheme-installer.md b/docs/homebrew/nxtheme-installer.md index c9474d01..35a333a1 100644 --- a/docs/homebrew/nxtheme-installer.md +++ b/docs/homebrew/nxtheme-installer.md @@ -17,7 +17,7 @@ Using NXTheme Installer, you can install and create unique styles and layouts fo ### **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. + If you want to use community made themes, for example from the [r/NXThemes](https://www.reddit.com/r/NXThemes/) subreddit or [Themezer](https://themezer.net), you can follow the guide below to install a community provided `.nxtheme` file. #### **What you need:** @@ -27,15 +27,15 @@ Using NXTheme Installer, you can install and create unique styles and layouts fo 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. + - Create the `themes` folder on the root of your microSD card if it does not exist. +1. 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. + 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. +1. 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. +1. 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). +1. Reboot into CFW via the `Reboot` tab to see the changes. !!! tip "An example of a Home Menu theme being installed" ![ExampleSwitchTheme](../extras/img/switch_theming.jpg) @@ -48,17 +48,17 @@ Using NXTheme Installer, you can install and create unique styles and layouts fo #### **What you need:** - The latest release of **Switch Theme Injector** + The latest release of [**Switch Theme Injector**](https://github.com/exelix11/SwitchThemeInjector/releases) - 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. + 1. Open up the `SwitchThemes.exe` app. Navigate to `NXTheme Builder`. + 1. 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. + 1. 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. + 1. Repeat step 3 and 4 for every Home Menu part of the Switch you want to modify. === "**Mac / Linux / ChromeOS**" @@ -66,21 +66,21 @@ Using NXTheme Installer, you can install and create unique styles and layouts fo 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. + 1. Navigate to [**Exelix's Web Injector**](https://exelix11.github.io/SwitchThemeInjector/v2/) + 1. Select a Theme Target you want to edit. After this, click the Open an Image button and select your background image. + 1. Choose a theme name and an author name and optionally a different layout, then click build NxTheme. + 1. Your browser will prompt you to download a file. Save this file to a temporary folder. + 1. 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. +1. Boot into sysCFW/emuMMC, launch the Homebrew Menu and launch `NXThemes Installer`. +1. You should now see the main menu of `NXTheme Installer`, the `Themes` tab is where you will find your font(s). +1. Install your desired font by selecting the `.ttf` file in the font folder you created. +1. Reboot into CFW via the `Reboot` tab to see the changes. ----- diff --git a/docs/homebrew/simplemodmanager.md b/docs/homebrew/simplemodmanager.md index 435fb6e3..0b263f44 100644 --- a/docs/homebrew/simplemodmanager.md +++ b/docs/homebrew/simplemodmanager.md @@ -16,15 +16,15 @@ SimpleModManager is a [homebrew app](index.md#terminologies) that allows easily #### 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. Copy the `SimpleModManager.nro` file the `/switch/` folder on your microSD card. -4. Boot into CFW. +1. Your microSD card should now be accessible on your PC, open it. +1. Copy the `SimpleModManager.nro` file the `/switch/` folder on your microSD card. +1. Boot into CFW. #### Usage instructions: 1. Create a directory named `mods///` on the root of the SD card. - What you put for the mod name does not have to align with anything, put whatever you like! -2. Create the layeredFS directory for your mod that can be found on the [Game Modding](../extras/game_modding.md) page, skipping the `atmosphere` folder inside the `` folder. -3. Launch SimpleModManager via the Homebrew Menu and your games will show up, pressing A on them will show the mods available. +1. Create the layeredFS directory for your mod that can be found on the [Game Modding](../extras/game_modding.md) page, skipping the `atmosphere` folder inside the `` folder. +1. Launch SimpleModManager via the Homebrew Menu and your games will show up, pressing A on them will show the mods available. ![ExampleSwitchTheme](img/simplemodmanager1.jpg){ width="600" } ![ExampleSwitchTheme](img/simplemodmanager2.jpg){ width="600" } diff --git a/docs/homebrew/sys-botbase.md b/docs/homebrew/sys-botbase.md index da4a05e4..5eae2e65 100644 --- a/docs/homebrew/sys-botbase.md +++ b/docs/homebrew/sys-botbase.md @@ -15,12 +15,12 @@ sys-botbase is an advanced [sysmodule](index.md#terminologies) that allows users #### 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. +1. Your microSD card should now be accessible on your PC, open it. +1. 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. +1. 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. +1. Boot into CFW. ----- diff --git a/docs/homebrew/sys-clk.md b/docs/homebrew/sys-clk.md index 73d6ab1a..e3e92037 100644 --- a/docs/homebrew/sys-clk.md +++ b/docs/homebrew/sys-clk.md @@ -13,12 +13,12 @@ sys-clk is a [sysmodule](index.md#terminologies) that allows you to overclock th #### 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. +1. Your microSD card should now be accessible on your PC, open it. +1. 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. +1. 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. +1. Boot into CFW. ----- diff --git a/docs/homebrew/sys-con.md b/docs/homebrew/sys-con.md index f4c2ab95..4808ead7 100644 --- a/docs/homebrew/sys-con.md +++ b/docs/homebrew/sys-con.md @@ -10,12 +10,12 @@ sys-con is a [sysmodule](index.md#terminologies) that allows you to use normally #### 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. +1. Your microSD card should now be accessible on your PC, open it. +1. 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. +1. 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. +1. Boot into CFW. ----- diff --git a/docs/homebrew/tesla-menu.md b/docs/homebrew/tesla-menu.md index 21e3fbcd..f670aa0b 100644 --- a/docs/homebrew/tesla-menu.md +++ b/docs/homebrew/tesla-menu.md @@ -22,12 +22,12 @@ Tesla-Menu is an overlay menu developed by [WerWolv](https://github.com/WerWolv) #### 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. +1. Your microSD card should now be accessible on your PC, open it. +1. 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. +1. 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. +1. Boot into CFW. ----- @@ -41,15 +41,15 @@ Tesla-Menu can be opened by pressing `L` + `R Stick press (R3)` + `DPAD down`, a If you wish to change the default button configuration, see the instructions below: 1. Navigate to `sd:/config` on your microSD card. -2. Create a folder named `tesla` if it doesn't exist already. -3. Create a file named `config.ini` in `sd:/config/tesla`. -4. Paste the following text inside of `config.ini`: +1. Create a folder named `tesla` if it doesn't exist already. +1. Create a file named `config.ini` in `sd:/config/tesla`. +1. Paste the following text inside of `config.ini`: ``` [tesla] key_combo=L+R+RS # A, B, X, Y, LS, RS, L, R, ZL, ZR, PLUS, MINUS, DLEFT, DUP, DRIGHT, DDOWN, SL, SR ``` -5. Change the `key_combo` value to anything you desire and save the file. The accepted inputs are mentioned on the third line. +1. Change the `key_combo` value to anything you desire and save the file. The accepted inputs are mentioned on the third line. ----- diff --git a/docs/index.md b/docs/index.md index 6433e8b2..7e4bd21f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ - + # **NH Switch Guide** @@ -47,11 +47,11 @@ This guide has the end-goal of taking a completely unmodified Switch from stock ### **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 +- 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 More on this can be found later on in the guide. @@ -102,26 +102,26 @@ Note: We are not currently, historically, or will we ever be, associated with An 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 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: 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: 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: 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: 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). + - **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). - - **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. + - **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. - - **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/)! + - **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 index 7fa20ea8..5b05258d 100644 --- a/docs/user_guide/all/cfw_environment.md +++ b/docs/user_guide/all/cfw_environment.md @@ -22,28 +22,28 @@ For more information on terminology, please refer to the [glossary](../../extras - ### **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 + - 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 + - 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 + - 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. @@ -59,26 +59,26 @@ For more information on terminology, please refer to the [glossary](../../extras - ### **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 + - 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 possibility of custom profile pictures (guaranteed ban) + - 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 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, save data, 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)) + - Enjoying CFW features such as custom sysmodules and homebrew apps + - Dumping eShop games, save data, 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. @@ -97,8 +97,8 @@ For more information on terminology, please refer to the [glossary](../../extras 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: 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. + - **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/launching_cfw.md b/docs/user_guide/all/launching_cfw.md index e9a03e77..c2d6cf25 100644 --- a/docs/user_guide/all/launching_cfw.md +++ b/docs/user_guide/all/launching_cfw.md @@ -12,7 +12,7 @@ Unlike systems such as the DSi, Wii, or 3DS, Switch CFW is currently volatile. I #### Instructions: 1. From Hekate's `Home` menu, navigate to the `Launch` menu. - 2. Find `Atmosphere FSS0 emuMMC` and launch it. + 1. 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). @@ -26,7 +26,7 @@ Unlike systems such as the DSi, Wii, or 3DS, Switch CFW is currently volatile. I #### Instructions: 1. From Hekate's `Home` menu, navigate to the `Launch` menu. - 2. Find `Atmosphere FSS0 sysMMC` and launch it. + 1. 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). @@ -62,10 +62,10 @@ If you've partitioned your microSD card for preparation of Android/Linux earlier [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. + - **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 index d69aa13c..71c2d0c3 100644 --- a/docs/user_guide/all/making_essential_backups.md +++ b/docs/user_guide/all/making_essential_backups.md @@ -3,26 +3,26 @@ ### **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** + 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. + 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. + 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` +1. Use the touch screen or Joy-Cons to navigate to `Tools` > `Backup eMMC`. +1. 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` +1. 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. +1. Go to the top right and press `Close` > `Home`. +1. Navigate to `Tools` > `USB tools` > `SD card` and plug your Switch into your PC via USB. +1. Copy the `backup` folder on your microSD card to a safe location on your PC. +1. 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" @@ -31,13 +31,13 @@ 1. Press `OK` when Hekate tells you to back up your stuff.
![nandbackup](img/nandbackup.bmp){ 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. + 1. Press `Close` > `Close` > `USB Tools` > `SD Card` and connect your Switch to your PC via USB. + 1. 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. + 1. Eject the `UMS` device safely from within your computer's operating system and close the UMS window in Hekate. + 1. Press `Close` > `Backup eMMC` > `eMMC RAW GPP` and continue backing up your NAND. + 1. Repeat step 2-5 until the NAND is completely dumped. + 1. Once done, return to Hekate's `Home` menu. ----- @@ -54,5 +54,5 @@ ??? "Frequently Asked Questions about this page" - - **Q: Why is making a NAND backup considered crucial?**
+ - **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 index fd2150c1..e7ad2be2 100644 --- a/docs/user_guide/all/partitioning_sd.md +++ b/docs/user_guide/all/partitioning_sd.md @@ -10,20 +10,20 @@ ### **Instructions:** 1. Navigate to `Tools` > `Partition SD card` -2. Set the `emuMMC (RAW)` slider to `29 FULL` in the middle of the bar. +1. 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 at least 16GB. -3. Navigate to `Next Step` at the bottom right, then select `Start` in the menu that appears. +1. Navigate to `Next Step` at the bottom right, then select `Start` in the menu that appears. - For Android; Select `Legacy` partitioning for Android 10/11 and `Dynamic` partitioning for Android 13+. Legacy and Dynamic partitioning are **NOT** intercompatible. -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. +1. From hekate's `Home` menu, navigate to `emuMMC` > `Create emuMMC` > `SD Partition` > `Part 1` and wait for Hekate to complete creating the emuMMC. +1. 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. +1. Once done, go to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. +1. 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. + 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](https://discord.gg/C29hYvh) for support. ![hekate-partitioning-emu](img/hekate-partitioning-emu.png) diff --git a/docs/user_guide/all/partitioning_sd_syscfw.md b/docs/user_guide/all/partitioning_sd_syscfw.md index df040118..17b2a4a6 100644 --- a/docs/user_guide/all/partitioning_sd_syscfw.md +++ b/docs/user_guide/all/partitioning_sd_syscfw.md @@ -10,15 +10,15 @@ ### **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. +1. 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. +1. Once done, go to Hekate's `Home` menu and then `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB. +1. 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. + 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](https://discord.gg/C29hYvh) for support. ![hekate-partitioning-emu](img/hekate-partitioning-sys.png) diff --git a/docs/user_guide/all/sd_preparation.md b/docs/user_guide/all/sd_preparation.md index a91d08a2..10ec91b6 100644 --- a/docs/user_guide/all/sd_preparation.md +++ b/docs/user_guide/all/sd_preparation.md @@ -12,29 +12,29 @@ Atmosphere has its own bootloader, called fusee. For the purposes of this guide ----- #### **What you need:** -- The latest release of Hekate (Download the `hekate_ctcaer_(version).zip` release of hekate) +- The latest release of [Hekate](https://github.com/CTCaer/Hekate/releases/) (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) +- The latest release of [Atmosphere](https://github.com/Atmosphere-NX/Atmosphere/releases). Download the `atmosphere-(version)-master-(version)+hbl-(version)+hbmenu-(version).zip` release of Atmosphere. +- The latest release of [JKSV](https://github.com/J-D-K/JKSV/releases) (Download the `JKSV.nro` release of JKSV) +- The latest release of [FTPD](https://github.com/mtheall/ftpd/releases) (Download the `ftpd.nro` release of FTPD) +- The latest release of [NXThemesInstaller](https://github.com/exelix11/SwitchThemeInjector/releases) (Download the `NXThemesInstaller.nro` release of NXThemesInstaller) +- The latest release of [NX-Shell](https://github.com/joel16/NX-Shell/releases) (Download the `NX-Shell.nro` release of nx-shell) +- The latest release of [Goldleaf](https://github.com/XorTroll/Goldleaf/releases) (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. +1. Copy *the contents of* the Atmosphère`.zip` file to the root of your microSD card. +1. Copy the `bootloader` folder from the Hekate `.zip` file to the root of your microSD card. - If you're asked to replace files or merge folders, do so. -4. Copy the `bootloader` folder from the `bootlogos.zip` file to the root of your microSD card. +1. 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. +1. Copy `hekate_ipl.ini` to the `bootloader` folder on your microSD card. - If you're asked to replace the file, do so. -6. Create a folder named `hosts` inside the `atmosphere` folder on your microSD card, and put `emummc.txt` inside of the `hosts` folder. -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. +1. Create a folder named `hosts` inside the `atmosphere` folder on your microSD card, and put `emummc.txt` inside of the `hosts` folder. +1. Copy `JKSV.nro`, `ftpd.nro`, `NxThemesInstaller.nro`, `NX-Shell.nro` and `Goldleaf.nro` to the `switch` folder on your microSD card. +1. 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" diff --git a/docs/user_guide/getting_started.md b/docs/user_guide/getting_started.md index fa9a9ce2..c85db2ca 100644 --- a/docs/user_guide/getting_started.md +++ b/docs/user_guide/getting_started.md @@ -90,9 +90,9 @@ Before setting up for homebrew, install at least one eShop title to utilize "tit ??? "Frequently Asked Questions about this page" - - **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+. + - **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/modchip/index.md b/docs/user_guide/modchip/index.md index 3a3cf72c..433e3680 100644 --- a/docs/user_guide/modchip/index.md +++ b/docs/user_guide/modchip/index.md @@ -50,17 +50,17 @@ If you do decide to follow the recommended emuMMC path later in the guide, make [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: 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: 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: 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. + - **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 index 6cb3cb25..147aeeab 100644 --- a/docs/user_guide/modchip/preparing_hekate.md +++ b/docs/user_guide/modchip/preparing_hekate.md @@ -9,19 +9,19 @@ To get ready for formatting and/or partitioning your microSD card, we will need #### **What you need:** -- The latest release of Hekate (Download the `hekate_ctcaer_(version).zip` release of Hekate) +- The latest release of [Hekate](https://github.com/CTCaer/Hekate/releases/) (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. +1. Insert your microSD card into your computer. +1. Copy the `Nintendo` folder (and any other important data) from the root of your microSD card to a safe space on your device. +1. Inside of the extracted Hekate folder, you will find the `bootloader` folder and the `hekate_ctcaer_(version).bin` payload. +1. Copy the `bootloader` folder and `hekate_ctcaer_(version).bin` payload to the root of your microSD card. +1. Rename the `hekate_ctcaer_(version).bin` payload to `payload.bin` +1. Insert your microSD card back into your Switch, then turn it on. +1. You should now be loaded into the Hekate GUI (Nyx), pictured below, within seconds. ![Nyx](../all/img/nyx.bmp){ width="600" } - If you are unable to load into Nyx, consult the warning message below. diff --git a/docs/user_guide/rcm/entering_rcm.md b/docs/user_guide/rcm/entering_rcm.md index d3c4fb0f..20e0be39 100644 --- a/docs/user_guide/rcm/entering_rcm.md +++ b/docs/user_guide/rcm/entering_rcm.md @@ -16,9 +16,9 @@ Methods to enter RCM can require nothing more than household items (not recommen #### **Instructions:** 1. Power off the Switch and short the pins on the right 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`. +1. 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. +1. 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. ----- @@ -59,7 +59,7 @@ Methods to enter RCM can require nothing more than household items (not recommen #### Wire reference: ![wire reference](../rcm/img/entering_rcm_button_1.jpg){ 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. + 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: ![eip joycon button reference](../rcm/img/entering_rcm_button_5.jpg){ width="650"} diff --git a/docs/user_guide/rcm/index.md b/docs/user_guide/rcm/index.md index 5cbbc08d..3b785bb9 100644 --- a/docs/user_guide/rcm/index.md +++ b/docs/user_guide/rcm/index.md @@ -10,8 +10,8 @@ If you choose the emuMMC path introduced later in the guide, it'll be important [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 page](../../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: How does the RCM exploit work on unpatched Nintendo Switch consoles?**
+ A: For more information, please reference [this page](../../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. + - **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 index cdb03d53..451747e8 100644 --- a/docs/user_guide/rcm/sending_payload.md +++ b/docs/user_guide/rcm/sending_payload.md @@ -14,45 +14,45 @@ Now that the device is in RCM, we will need to send it a payload. The methods ar #### **What you need:** - - The latest release of TegraRcmGUI (either the MSI or zip) + - The latest release of [TegraRcmGUI](https://github.com/eliboa/TegraRcmGUI/releases) (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`. + - The latest release of [Hekate](https://github.com/CTCaer/hekate/releases/). 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. + 1. 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. + 1. Connect your Switch in RCM to your PC using the USB cable. + 1. 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. + 1. Press the file button next to `Inject payload`, and navigate to and select the `hekate_ctcaer_X.X.X.bin` file. + 1. Click `Inject payload` to launch the payload you selected. - If your payload was successfully injected your switch should have yellow text that says "Update bootloader folder!", this will be resolved soon. #### **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. + Follow these steps if you face issues when installing the driver with TegraRcmGUI. You will need the latest version of [Zadig](https://zadig.akeo.ie) 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. + 1. Connect your Switch in RCM to your PC using the USB cable. + 1. In Zadig, select "APX" in the device list. + 1. Select `libusbK (v3.1.0.0)` in the driver list. + 1. 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. + - 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`. + - The latest release of [Hekate](https://github.com/CTCaer/hekate/releases/). 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` + 1. Connect your Switch in RCM to your PC using the USB cable. + 1. 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` - If your payload was successfully injected your switch should have yellow text that says "Update bootloader folder!", this will be resolved soon. @@ -62,39 +62,39 @@ Now that the device is in RCM, we will need to send it a payload. The methods ar - 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`. + - The latest release of [Hekate](https://github.com/CTCaer/hekate/releases/). 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. + 1. Connect your Switch in RCM to your PC using the USB cable, make sure it's also detected in CrystalRCM. + 1. 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. + 1. Open the `CrystalRCM.app` app, then click `Payload...` and select the `hekate_ctcaer_X.X.X.bin` file. + 1. Once selected, click `Push!`. The payload should now be injected successfully. - If your payload was successfully injected your switch should have yellow text that says "Update bootloader folder!", this will be resolved soon. === "Android" #### **What you need:** - - The latest release of Rekado + - The latest release of [Rekado](https://github.com/MenosGrante/Rekado/releases) - 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`. + - The latest release of [Hekate](https://github.com/CTCaer/hekate/releases/). 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. + 1. Launch Rekado on your phone. + 1. Navigate to `Payloads` (Signified by a downwards arrow with a line), then press the `+` button at the bottom right. + 1. Navigate to your hekate_ctcaer `.bin` file and tap it to add it to Rekado's menu. + 1. **Optional, but recommended**: Navigate to Rekado's settings in the top right and enable `Hide bundled`. + 1. Connect your Switch in RCM to your phone using the USB cable. + 1. If prompted, grant Rekado access to the Switch. + 1. Select the `hekate_ctcaer_X.X.X.bin` file in the dialog that pops up. - If your payload was successfully injected your switch should have yellow text that says "Update bootloader folder!", this will be resolved soon. === "Chromebook" @@ -108,10 +108,10 @@ Now that the device is in RCM, we will need to send it a payload. The methods ar #### **Instructions:** 1. Go to the injection [website](https://fusee.eiphax.tech/) and scroll all the way down - 2. Open the dropdown menu and select `hekate_ctcaer_X_X_X` from the list. - 3. Connect your Switch in RCM to your Chromebook using the USB cable. - 4. Select "Deliver Payload". A pop-up will appear. Click the `APX` option. - 5. Press the Connect button and the payload will be injected. + 1. Open the dropdown menu and select `hekate_ctcaer_X_X_X` from the list. + 1. Connect your Switch in RCM to your Chromebook using the USB cable. + 1. Select "Deliver Payload". A pop-up will appear. Click the `APX` option. + 1. Press the Connect button and the payload will be injected. - If your payload was successfully injected your switch should have yellow text that says "Update bootloader folder!", this will be resolved soon. !!! danger "If nothing happens after you send the payload" @@ -128,19 +128,19 @@ We will prepare the microSD card for formatting/partitioning before going to the ----- #### **What you need:** -- The latest release of Hekate. +- The latest release of [Hekate](https://github.com/CTCaer/hekate/releases/) - 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. Press any button to continue to the Hekate menu. -9. 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. +1. Insert your microSD card into your computer. +1. Copy the `Nintendo` folder (and any other important data) from the root of your microSD card to a safe space on your device. +1. Extract the Hekate `.zip` to a location on your computer +1. Inside the extracted Hekate folder you will find a folder named `bootloader`. +1. Copy the `bootloader` folder to the root of your microSD card. +1. Put your microSD card back into your Switch. +1. Press any button to continue to the Hekate menu. +1. 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. ![Nyx](../all/img/nyx.bmp){ width="600" } [Continue to choosing your CFW environment :material-arrow-right:](../all/cfw_environment.md){ .md-button .md-button--primary }