diff --git a/404.html b/404.html index 7fbccdce..d1ccc2c9 100644 --- a/404.html +++ b/404.html @@ -17,7 +17,7 @@
- + \ No newline at end of file diff --git a/about.html b/about.html index 31210347..cf52813c 100644 --- a/about.html +++ b/about.html @@ -20,7 +20,7 @@
Skip to content

About this guide

This guide was written by community members of the Nintendo Homebrew Discord Server.

You can find this guide on GitHub, It is licensed under the ISC license.

Guide Writers / Maintainers

Thank you to everyone else that contributed to the guide on GitHub, but special thanks to noirscape.

Developers

TIP

Nintendo Homebrew

  • - + \ No newline at end of file diff --git a/extras/adding_udev.html b/extras/adding_udev.html index cc12a59f..f4b21a03 100644 --- a/extras/adding_udev.html +++ b/extras/adding_udev.html @@ -19,8 +19,8 @@ -
    Skip to content

    Linux - Run payload injector without root

    This section details how to add an udev rule to let you send a payload to your Switch without needing to use sudo.

    The following instructions only work if you have a system that implements udev. Most modern distros come with systemd already installed, which includes a udev implementation.

    Do the following instructions while your Switch is not connected to your computer.

    TIP

    For Arch Linux users:

    The package android-udev includes rules that will also allow for payload injection to work without root. Do note this also allows Android specific commands such as adb and fastboot to also work without root (as is the intention of it.)

    Option 1: Manually adding rules and group

    The following instructions are not for beginners. Only do this if you understand what you are doing.

    Creating a new group

    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.

    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.

    You should now be able to run the payload sender without having to use sudo.

    Option 2: Installing a package with the rules

    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:

    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

    You should now be able to run the payload injector and homebrew with USB communication without having to use sudo.

  • - +
    Skip to content

    Linux - Run payload injector without root

    This section details how to add an udev rule to let you send a payload to your Switch without needing to use sudo.

    The following instructions only work if you have a system that implements udev. Most modern distros come with systemd already installed, which includes a udev implementation.

    Do the following instructions while your Switch is not connected to your computer.

    TIP

    For Arch Linux users:

    The package android-udev includes rules that will also allow for payload injection to work without root. Do note this also allows Android specific commands such as adb and fastboot to also work without root (as is the intention of it.)

    Option 1: Manually adding rules and group

    The following instructions are not for beginners. Only do this if you understand what you are doing.

    Creating a new group

    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.

    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.

    You should now be able to run the payload sender without having to use sudo.

    Option 2: Installing a package with the rules

    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:

    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

    You should now be able to run the payload injector and homebrew with USB communication without having to use sudo.

  • + \ No newline at end of file diff --git a/extras/alternate_bootsetups.html b/extras/alternate_bootsetups.html index 80d9e09e..8863c88d 100644 --- a/extras/alternate_bootsetups.html +++ b/extras/alternate_bootsetups.html @@ -19,8 +19,8 @@ -
    Skip to content

    Alternate boot setups

    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.

    Chainloading Fusee from Hekate

    • The latest release of Hekate
    • The latest release of Atmosphère
      • You will need to download both the release zip and the fusee.bin

    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.
      • 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) if you do use fusee and have an emuMMC.

    Using Fusee without Hekate

    This method will not work for Modchipped Switch users.

    • The latest release of Atmosphère
      • You will need to download both the release zip and the fusee.bin

    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.
      • 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) if you do use fusee and have an emuMMC.
  • - +
    Skip to content

    Alternate boot setups

    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.

    Chainloading Fusee from Hekate

    • The latest release of Hekate
    • The latest release of Atmosphère
      • You will need to download both the release zip and the fusee.bin

    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.
      • 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) if you do use fusee and have an emuMMC.

    Using Fusee without Hekate

    This method will not work for Modchipped Switch users.

    • The latest release of Atmosphère
      • You will need to download both the release zip and the fusee.bin

    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.
      • 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) if you do use fusee and have an emuMMC.
  • + \ No newline at end of file diff --git a/extras/autorcm.html b/extras/autorcm.html index e3d13960..2ea5d4a2 100644 --- a/extras/autorcm.html +++ b/extras/autorcm.html @@ -19,8 +19,8 @@ -
    Skip to content

    AutoRCM

    AutoRCM causes the console to believe it is bricked, and will automatically launch RCM upon boot for recovery purposes, without needing a jig. As RCM is a recovery mode from repair specialists, this is an intended feature from the device developer, though is also considered a softbrick. If you aren't careful, misuse of AutoRCM can lead to real damage, especially with units that cannot inject custom RCM payloads (like Mariko hardware). Please take care when using it. 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 a coldboot.

    • 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.

    1. Boot into Hekate
    2. Go to Tools, and select Backup eMMC
    3. 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.
    • 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.

    Advantages of AutoRCM

    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.
    • 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 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

    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.
      • If you wish to disable it instead, follow these same steps and ensure the AutoRCM option is set to OFF.
  • - +
    Skip to content

    AutoRCM

    AutoRCM causes the console to believe it is bricked, and will automatically launch RCM upon boot for recovery purposes, without needing a jig. As RCM is a recovery mode from repair specialists, this is an intended feature from the device developer, though is also considered a softbrick. If you aren't careful, misuse of AutoRCM can lead to real damage, especially with units that cannot inject custom RCM payloads (like Mariko hardware). Please take care when using it. 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 a coldboot.

    • 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.

    1. Boot into Hekate
    2. Go to Tools, and select Backup eMMC
    3. 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.
    • 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.

    Advantages of AutoRCM

    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.
    • 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 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

    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.
      • If you wish to disable it instead, follow these same steps and ensure the AutoRCM option is set to OFF.
  • + \ No newline at end of file diff --git a/extras/blocking_nintendo.html b/extras/blocking_nintendo.html index f3448f8f..e57d44ec 100644 --- a/extras/blocking_nintendo.html +++ b/extras/blocking_nintendo.html @@ -19,8 +19,8 @@ -
    Skip to content

    Blocking Nintendo servers

    This page will help you set up a method to block all communication with Nintendo. This will stop any updates and reporting to Nintendo, but it will prevent use of the eShop and online games.

    Instructions (AMS DNS redirection)

    You can configure Atmosphère to automatically redirect any requests directed to Nintendo to nothing instead. Documentation about this feature can be found here. The section below will help you set up DNS redirection on your emummc. Note that this will only apply when you are using cfw.

    What you need:

    Setup:

    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.
      • You should end up with the sd:/atmosphere/hosts directory.
    5. 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.

    TIP

    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.

    A report will be generated in sd:/atmosphere/logs called dns_mitm_startup.log. If this starts with the following, the dns redirection is active

    dnsmitmlog

    Instructions (90DNS)

    You can add a custom DNS to your WiFi connection that will block all communication with Nintendo's servers. We will be using 90DNS, a community-run custom DNS server. If you prefer, you can run your own DNS server following the instructions on the GitLab repository.

    Enter the console's System Settings, and then proceed to the Internet tab. From here:

    Setting up a new connection via Wi-Fi

    WARNING

    Open WiFi networks without a password

    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.


    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.


    Using homebrew to set 90DNS on all existing WiFi networks

    1. Download switch-90dns-setter 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.
    LocationPrimary DNSSecondary DNS
    Europe (Server located in France)163.172.141.219207.246.121.77
    America (Server located in the USA)207.246.121.77163.172.141.219

    TIP

    Example for a 90DNS connection with the Europe settings:

    Visual for System Settings serial location

    Testing if you can reach Nintendo

    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.

    Testing via a homebrew app (CFW)

    1. Download the latest release of the 90DNS Tester
    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.

    TIP

    tester example

  • - +
    Skip to content

    Blocking Nintendo servers

    This page will help you set up a method to block all communication with Nintendo. This will stop any updates and reporting to Nintendo, but it will prevent use of the eShop and online games.

    Instructions (AMS DNS redirection)

    You can configure Atmosphère to automatically redirect any requests directed to Nintendo to nothing instead. Documentation about this feature can be found here. The section below will help you set up DNS redirection on your emummc. Note that this will only apply when you are using cfw.

    What you need:

    Setup:

    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.
      • You should end up with the sd:/atmosphere/hosts directory.
    5. 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.

    TIP

    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.

    A report will be generated in sd:/atmosphere/logs called dns_mitm_startup.log. If this starts with the following, the dns redirection is active

    dnsmitmlog

    Instructions (90DNS)

    You can add a custom DNS to your WiFi connection that will block all communication with Nintendo's servers. We will be using 90DNS, a community-run custom DNS server. If you prefer, you can run your own DNS server following the instructions on the GitLab repository.

    Enter the console's System Settings, and then proceed to the Internet tab. From here:

    Setting up a new connection via Wi-Fi

    WARNING

    Open WiFi networks without a password

    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.


    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.


    Using homebrew to set 90DNS on all existing WiFi networks

    1. Download switch-90dns-setter 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.
    LocationPrimary DNSSecondary DNS
    Europe (Server located in France)163.172.141.219207.246.121.77
    America (Server located in the USA)207.246.121.77163.172.141.219

    TIP

    Example for a 90DNS connection with the Europe settings:

    Visual for System Settings serial location

    Testing if you can reach Nintendo

    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.

    Testing via a homebrew app (CFW)

    1. Download the latest release of the 90DNS Tester
    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.

    TIP

    tester example

  • + \ No newline at end of file diff --git a/extras/game_modding.html b/extras/game_modding.html index 099ec2c6..2b64321b 100644 --- a/extras/game_modding.html +++ b/extras/game_modding.html @@ -19,8 +19,8 @@ -
    Skip to content

    Game modding with LayeredFS

    LayeredFS, a tool built into Atmosphere, allows you to (temporarily) replace a game's assets with your own, modified assets as long as you're booted into CFW.

    Usage instructions

    Check the section below to find your mod's folder/file structure, then install your mod accordingly.

    TIP

    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/<title_id>/.
      • 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 and nswdb.
    • 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/<title_id>/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

    In the image below, you can see a Batman skin mod being used in The Legend of Zelda: Breath of the Wild. In this example, the title ID and mod installation directory would be sd:/atmosphere/contents/0100509005AF2000/.

    ExampleGameMod

    Additional notes

    The romfs folder contains modified assets in the way the game would normally read them. romfs stands for "romFileSystem", which is quite literally what the filesystem (folder and file structure) of the game you're modding consists of internally.

    If you want to disable mods on launch of a game, hold the L button before launching the game and launch the game normally, L is the default button to do this. This will disable all modifications (like cheats and mods) that you have configured for your game.

    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 and skyline. 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 or UKMM (Recommended) and TKMM 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.

    Troubleshooting

    My game crashes upon launch!

    If your game crashes during launch, hold the L button to see if disabling all modifications for your game solves the issue. If so, delete the most recently added mod(s) for your game.

    My mods aren't showing up in-game!

    Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files.

    This can be done by booting into Hekate and going to Tools > Arch bit • RCM Touch • Pkg1/2 > Fix Archive Bit.

  • - +
    Skip to content

    Game modding with LayeredFS

    LayeredFS, a tool built into Atmosphere, allows you to (temporarily) replace a game's assets with your own, modified assets as long as you're booted into CFW.

    Usage instructions

    Check the section below to find your mod's folder/file structure, then install your mod accordingly.

    TIP

    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/<title_id>/.
      • 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 and nswdb.
    • 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/<title_id>/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

    In the image below, you can see a Batman skin mod being used in The Legend of Zelda: Breath of the Wild. In this example, the title ID and mod installation directory would be sd:/atmosphere/contents/0100509005AF2000/.

    ExampleGameMod

    Additional notes

    The romfs folder contains modified assets in the way the game would normally read them. romfs stands for "romFileSystem", which is quite literally what the filesystem (folder and file structure) of the game you're modding consists of internally.

    If you want to disable mods on launch of a game, hold the L button before launching the game and launch the game normally, L is the default button to do this. This will disable all modifications (like cheats and mods) that you have configured for your game.

    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 and skyline. 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 or UKMM (Recommended) and TKMM 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.

    Troubleshooting

    My game crashes upon launch!

    If your game crashes during launch, hold the L button to see if disabling all modifications for your game solves the issue. If so, delete the most recently added mod(s) for your game.

    My mods aren't showing up in-game!

    Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files.

    This can be done by booting into Hekate and going to Tools > Arch bit • RCM Touch • Pkg1/2 > Fix Archive Bit.

  • + \ No newline at end of file diff --git a/extras/glossary.html b/extras/glossary.html index b01b5bd2..66bf4e8f 100644 --- a/extras/glossary.html +++ b/extras/glossary.html @@ -19,8 +19,8 @@ -
    Skip to content

    Glossary of common hacking terms

    This section is dedicated to explaining a number of common terms that are used when hacking the Nintendo Switch as well as linking a number of resources that can help fledgling developers or curious users.

    Hacking terms

    The following list is in alphabetical order.

    • 90DNS: DNS that blocks system updates on the Nintendo Switch. This can be enabled by following the guide here.
    • Atmosphère: The CFW developed by the Atmosphere-NX organization on GitHub and the one used in this guide.
    • AutoRCM: A method that corrupts parts of your boot0 and boot1, causing the Switch to boot into RCM automatically. Using this requires an additional peripheral (such as a computer, phone, dongle, or modchip) to be able to boot your Switch.
    • boot0 and boot1: Two partitions of the Switch NAND.
    • bootROM: An initial system loader whose primary purpose is to initialise a device's hardware and prepare it for use. It is also typically responsible for authenticating hardware and software necessary to start the device. A bootROM is a ROM, meaning that it is etched into the device and cannot be rewritten or upgraded without replacing the hardware entirely.
    • CFW: Short for custom firmware. CFW is a collection of patches which partially or largely modify the functionality of the underlying OS. It is not used to refer to the usage of brand new operating systems entirely.
    • Deja Vu: An unreleased exploit chain for the Nintendo Switch. The completely unpatched version of this chain will grant access to TrustZone, which effectively means being able to enter CFW. The TrustZone part of this exploit was patched in firmware version 5.0.0 and up, but normal homebrew access can still be gained up to firmware version 6.0.1.
    • DNS: 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.
    • fusee-gelee/ShofEL2: Two names for two different implementations of the same exploit. 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: Software used to decrypt Nintendo Switch files like .XCI and .NSP files.
    • Hekate: A bootloader for the Nintendo Switch. The current guide uses this in combination with essential files from Atmosphère to boot CFW.
    • Homebrew: Unsigned code that can be ran on the Nintendo Switch. Examples of homebrew include save editors, emulators and ports of PC games, but can also include completely original games. To run this code, you need to have an exploit.
    • Homebrew launcher: Software developed by the Switchbrew team that lets you run other Homebrew.
    • Jig: Refers to a piece of hardware that you can put in the Joycon rail to enter RCM.
    • KIP: Short for Kernel Initial Process. These files can be loaded in when the Switch boots in CFW and provide additional functionality.
    • NAND: Referred to as "Internal Storage" within Nintendo's consoles, this is the storage chip that the console saves the system software and internal settings to. The name refers to the type of logic gate employed, known as "not-AND" in this case.
    • nx-hbloader: Intermediary program used to load the Homebrew Launcher from CFW developed by Switchbrew. Comes bundled with Atmosphere.
    • PRODINFO: A partition on the NAND of your Switch. This along with boot0 and boot1 is the only part of your Switch that can render it unbootable if improperly modified. Atmosphère backs up this partition on booting and it is included in your NAND backup.
    • qLaunch: This is similar to the HOME Menu on the Nintendo 3DS. It serves as a launcher for many applets such as System Settings, the main home menu (ResidentMenu), User/Friends Page (myPage), Lock Screen (Entrance), News menu (Notification), and so on.
    • ReSwitched: A hacking team that is one of the main developers for Atmosphère.
    • RCM: A shorthand for "Recovery Mode". When talking about hacking the Switch, this commonly refers to the Recovery Mode in the Tegra X1 chip that is included in the Nintendo Switch. Can be entered by holding down the Tegra X1 home button. This button is not the same as the home button on the joycons. Ways of pressing this button can be found here.
    • ROM: "Read-only memory"; a section of data that cannot be modified once it is written.
      Some forms of ROM can be rewritten under very specific scenarios, such as EEPROM (electronically-erasable/programmable ROM).
    • TegraRCMGUI/fusee-interface-tk: Software used to run the fusee-gelee exploit on the Switch.
    • Stock: "Stock" generally refers to the original factory operation or state of something.
      For example, stock firmware means the original operation of Horizon, not using CFW.
    • Tegra X1: A chip made by Nvidia that is used in the Nintendo Switch.
    • Trinket: A category of modchip that is soldered on the Switch motherboard to automatically send a payload if it is in RCM. They are not necessarily always the Trinket brand, as this refers to the category of modchip.
    • TrustZone: The highest security level on the Switch.
    • XCI/NSP: Format used to dump games to. XCI is used for gamecard dumps, while NSP is for dumping digital titles.

    Resources

    The resources below are for users and developers interested in developing Homebrew or for those that want to get a more technical understanding of the various concepts.

    • The ReSwitched FAQ lists a general overview of how the Switch works.
    • Switchbrew is a wiki detailing the inner workings of the Nintendo Switch's firmware.
    • libNX documentation. LibNX is the library used to develop Homebrew on the Nintendo Switch.
  • - +
    Skip to content

    Glossary of common hacking terms

    This section is dedicated to explaining a number of common terms that are used when hacking the Nintendo Switch as well as linking a number of resources that can help fledgling developers or curious users.

    Hacking terms

    The following list is in alphabetical order.

    • 90DNS: DNS that blocks system updates on the Nintendo Switch. This can be enabled by following the guide here.
    • Atmosphère: The CFW developed by the Atmosphere-NX organization on GitHub and the one used in this guide.
    • AutoRCM: A method that corrupts parts of your boot0 and boot1, causing the Switch to boot into RCM automatically. Using this requires an additional peripheral (such as a computer, phone, dongle, or modchip) to be able to boot your Switch.
    • boot0 and boot1: Two partitions of the Switch NAND.
    • bootROM: An initial system loader whose primary purpose is to initialise a device's hardware and prepare it for use. It is also typically responsible for authenticating hardware and software necessary to start the device. A bootROM is a ROM, meaning that it is etched into the device and cannot be rewritten or upgraded without replacing the hardware entirely.
    • CFW: Short for custom firmware. CFW is a collection of patches which partially or largely modify the functionality of the underlying OS. It is not used to refer to the usage of brand new operating systems entirely.
    • Deja Vu: An unreleased exploit chain for the Nintendo Switch. The completely unpatched version of this chain will grant access to TrustZone, which effectively means being able to enter CFW. The TrustZone part of this exploit was patched in firmware version 5.0.0 and up, but normal homebrew access can still be gained up to firmware version 6.0.1.
    • DNS: 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.
    • fusee-gelee/ShofEL2: Two names for two different implementations of the same exploit. 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: Software used to decrypt Nintendo Switch files like .XCI and .NSP files.
    • Hekate: A bootloader for the Nintendo Switch. The current guide uses this in combination with essential files from Atmosphère to boot CFW.
    • Homebrew: Unsigned code that can be ran on the Nintendo Switch. Examples of homebrew include save editors, emulators and ports of PC games, but can also include completely original games. To run this code, you need to have an exploit.
    • Homebrew launcher: Software developed by the Switchbrew team that lets you run other Homebrew.
    • Jig: Refers to a piece of hardware that you can put in the Joycon rail to enter RCM.
    • KIP: Short for Kernel Initial Process. These files can be loaded in when the Switch boots in CFW and provide additional functionality.
    • NAND: Referred to as "Internal Storage" within Nintendo's consoles, this is the storage chip that the console saves the system software and internal settings to. The name refers to the type of logic gate employed, known as "not-AND" in this case.
    • nx-hbloader: Intermediary program used to load the Homebrew Launcher from CFW developed by Switchbrew. Comes bundled with Atmosphere.
    • PRODINFO: A partition on the NAND of your Switch. This along with boot0 and boot1 is the only part of your Switch that can render it unbootable if improperly modified. Atmosphère backs up this partition on booting and it is included in your NAND backup.
    • qLaunch: This is similar to the HOME Menu on the Nintendo 3DS. It serves as a launcher for many applets such as System Settings, the main home menu (ResidentMenu), User/Friends Page (myPage), Lock Screen (Entrance), News menu (Notification), and so on.
    • ReSwitched: A hacking team that is one of the main developers for Atmosphère.
    • RCM: A shorthand for "Recovery Mode". When talking about hacking the Switch, this commonly refers to the Recovery Mode in the Tegra X1 chip that is included in the Nintendo Switch. Can be entered by holding down the Tegra X1 home button. This button is not the same as the home button on the joycons. Ways of pressing this button can be found here.
    • ROM: "Read-only memory"; a section of data that cannot be modified once it is written.
      Some forms of ROM can be rewritten under very specific scenarios, such as EEPROM (electronically-erasable/programmable ROM).
    • TegraRCMGUI/fusee-interface-tk: Software used to run the fusee-gelee exploit on the Switch.
    • Stock: "Stock" generally refers to the original factory operation or state of something.
      For example, stock firmware means the original operation of Horizon, not using CFW.
    • Tegra X1: A chip made by Nvidia that is used in the Nintendo Switch.
    • Trinket: A category of modchip that is soldered on the Switch motherboard to automatically send a payload if it is in RCM. They are not necessarily always the Trinket brand, as this refers to the category of modchip.
    • TrustZone: The highest security level on the Switch.
    • XCI/NSP: Format used to dump games to. XCI is used for gamecard dumps, while NSP is for dumping digital titles.

    Resources

    The resources below are for users and developers interested in developing Homebrew or for those that want to get a more technical understanding of the various concepts.

    • The ReSwitched FAQ lists a general overview of how the Switch works.
    • Switchbrew is a wiki detailing the inner workings of the Nintendo Switch's firmware.
    • libNX documentation. LibNX is the library used to develop Homebrew on the Nintendo Switch.
  • + \ No newline at end of file diff --git a/extras/index.html b/extras/index.html index ca2e357d..1d09d92b 100644 --- a/extras/index.html +++ b/extras/index.html @@ -19,8 +19,8 @@ -
    Skip to content

    Extras

    Several extra guides that are not required for basic usage can be found here.

    They are listed in the sidebar as well.

    Commonly used guides:

  • - +
    Skip to content

    Extras

    Several extra guides that are not required for basic usage can be found here.

    They are listed in the sidebar as well.

    Commonly used guides:

  • + \ No newline at end of file diff --git a/extras/installing_android.html b/extras/installing_android.html index 4f2ef1f6..8c9c2833 100644 --- a/extras/installing_android.html +++ b/extras/installing_android.html @@ -19,7 +19,7 @@ -
    Skip to content

    Installing Android

    This page will detail the setup of Switchroot Android (Android 11) for the Nintendo Switch.

    WARNING

    Have you partitioned your microSD card?

    This page assumes that you've followed our guide to set up Atmosphère. Before starting, your microSD card needs partitions for Android set up via Hekate.

    If you didn't do so, see this page to install Android alongside Atmosphère. If you don't want to use Switch CFW and only Android, check the Official Switchroot Documentation instead.

    If you already have Android fully installed, do not follow this guide, as your current installation would be erased.

    INFO

    Looking for Android 10?

    An unfortunate bug with clocking on Android 11 results in degraded performance for Erista (v1) units on Android 11. Android 10 installation is not covered here, but there is a guide on the Switchroot Wiki. However, Android 11 is the currently supported version and uses much more updated drivers.

    INFO

    Looking for Android 14?

    Recently, Android 14 was released for the Switch. You can follow the official LineageOS guide to install Android 14.

    • Note: You can skip the partitioning in the LineageOS guide. You already did this during the guide and do not have to do so again.

    The Switch lacks a cell modem; simply installing Android does not grant your Switch access to cell towers. This means, unlike most Android devices, you will not be able to make emergency phone calls, and you will still need Wi-Fi to access the Internet. You can, however, natively run Android programs and games.

    This page will also not detail things such as rooting and overclocking; external links to these types of additions can be found in the Power User Guides section at the bottom of this page.

    Requirements:

    • A Nintendo Switch console that is capable of running Hekate.
    • A microSD card larger than 8GB.
    • A good quality, data-transfer capable USB-A to USB-C cable.
      • C to C is unstable, but this will be fixed in the next release.
    • A computer.

    Instructions:

    Step 0: Preparation

    If you have official Joy-Con controllers, you can set up auto-pairing so undocking them seamlessly connects to the console regardless of what OS is running. To make this work, boot HOS, ensure both work undocked (pair them), then reboot to Hekate. Select Nyx Options followed by Dump Joy-Con BT. You should see "Found 2 out of 2 Joy-Con pairing data!"

    TIP

    Have a Switch Lite?

    You should poke the dump button in Hekate anyway -- this will dump factory stick and IMU calibration for use in Android.


    Step 1: Downloading Files

    Download the latest .7z release archive from the official Switchroot download site--choose nx-atv... for Android TV (more console-like experience) or nx-tab... for standard Android (a more standard Android tablet experience). Both are usable with controllers and docking, but only tab supports proper touch input.

    TIP

    If you prefer TWRP recovery...

    ...you can download twrp.img from the extras folder.


    Step 2: Arranging the microSD Card

    TIP

    Are you using a V1 or V2 Switch (standard models)?

    These models have a poorly designed microSD card reader and repeated removals/reinsertions can eventually cause the reader to fail. Please use Hekate SD UMS to transfer files instead of removing the microSD card from your Switch!

    • This can be done by booting into Hekate and going to Tools > USB Tools > SD Card and plugging your Switch into your PC via USB.

    Extract the archive to the root of the microSD card (the FAT32 partition). The microSD card file structure should look more or less like this:

    root
    +    
    Skip to content

    Installing Android

    This page will detail the setup of Switchroot Android (Android 11) for the Nintendo Switch.

    WARNING

    Have you partitioned your microSD card?

    This page assumes that you've followed our guide to set up Atmosphère. Before starting, your microSD card needs partitions for Android set up via Hekate.

    If you didn't do so, see this page to install Android alongside Atmosphère. If you don't want to use Switch CFW and only Android, check the Official Switchroot Documentation instead.

    If you already have Android fully installed, do not follow this guide, as your current installation would be erased.

    INFO

    Looking for Android 10?

    An unfortunate bug with clocking on Android 11 results in degraded performance for Erista (v1) units on Android 11. Android 10 installation is not covered here, but there is a guide on the Switchroot Wiki. However, Android 11 is the currently supported version and uses much more updated drivers.

    INFO

    Looking for Android 14?

    Recently, Android 14 was released for the Switch. You can follow the official LineageOS guide to install Android 14.

    • Note: You can skip the partitioning in the LineageOS guide. You already did this during the guide and do not have to do so again.

    The Switch lacks a cell modem; simply installing Android does not grant your Switch access to cell towers. This means, unlike most Android devices, you will not be able to make emergency phone calls, and you will still need Wi-Fi to access the Internet. You can, however, natively run Android programs and games.

    This page will also not detail things such as rooting and overclocking; external links to these types of additions can be found in the Power User Guides section at the bottom of this page.

    Requirements:

    • A Nintendo Switch console that is capable of running Hekate.
    • A microSD card larger than 8GB.
    • A good quality, data-transfer capable USB-A to USB-C cable.
      • C to C is unstable, but this will be fixed in the next release.
    • A computer.

    Instructions:

    Step 0: Preparation

    If you have official Joy-Con controllers, you can set up auto-pairing so undocking them seamlessly connects to the console regardless of what OS is running. To make this work, boot HOS, ensure both work undocked (pair them), then reboot to Hekate. Select Nyx Options followed by Dump Joy-Con BT. You should see "Found 2 out of 2 Joy-Con pairing data!"

    TIP

    Have a Switch Lite?

    You should poke the dump button in Hekate anyway -- this will dump factory stick and IMU calibration for use in Android.


    Step 1: Downloading Files

    Download the latest .7z release archive from the official Switchroot download site--choose nx-atv... for Android TV (more console-like experience) or nx-tab... for standard Android (a more standard Android tablet experience). Both are usable with controllers and docking, but only tab supports proper touch input.

    TIP

    If you prefer TWRP recovery...

    ...you can download twrp.img from the extras folder.


    Step 2: Arranging the microSD Card

    TIP

    Are you using a V1 or V2 Switch (standard models)?

    These models have a poorly designed microSD card reader and repeated removals/reinsertions can eventually cause the reader to fail. Please use Hekate SD UMS to transfer files instead of removing the microSD card from your Switch!

    • This can be done by booting into Hekate and going to Tools > USB Tools > SD Card and plugging your Switch into your PC via USB.

    Extract the archive to the root of the microSD card (the FAT32 partition). The microSD card file structure should look more or less like this:

    root
     |- bootloader
     |  |- ini
     |  |  |- ...
    @@ -37,7 +37,7 @@
     |  |- install
     |  |  |- ...
     |- lineage-18.1-[date]-UNOFFICIAL-[device].zip

    TIP

    If you downloaded TWRP...

    ...you have to replace /switchroot/install/recovery.img with twrp.img. No need to rename the file, just swap it out.


    Step 3: Flashing Android

    Open the Hekate partition manager (located in Tools > Partition SD Card) and select Flash Android at the bottom of your screen. All three images should be found and successfully flashed. Select the option to reboot to recovery.

    Once in recovery, select Factory Reset followed by Format Data. This does not delete anything here, but rather is used to prepare your data partitions for flashing. Ignore any errors that may appear. Return to the main menu and select Apply Update followed by Select from SWITCH SD. Find and select the lineage-18.1... zip in the list, and wait for it to finish.

    WARNING

    Did the zip fail to flash?

    Your microSD card is probably bad... Take a look at Hekate's microSD card info, and consider buying a better card.

    TIP

    If you are using TWRP...

    Good luck... TWRP is for advanced users; no user support will be provided. TWRP is provided for power users who have a specific need for it.

    Once done, reboot the system when prompted -- Android is now installed!

    Post-Install

    Tips and Tricks

    • If Joy-Con autopairing has not kicked in, try a reboot. Sometimes the first boot doesn't pick up the addition.
    • To access recovery/TWRP: hold VOL+ on boot or reboot.
    • To access Hekate from Android: hold VOL- on reboot.
    • To reboot back to Android: hold Power for a few seconds and perform a standard reboot.
    • To return to Horizon (OFW/CFW): power your Switch off fully, then boot into your desired mode.

    Power User Guides

    To learn more about using the Switch Configuration App and overclocking, see the Switch Configuration App section. Furthermore, you can check out the INI guide as well.

    Need Help?

    Join the Switchroot Discord server.


    This page was made in collaboration with makinbacon21 on Discord. See the collapsible section below for the Switchroot guide maintainers.

    Switchroot Project Staff (Android / Linux)

    If you'd like, you can donate to the people who made this project possible using these links.

  • - + \ No newline at end of file diff --git a/extras/installing_linux.html b/extras/installing_linux.html index dbe6486a..e995fc2a 100644 --- a/extras/installing_linux.html +++ b/extras/installing_linux.html @@ -19,8 +19,8 @@ -
    Skip to content

    Installing Linux 4 Switch

    WARNING

    Have you partitioned your microSD card?

    This guide assumes that you've followed the NH-Server guide up until this point, your microSD card should be partitioned accordingly. If you didn't do so, see this page of our guide.

    Linux 4 Switch is a sister project to Switchroot Android--it uses a similar kernel but provides a variety of Linux distributions.The available distributions at this time are:

    • Ubuntu Bionic (maintained by CTCaer, the primary dev of both the L4S kernel and hekate--this is the most stable and supported distro)
    • Ubuntu Jammy (maintained by theofficialgman, one of the primary devs of the L4T Megascript installer program)
    • Fedora 39 (maintained by azkali, a L4S kernel developer)
    • Lakka 5.x (maintained by gavin_darkglider, a L4S kernel developer and Lakka maintainer)

    INFO

    Looking for Arch?

    Unfortunately, L4S Arch Linux is deprecated following an xorg ABI change that breaks compatibility with the Tegra210 BSP.

    The installation

    To install an L4S distribution, follow the official guide starting from 0. Linux Distributions.

    • Note: You can skip partitioning your microSD card since you partitioned your microSD card during the NH-Server guide. Start from step 4. during the Installation section.

    This page was made in collaboration with makinbacon21 on Discord. See the collapsible section below for the L4S guide maintainers.

    L4S Project Staff (Android / Linux)

    If you'd like, you can donate to the people who made this project possible using these links.

  • - +
    Skip to content

    Installing Linux 4 Switch

    WARNING

    Have you partitioned your microSD card?

    This guide assumes that you've followed the NH-Server guide up until this point, your microSD card should be partitioned accordingly. If you didn't do so, see this page of our guide.

    Linux 4 Switch is a sister project to Switchroot Android--it uses a similar kernel but provides a variety of Linux distributions.The available distributions at this time are:

    • Ubuntu Bionic (maintained by CTCaer, the primary dev of both the L4S kernel and hekate--this is the most stable and supported distro)
    • Ubuntu Jammy (maintained by theofficialgman, one of the primary devs of the L4T Megascript installer program)
    • Fedora 39 (maintained by azkali, a L4S kernel developer)
    • Lakka 5.x (maintained by gavin_darkglider, a L4S kernel developer and Lakka maintainer)

    INFO

    Looking for Arch?

    Unfortunately, L4S Arch Linux is deprecated following an xorg ABI change that breaks compatibility with the Tegra210 BSP.

    The installation

    To install an L4S distribution, follow the official guide starting from 0. Linux Distributions.

    • Note: You can skip partitioning your microSD card since you partitioned your microSD card during the NH-Server guide. Start from step 4. during the Installation section.

    This page was made in collaboration with makinbacon21 on Discord. See the collapsible section below for the L4S guide maintainers.

    L4S Project Staff (Android / Linux)

    If you'd like, you can donate to the people who made this project possible using these links.

  • + \ No newline at end of file diff --git a/extras/nandrestore.html b/extras/nandrestore.html index 6ffa7d2c..1adbb216 100644 --- a/extras/nandrestore.html +++ b/extras/nandrestore.html @@ -19,8 +19,8 @@ -
    Skip to content

    Restore a NAND backup to the Switch

    WARNING

    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.
    • 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 Discord server.
    • The Hekate Payload
    • A microSD card larger than 32GB

    Instructions:

    Before we start, check if you have a tree of folders called backup/[8 Character NAND id]/restore on your 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.

    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. Enter RCM and inject the Hekate payload.
      • If you use a modchipped Switch, you can simply just turn your Switch on with the Hekate payload renamed to payload.bin on the root of your SD.
    2. Navigate to Tools > USB Tools > SD Card and plug your Switch into your PC via USB.
    3. Copy your rawnand.bin (combined or in 15 or 30 parts), BOOT0, and BOOT1 to the backup/[8 Character NAND id]/restore folder on the microSD card.
    4. Eject the UMS device safely from within your computer's operating system.
    5. Navigate to Tools > Restore eMMC. Select Restore eMMC BOOT0 & BOOT1. Wait for this process to complete.
    6. In that same menu, select eMMC RAW GPP and wait for the process to complete.
      • This will generally take a long time to complete, the time it takes depends on your microSD card's specifications. (10-15 minutes is expected.)

    DANGER

    If you're downgrading using your NAND backup

    If the security version you were on before you performed the NAND restore is HIGHER than the NAND backup itself, you have to enable autoRCM to not get stuck in a boot crash.

    • Note: This section can be disregarded for modchipped Switch users.

    A system update is considered a security version when a fuse is burned, you can check which versions burn fuses here.

    If you were in AutoRCM before you upgraded to a newer security version (and still were after the upgrade) you don't have to do this.

    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.
  • - +
    Skip to content

    Restore a NAND backup to the Switch

    WARNING

    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.
    • 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 Discord server.
    • The Hekate Payload
    • A microSD card larger than 32GB

    Instructions:

    Before we start, check if you have a tree of folders called backup/[8 Character NAND id]/restore on your 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.

    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. Enter RCM and inject the Hekate payload.
      • If you use a modchipped Switch, you can simply just turn your Switch on with the Hekate payload renamed to payload.bin on the root of your SD.
    2. Navigate to Tools > USB Tools > SD Card and plug your Switch into your PC via USB.
    3. Copy your rawnand.bin (combined or in 15 or 30 parts), BOOT0, and BOOT1 to the backup/[8 Character NAND id]/restore folder on the microSD card.
    4. Eject the UMS device safely from within your computer's operating system.
    5. Navigate to Tools > Restore eMMC. Select Restore eMMC BOOT0 & BOOT1. Wait for this process to complete.
    6. In that same menu, select eMMC RAW GPP and wait for the process to complete.
      • This will generally take a long time to complete, the time it takes depends on your microSD card's specifications. (10-15 minutes is expected.)

    DANGER

    If you're downgrading using your NAND backup

    If the security version you were on before you performed the NAND restore is HIGHER than the NAND backup itself, you have to enable autoRCM to not get stuck in a boot crash.

    • Note: This section can be disregarded for modchipped Switch users.

    A system update is considered a security version when a fuse is burned, you can check which versions burn fuses here.

    If you were in AutoRCM before you upgraded to a newer security version (and still were after the upgrade) you don't have to do this.

    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.
  • + \ No newline at end of file diff --git a/extras/rcm_injectors.html b/extras/rcm_injectors.html index d94a6c05..679288b7 100644 --- a/extras/rcm_injectors.html +++ b/extras/rcm_injectors.html @@ -19,8 +19,8 @@ -
    Skip to content

    RCM Payload Injectors

    There are currently multiple RCM payload injectors available from multiple different companies and individuals. These devices remove the need to use a computer or smartphone when hacking an unpatched Switch. Each injector has its own advantages and disadvantages, listed below:

    NameManufacturerRCM Jig Included?RCM Jig Storage?Standard Payload (.bin) Support?Payload on SD Support?Multi-Payload Support?Battery LifeRecharge TimePrice (USD)Misc Info
    AceNS (Old)Ace3DS Team✔️✔️✔️N/A (Capacitors)10 seconds$18.00​ (Discontinued)Not Recommended: Overpriced clone of the RCMLoader Zero
    AceNS (New)Ace3DS Team✔️️ ✔️✔️✔️45mAh LiPo (~1000 injections)1 hour$17.50Not Recommended: Overpriced clone of the RCMLoader One
    AceNS ProAce3DS Team✔️✔️✔️✔️ (Required)45mAh LiPo (~1000 injections)1 hour$42.90Not Recommended: Overpriced clone of the RCMLoader One with multiple features missing
    DragonInjectorMatinatorX✔️✔️✔️✔️ (Required)✔️40mAh CR1612 (~4000 injections)Non-Rechargeable (Replacable)$30.00​ (Discontinued)Fits in the Switch's gamecard slot
    NS-AtmosphereGeneric✔️✔️150mAh LiPo (>1000 injections)>1 hour$13.15Not Recommended: Unsafe jig, overly bulky, changing payload requires installing a program, lack of .bin support complicates usage
    R4SR4i-SDHC Team✔️✔️✔️120mAh LiPo (~1000 injections)1 hour$19.99
    RCMLoader ZeroXkit✔️✔️️ ✔️N/A (Capacitors)10 seconds$5.99​ (Discontinued)
    RCMLoader OneXkit✔️✔️✔️✔️45mAh LiPo (~1000 injections)1 hour$9.99
    SX GearTeam Xecuter✔️✔️ (Required)N/A (Supercapacitors)5-10 seconds$24.95Not Recommended: Lack of .bin support complicates usage
    SX ProTeam Xecuter✔️✔️ (Required)N/A (Supercapacitors)5-10 seconds$49.99Not Recommended: Lack of .bin support complicates usage
  • - +
    Skip to content

    RCM Payload Injectors

    There are currently multiple RCM payload injectors available from multiple different companies and individuals. These devices remove the need to use a computer or smartphone when hacking an unpatched Switch. Each injector has its own advantages and disadvantages, listed below:

    NameManufacturerRCM Jig Included?RCM Jig Storage?Standard Payload (.bin) Support?Payload on SD Support?Multi-Payload Support?Battery LifeRecharge TimePrice (USD)Misc Info
    AceNS (Old)Ace3DS Team✔️✔️✔️N/A (Capacitors)10 seconds$18.00​ (Discontinued)Not Recommended: Overpriced clone of the RCMLoader Zero
    AceNS (New)Ace3DS Team✔️️ ✔️✔️✔️45mAh LiPo (~1000 injections)1 hour$17.50Not Recommended: Overpriced clone of the RCMLoader One
    AceNS ProAce3DS Team✔️✔️✔️✔️ (Required)45mAh LiPo (~1000 injections)1 hour$42.90Not Recommended: Overpriced clone of the RCMLoader One with multiple features missing
    DragonInjectorMatinatorX✔️✔️✔️✔️ (Required)✔️40mAh CR1612 (~4000 injections)Non-Rechargeable (Replacable)$30.00​ (Discontinued)Fits in the Switch's gamecard slot
    NS-AtmosphereGeneric✔️✔️150mAh LiPo (>1000 injections)>1 hour$13.15Not Recommended: Unsafe jig, overly bulky, changing payload requires installing a program, lack of .bin support complicates usage
    R4SR4i-SDHC Team✔️✔️✔️120mAh LiPo (~1000 injections)1 hour$19.99
    RCMLoader ZeroXkit✔️✔️️ ✔️N/A (Capacitors)10 seconds$5.99​ (Discontinued)
    RCMLoader OneXkit✔️✔️✔️✔️45mAh LiPo (~1000 injections)1 hour$9.99
    SX GearTeam Xecuter✔️✔️ (Required)N/A (Supercapacitors)5-10 seconds$24.95Not Recommended: Lack of .bin support complicates usage
    SX ProTeam Xecuter✔️✔️ (Required)N/A (Supercapacitors)5-10 seconds$49.99Not Recommended: Lack of .bin support complicates usage
  • + \ No newline at end of file diff --git a/extras/showing_file_extensions.html b/extras/showing_file_extensions.html index 7bf1e915..0914f532 100644 --- a/extras/showing_file_extensions.html +++ b/extras/showing_file_extensions.html @@ -19,8 +19,8 @@ -
    Skip to content

    Showing File Name Extensions on Windows 10/11

    By default, Microsoft Windows 10 and 11 do not show file extensions for known file types. This can result in problems when you need to rename files.

    Instructions for Windows 10:

    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.

    Instructions for Windows 11:

    1. Open a new File Explorer window.
    2. Click the View hamburger menu/dropdown menu.
    3. Go to Show at the bottom and ensure that File name extensions is ticked.

    TIP

    Visual for the above instructions

  • - +
    Skip to content

    Showing File Name Extensions on Windows 10/11

    By default, Microsoft Windows 10 and 11 do not show file extensions for known file types. This can result in problems when you need to rename files.

    Instructions for Windows 10:

    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.

    Instructions for Windows 11:

    1. Open a new File Explorer window.
    2. Click the View hamburger menu/dropdown menu.
    3. Go to Show at the bottom and ensure that File name extensions is ticked.

    TIP

    Visual for the above instructions

  • + \ No newline at end of file diff --git a/extras/transfer_sd.html b/extras/transfer_sd.html index 3a19944e..d007efd1 100644 --- a/extras/transfer_sd.html +++ b/extras/transfer_sd.html @@ -19,8 +19,8 @@ -
    Skip to content

    Changing microSD cards

    The goal of this page is to transfer the contents from one microSD card to another one. The method to do this will differ, depending on whether you're using a partition based emuMMC on your microSD card or not.

    We will be using hekate to both backup and restore the emuMMC, so make sure that you have its latest files on your microSD card already.

    Instructions:

    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.
      • If you have one it should be either SD Raw Partition or SD File.

    If you are using a file based emuMMC or are using no emuMMC at all:

    1. 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. 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.
    6. Copy the files from your PC or directly from your old microSD card to your new microSD card.
    7. Eject the UMS device safely from within your computer's operating system.

    If you are using a partition based emuMMC:

    WARNING

    Space for the backup

    You need at least 30GB (or 60GB if using an OLED Switch) of free space to be able to restore the 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 (Unpatched Switch users only) to prepare your new SD card with Hekate's files.
      • If you have a modchipped Switch, follow this page instead.
    8. Follow only steps 1-3 on this page to partition the new microSD card for an emuMMC setup.
    9. After it’s done, boot into Hekate and navigate to Tools > USB Tools > SD Card, then plug your Switch into your PC via USB.
    10. Copy the backup you made of your old microSD card on your PC to your new microSD card.
    11. Navigate to /backup/<some characters>/emummc on your microSD card and move BOOT0, BOOT1 and the rawnand.bin.xx files to /backup/<some characters>/restore/emummc.
    12. Eject the UMS device safely from within your computer's operating system.
    13. Tap on Tools, Restore eMMC, set SD emuMMC Raw Partition at the bottom of your screen to ON.
    14. 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.
    15. 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.
  • - +
    Skip to content

    Changing microSD cards

    The goal of this page is to transfer the contents from one microSD card to another one. The method to do this will differ, depending on whether you're using a partition based emuMMC on your microSD card or not.

    We will be using hekate to both backup and restore the emuMMC, so make sure that you have its latest files on your microSD card already.

    Instructions:

    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.
      • If you have one it should be either SD Raw Partition or SD File.

    If you are using a file based emuMMC or are using no emuMMC at all:

    1. 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. 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.
    6. Copy the files from your PC or directly from your old microSD card to your new microSD card.
    7. Eject the UMS device safely from within your computer's operating system.

    If you are using a partition based emuMMC:

    WARNING

    Space for the backup

    You need at least 30GB (or 60GB if using an OLED Switch) of free space to be able to restore the 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 (Unpatched Switch users only) to prepare your new SD card with Hekate's files.
      • If you have a modchipped Switch, follow this page instead.
    8. Follow only steps 1-3 on this page to partition the new microSD card for an emuMMC setup.
    9. After it’s done, boot into Hekate and navigate to Tools > USB Tools > SD Card, then plug your Switch into your PC via USB.
    10. Copy the backup you made of your old microSD card on your PC to your new microSD card.
    11. Navigate to /backup/<some characters>/emummc on your microSD card and move BOOT0, BOOT1 and the rawnand.bin.xx files to /backup/<some characters>/restore/emummc.
    12. Eject the UMS device safely from within your computer's operating system.
    13. Tap on Tools, Restore eMMC, set SD emuMMC Raw Partition at the bottom of your screen to ON.
    14. 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.
    15. 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.
  • + \ No newline at end of file diff --git a/extras/updating.html b/extras/updating.html index 313b002c..20b41e40 100644 --- a/extras/updating.html +++ b/extras/updating.html @@ -19,8 +19,8 @@ -
    Skip to content

    Keeping your system up-to-date

    This page documents how you can keep your system up-to-date.

    After following our guide, your system will consist of three core elements that can be updated. Atmosphere, Hekate and your system firmware.

    Updating Atmosphere

    When updating Atmosphère, always make sure to read the release notes. They may list important changes and modifications to your system.

    WARNING

    Updating from below Atmosphère 1.0.0

    If you update from below Atmosphère 1.0.0, there are additional steps to follow. You will have to delete the sept folder from your microSD, delete fusee-secondary.bin from your atmosphere folder and update your Hekate config file: hekate_ipl.ini in the bootloader folder.

    When a new version of Atmosphère releases, you can update Atmosphère 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 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.
      • 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.

    Updating Hekate

    When updating Hekate always make sure to read the release notes. They may list important changes and modifications to your system.

    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.

    Updating your firmware

    Always check before updating your system firmware if the latest version of Atmosphère as well as the latest version of Hekate support the firmware version you are updating towards.

    In addition, updating to or past some firmwares update the gamecard firmware. Reference the table below for information about these.

    Updating fromUpdating towardsUpdates gamecard firmware
    Below 4.0.0Below 4.0.0No
    Below 4.0.04.0.0 or aboveYes
    On or above 4.0.0, but below 9.0.0At least 4.0.1 but below 9.0.0No
    On or above 4.0.0, but below 9.0.09.0.0 or aboveYes
    On or above 9.0.0, but below 11.0.0At least 9.0.1 but below 11.0.0No
    On or above 9.0.0, but below 11.0.011.0.0 or aboveYes
    On or above 11.0.0 but below 12.0.0At least 11.0.1 but below 12.0.0No
    On or above 11.0.0 but below 12.0.012.0.0 or aboveYes
    On or above 12.0.0 but below 14.0.0At least 12.0.1 but below 13.2.1No
    On or above 12.0.0 but below 14.0.014.0.0 or aboveYes
    On or above 14.0.0Latest supported Atmosphère & Hekate revisionNo

    If at least one of the versions you are updating towards also updates the gamecard firmware, you will not be able to downgrade below that version without making the gamecard slot unusable until you update.

    Atmosphere (and Hekate) come bundled with patches that automatically disable the gamecard slot if it is detected that the system has an older gamecard firmware that would be updated. If you boot into RCM on each boot (for example by using AutoRCM), this means that the gamecard slot will not be updated and you can downgrade below that version. If this happens, you will not be able to use the gamecard slot as long as you are on the newer firmware.

    Otherwise, you can safely update your system firmware through the system settings.

    WARNING

    Note about autoRCM

    If you have autoRCM enabled and you're updating your system while in stock firmware, updating will disable autoRCM and you will need to enter RCM manually to boot custom firmware again.

    To prevent autoRCM from being disabled, boot CFW on sysMMC and update through settings from there, as booting without AutoRCM will burn any preserved fuses.

    About emuMMC

    sysMMC and emuMMC have separate system firmwares and need to be updated separately.

    If you keep your emuMMC offline, you will have to use a gamecard to update your system firmware, synchronize it with another Nintendo Switch or dump an updated firmware from your sysMMC.

    Updating emuMMC by dumping an updated firmware from your sysMMC

    WARNING

    Do you have an eMMC backup yet?

    Please do not start this guide without doing a RAW GPP and a BOOT 0/1 eMMC backup!

    You can learn how to make one here.

    DANGER

    Downgrading

    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:

    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.

    Make sure your sysMMC is updated before moving onto the instructions below.

    Dumping your sysMMC firmware

    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).
      • 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.
      • 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.

    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/<latest firmware number>.
    5. 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.
  • - +
    Skip to content

    Keeping your system up-to-date

    This page documents how you can keep your system up-to-date.

    After following our guide, your system will consist of three core elements that can be updated. Atmosphere, Hekate and your system firmware.

    Updating Atmosphere

    When updating Atmosphère, always make sure to read the release notes. They may list important changes and modifications to your system.

    WARNING

    Updating from below Atmosphère 1.0.0

    If you update from below Atmosphère 1.0.0, there are additional steps to follow. You will have to delete the sept folder from your microSD, delete fusee-secondary.bin from your atmosphere folder and update your Hekate config file: hekate_ipl.ini in the bootloader folder.

    When a new version of Atmosphère releases, you can update Atmosphère 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 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.
      • 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.

    Updating Hekate

    When updating Hekate always make sure to read the release notes. They may list important changes and modifications to your system.

    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.

    Updating your firmware

    Always check before updating your system firmware if the latest version of Atmosphère as well as the latest version of Hekate support the firmware version you are updating towards.

    In addition, updating to or past some firmwares update the gamecard firmware. Reference the table below for information about these.

    Updating fromUpdating towardsUpdates gamecard firmware
    Below 4.0.0Below 4.0.0No
    Below 4.0.04.0.0 or aboveYes
    On or above 4.0.0, but below 9.0.0At least 4.0.1 but below 9.0.0No
    On or above 4.0.0, but below 9.0.09.0.0 or aboveYes
    On or above 9.0.0, but below 11.0.0At least 9.0.1 but below 11.0.0No
    On or above 9.0.0, but below 11.0.011.0.0 or aboveYes
    On or above 11.0.0 but below 12.0.0At least 11.0.1 but below 12.0.0No
    On or above 11.0.0 but below 12.0.012.0.0 or aboveYes
    On or above 12.0.0 but below 14.0.0At least 12.0.1 but below 13.2.1No
    On or above 12.0.0 but below 14.0.014.0.0 or aboveYes
    On or above 14.0.0Latest supported Atmosphère & Hekate revisionNo

    If at least one of the versions you are updating towards also updates the gamecard firmware, you will not be able to downgrade below that version without making the gamecard slot unusable until you update.

    Atmosphere (and Hekate) come bundled with patches that automatically disable the gamecard slot if it is detected that the system has an older gamecard firmware that would be updated. If you boot into RCM on each boot (for example by using AutoRCM), this means that the gamecard slot will not be updated and you can downgrade below that version. If this happens, you will not be able to use the gamecard slot as long as you are on the newer firmware.

    Otherwise, you can safely update your system firmware through the system settings.

    WARNING

    Note about autoRCM

    If you have autoRCM enabled and you're updating your system while in stock firmware, updating will disable autoRCM and you will need to enter RCM manually to boot custom firmware again.

    To prevent autoRCM from being disabled, boot CFW on sysMMC and update through settings from there, as booting without AutoRCM will burn any preserved fuses.

    About emuMMC

    sysMMC and emuMMC have separate system firmwares and need to be updated separately.

    If you keep your emuMMC offline, you will have to use a gamecard to update your system firmware, synchronize it with another Nintendo Switch or dump an updated firmware from your sysMMC.

    Updating emuMMC by dumping an updated firmware from your sysMMC

    WARNING

    Do you have an eMMC backup yet?

    Please do not start this guide without doing a RAW GPP and a BOOT 0/1 eMMC backup!

    You can learn how to make one here.

    DANGER

    Downgrading

    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:

    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.

    Make sure your sysMMC is updated before moving onto the instructions below.

    Dumping your sysMMC firmware

    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).
      • 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.
      • 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.

    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/<latest firmware number>.
    5. 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.
  • + \ No newline at end of file diff --git a/faq.html b/faq.html index d9965766..e4050b05 100644 --- a/faq.html +++ b/faq.html @@ -20,7 +20,7 @@
    Skip to content

    FAQ

    What firmware versions are currently hackable?

    Currently two hardware revisions of the Switch exist. Any Switch bought or manufactured before the middle of 2018 has a bootrom bug that allows us to run code regardless of the firmware version on the Switch. When Nintendo updates the system, however, CFW will usually need an update to account for it. This bug cannot be fixed by Nintendo once the console leaves the factory, unless the console is sent in for repairs. This means that all current and future firmwares will be able to launch CFW through this exploit on the old hardware revision.

    Any console purchased after approximately August 2018 is likely to be patched. This includes the latest units on shelves, referred to as 'red box' or 'Mariko'. Mariko is hardware patched, but may come on a vulnerable firmware. 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? 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.

    How do I use fusee-gelee? How can I boot into RCM?

    To launch CFW through the fusee-gelee, the Switch needs to be in "ReCovery Mode"(RCM). The easiest way to enter RCM is by grounding pin 10 in the right joycon rail and holding VOL+ on boot. Several methods and designs to do this exist, see our guide for more information. Once the Switch is in RCM it needs to be connected to either a computer, phone or dongle to send the exploit and the payload.

    This procedure needs to happen every time the Switch boots from a completely "off" state, otherwise the Switch will boot into the stock firmware.

    What makes a good jig good? Can I use a paperclip?

    Most people prefer to use 3d-printed jigs to enter RCM. These jigs are made in a way that they slide into the right joycon rail and have a piece of connected wire that then bridges pin 10 and one of the grounded pins on the Switch. A lot of different designs for these jigs exist, but it is important to understand, that these jigs can damage the Switch if they are made in a bad way.

    Since the wire in the jig is supposed to touch the pads inside the Switch's joycon rail, it is important to use wire that is thin, not rigid and bent/not pointy. Paperclips make for potentially dangerous jigs, as they are made out of a hard material, are rigid and pointy and can easily scratch off the pads inside the Switch. A good jig uses 32Gauge(0.2mm diameter) wire and is bent in a way that the end of the wire does not scratch the pads. You can download and 3d-print your own jig and use the pictures on this website to guide you on how to bend the wire correctly. Premade jigs can be found on online marketplaces for cheap.

    Is there an easier way to enter RCM?

    To enter RCM more comfortably a solution called "AutoRCM" exists. Once set up, this method will always boot the Switch into RCM, even without a jig or holding any buttons. This works by "bricking" the Switch in a controlled manner. The Switch detects that something is wrong and boots into RCM to get repaired. The big downside of this method is, that it is impossible to boot the Switch without a computer, phone or dongle, as it will never boot into stock firmware by itself, and that it requires an SD card with the proper CFW files on it at all times. In addition, if the battery of the Switch is completely drained, the Switch will need to charge to at least 10% in Hekate before launching Atmosphere, otherwise the Switch will refuse to boot due to the low battery. Charging in RCM is not recommended as this is very slow. AutoRCM can be reversed, but it is advised to keep a working NAND and BOOT0/1 backup before using it.

    Many Android-phones are able to send the exploit to the Switch, making them a perfect portable way to launch CFW. Different designs for portable dongles exist, ranging from Raspberry Pi Zero and Arduino projects to internal dongles, that work completely autonomous. The latter should only be done by advanced users, as it requires soldering onto the Switch mainboard itself.

    Should I update my Firmware?

    If your Switch is one of the new hardware revisions that patched the exploit in RCM and you are on firmware 7.0.1 or lower, you should not update if you want to have CFW in the forseeable future.

    If your Switch is one of the older hardware revisions and you don't mind having to use jigs/hardmods/AutoRCM and sending the exploit via computer, phone or dongle everytime you want to launch into CFW then it is completely safe to update. If you want the chance to maybe, one day, not have to use a external device, then it is recommended to stay on a FW as low as possible. Beware that this means that you potentially need to wait for a very long time (months to years) for this to happen, if ever. Private exploits to launch CFW over the Browser are known to exist for firmwares up to 7.0.1.

    Downgrading on the Switch is possible, but it requires using AutoRCM and a custom bootloader payload to bypass the Switch's several hardware anti-downgrade mechanisms. This will not work on an unpatched system, and is practically useless for most users. On every boot the Switch firmware checks how many e-fuses have been burned and how many e-fuses the Switch expects to be burned. Major updates to the Switch, or updates in which a large vulnerability has been patched, irreversibly burn one of the Switch's 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. 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.

    • "New" Switch (HAC-001(-01): Do NOT update past 8.0.1. Units on 8.0.1 and below will likely get homebrew. Units on 8.1.0 and higher are not expected to be hacked and can be updated.

    • Switch Lite (HDH-001): Do NOT update past 8.0.1. Units on 8.0.1 and below will likely get homebrew. Units on 8.1.0 and higher are not expected to be hacked and can be updated.

    A method to update without burning e-fuses exists, but, like downgrading, it forces you to use AutoRCM and sending the exploit via USB every time, as booting into the stock firmware even once would instantly burn the e-fuse. Note that other anti-downgrade mechanisms exist, making it for example impossible to boot game carts on a firmware below 4.1/9.0.0 if the Switch has ever launched a game on firmware 4.1+/9.0.0+. This can only be worked around by completely disabling the game cart slot while on 4.1/9.0.0 or greater, which is similarly impractical for most users.

    Is it safe to use homebrew? Will I get banned?

    The Switch comes with a lot of telemetry, and has been called a "telemetry monster" by several prominent developers. As long as the Switch is connected to the internet, Nintendo gets a report about a lot of different actions and states and has the option to log or act on them. Even if the Switch is offline and connects to the internet at a later point, Nintendo still recieves information about what happened while the Switch was disconnected.

    To disable some of this telemetry, it is advised to disable the sending of error reports in the System Settings of the Switch. Additionally if you live in the EU you can set the "do not share" option on Nintendo's website 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. They have also shown to expand their telemetry options with every other firmware update.

    WARNING

    Currently all bans have been for very obvious and intrusive actions, specifically:

    • Developers using their unique Switch data to poke and reverse-engineer Nintendos Server responses
    • People pirating games and using them online
    • People changing their profile pictures to custom pictures
    • People using savegame editors to unlock content that is not available yet and using it online (Splatoon 2)
    • People cheating online in general (Modifying Cart stats in MK8)
    • People installing homebrew NSP files, which Nintendo can pick up on with their telemetry

    Atmosphère stops some, but not all of Nintendo's telemetry, and prevents crash reports from being sent. This means Nintendo can't tell if anything, including homebrew or modded games crashed, and Atmosphère dumps the crash log to the microSD card to help homebrew developers. However, Nintendo still receives information about what is being played, and general system report information.

    Atmosphère is not a silver bullet, and this does not mean that Nintendo won't decide to ban people for harmless homebrew in the future. If you are scared to get banned then don't use homebrew for now. Atmosphère now supports emuMMC (emuNAND): a copy of Switch system software, run entirely from the microSD card instead. This erases ban risks due to the fact that emuMMC is run in a quarantined, offline state, not touching the internal memory. You are still able to boot into original firmware to play online.

    For patched units reliant on deja-vu, sysNAND will always have to be on a firmware below 4.1. For Switch versions from 5.0 to 7.0.1 deja-vu isn't quite out yet but will come eventually. (Also please note that firmwares 8.0.0+ will never work with deja-vu) You can use an updated emuMMC dedicated to online/clean play, while your sysNAND is used offline for custom firmware.

    We do not recommend the use of ReiNX or SX OS for many reasons, primary among them that they use lots of assets from Atmosphère and offer no real benefit that Atmosphère does not offer anyway. We also do not recommend Kosmos, as its large amount of extras on top of regular Atmosphère make it difficult to troubleshoot strange issues. All of these alternative CFWs also tend to use non-conventional setups which can cause issues that make it difficult to troubleshoot, which is another reason we prefer using Atmosphere. Additionally, it is advised to use 90DNS which blocks connections to any Nintendo servers. If you use an emuNAND for CFW and keep your sysNAND clean for playing online, you should use 90DNS on your emuNAND. Note: Keeping your emuNAND "dirty" and your sysNAND "clean" pertains primarily to those using the RCM exploit. Users employing Nereba or Caffeine will do the opposite.

    What formats can homebrew come in

    Homebrew can come in two different formats, namely in nro files and in bin files.

    • nro Files are placed in the switch folder on your microSD card and can be launched using the Homebrew menu.
    • bin This format is used as a payload and is to be pushed in RCM using a payload launcher like tegrarcmgui on windows and fusee-interfacee-tk on other operating systems.

    Homebrew risksBe careful with launching downloaded homebrew! If you don't know the source, it's best not to launch it.Homebrew can potentially damage your system! Atmosphère provides protections against common bricking methods, but these are not guaranteed to always work!

    What microSD card/format should I use?

    microSD cards that are 32GB or smaller can be used for homebrew, but are not recommended as these will not permit you to have a full NAND dump and/or an emuMMC on them.

    The recommended microSD card size is 128GB. This will permit you to make a full NAND dump as well as having enough space to run an emuNAND in the future while also having adequate space for homebrew.

    The recommended filesystem format is FAT32. While the Switch supports exFAT through an additional update from Nintendo, this filesystem is prone to corruption and as a result is not advisable.

    Fake microSD cards

    Do not buy microSD cards from sites like eBay. These microSD cards are often fake and do not have the advertised amount of storage and will result in data corruption if used. 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.

    My Homebrew apps are not showing up in the Homebrew menu!

    This is an issue primarily affecting macOS users, but may occur on other devices as well. If you are able to launch the homebrew menu, but you are not seeing some or any of your Homebrew apps, you may need to unset the archive bit with Hekate.

    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 to launch Atmosphere.
  • - + \ No newline at end of file diff --git a/fusee_gelee.html b/fusee_gelee.html index 5c9eecdf..cb632fde 100644 --- a/fusee_gelee.html +++ b/fusee_gelee.html @@ -181,7 +181,7 @@ sudo python3 ./fusee-launcher.py fusee.bin ```

    If everything functions correctly, your Switch should be displaying a collection of fuse and protected-IROM information:

    exploit working

    In this case, the recommended mitigation is to correct the USB control request handler such that it always correctly constrains the length to be transmitted. This has to be handled according to the type of device:

    • For a device already in consumer hands, no solution is proposed. Unfortunately, access to the fuses needed to configure the device's ipatches was blocked when the ODM_PRODUCTION fuse was burned, so no bootROM update is possible. It is suggested that consumers be made aware of the situation so they can move to other devices, where possible.
    • For new devices, the correct solution is likely to introduce an new ipatch or new ipatches that limits the size of control request responses.

    It seems likely that OEMs producing T210-based devices may move to T214 solutions; it is the hope of the author that the T214's bootROM shares immunity with the T186. If not, patching the above is a recommended modification to the mask ROM and/or ipatches of the T214, as well.

  • - + \ No newline at end of file diff --git a/homebrew/edizon.html b/homebrew/edizon.html index dfedc1b8..1718e2fe 100644 --- a/homebrew/edizon.html +++ b/homebrew/edizon.html @@ -20,7 +20,7 @@
    Skip to content

    Games cheats

    EdiZon

    For cheats management, EdiZon and/or EdiZon-SE (up to date and offers more features) are recommended. They offer support for Atmosphere's cheat engine, providing an easy way to download new cheats, as well as toggle them on or off.

    Installation requirements:

    • An archive manager like 7-Zip
    • The latest release of EdiZon (the EdiZon.nro file) or EdiZon-SE (the EdiZon.zip file)

    TIP

    EdiZon overlay

    EdiZon also offers a Tesla-Menu overlay, however, the official EdiZon overlay is no longer maintained and will result in Atmosphere crashing when trying to use the EdiZon overlay on firmware version 16.0.0+.

    The maintained EdiZon overlay can be found here.

    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. 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.

    Usage instructions

    Atmosphère looks for cheats to load in the contents sub-folder of the atmosphere folder. The template it looks for is sd:/atmosphere/contents/<title_id>/cheats/<build_id>.txt. You need to create the <title_id> folder and sub-folders manually:

    • title_id being the title or program of a game. This is game specific and can be found on EdiZon's cheat menu (TID and BID, see the bottom of this page for a sample), switchbrew and nswdb.
      • Note: Title ID means the same thing as Program ID.
    • build_id being the version of a game. This is game specific and can be found on EdiZon's cheat menu (BID, see the bottom of this page for a sample) Cheats can be version specific so make sure the cheats you are using are compatible with your game version.

    Note: On Atmosphère 0.9.4 and below contents is called titles.

    Once the title is launched while in Atmosphere, your cheats should be applied.

    Preventing cheats from being enabled by default

    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.
      • Make sure you remove the space and the semicolon "; " in front of dmnt_cheats_enabled_by_default.

    By default, holding the L button while launching a game will disable any game modification.

    Here the Title ID of the game (TID) is 0100646009FBE000 and the Build ID of the game (BID) is 0B9A75586BC1A6C6. Cheats are loaded from sd:/atmosphere/contents/0100646009FBE000/cheats/0B9A75586BC1A6C6.txt in this example.

    ExampleGameCheat

    Additional information:

    For more in-depth details about Atmosphere's cheat engine, you can refer to this page.

    Troubleshooting

    EdiZon isn't showing up when I open the Homebrew menu!:

    Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files.

    This can be done by booting into Hekate and going to Tools > Arch bit • RCM Touch • Pkg1/2 > Fix Archive Bit.

  • - + \ No newline at end of file diff --git a/homebrew/ftpd.html b/homebrew/ftpd.html index c3351787..e6773644 100644 --- a/homebrew/ftpd.html +++ b/homebrew/ftpd.html @@ -20,7 +20,7 @@
    Skip to content

    FTPD

    FTPD is simply an FTP server for the Switch, it can be used to transfer files wirelessly to- and from- your microSD card.

    Usage requirements:

    • An FTP client such as WinSCP (Windows)
    • Any device that can connect to an FTP server with an FTP client

    Usage instructions:

    TIP

    Note

    This section assumes that the device running the FTP client and your Switch are connected to the same network. If it's not, make sure they are connected to the same network before continuing.

    1. Launch the FTPD Homebrew app from the Homebrew menu.
    2. Open your FTP client of choice.
    3. Add a new connection and in the Host field of your FTP client, put in the IP address of your Switch mentioned in the top left of FTPD.
      • If applicable in your FTP client, check the Anonymous box.
    4. Type in port 5000 for the port and attempt to connect to your Switch.
    5. You should now be able to access your microSD card wirelessly and transfer files to- and from- the microSD card.

    FTPD's main menu:

    FTPD

    Additional information:

    FTPD can also run in the form of a background process (sysmodule), called sys-ftpd. It can be found here, usage and configuration options are mentioned there as well.

  • - + \ No newline at end of file diff --git a/homebrew/goldleaf.html b/homebrew/goldleaf.html index 1b30f027..56151712 100644 --- a/homebrew/goldleaf.html +++ b/homebrew/goldleaf.html @@ -20,7 +20,7 @@
    Skip to content

    Goldleaf

    Goldleaf is primarily a very extensive file and console content manager.

    Common use cases for Goldleaf are:

    • Account management
    • Browsing your microSD card
    • Browsing the partitions of the internal storage
    • Enabling access to the built-in Switch web browser
    • Export Switch firmware
    • Restoring games to their base game versions
    • File management

    And a lot more, which you can view on Goldleaf's Github repository here.

    Goldleaf screenshots:

    main menu

  • - + \ No newline at end of file diff --git a/homebrew/index.html b/homebrew/index.html index 8cb9856e..8ab19d01 100644 --- a/homebrew/index.html +++ b/homebrew/index.html @@ -20,7 +20,7 @@
    Skip to content

    Information

    This page summarizes the included Homebrew apps and additional Homebrew you can check out.

    The guide includes a few Homebrew apps by default, these apps are:

    Terminologies

    Homebrew is a general term, the term can be used for Homebrew apps (.nro files) or in the form of background processes, called "sysmodules". The Switch natively has sysmodules built into its firmware but you can run additional Homebrew sysmodules that can add functionality to your Switch. In the section below, you can find additional and commonly used Homebrew apps and sysmodules.

    Homebrew apps are stored in sd:/switch by default and Homebrew sysmodules are stored in sd:/atmosphere/contents by default.

    Additional Homebrew apps/sysmodules:

  • - + \ No newline at end of file diff --git a/homebrew/jksv.html b/homebrew/jksv.html index 61a29103..61c07236 100644 --- a/homebrew/jksv.html +++ b/homebrew/jksv.html @@ -20,7 +20,7 @@
    Skip to content

    Save Management

    JKSV

    For save management, JKSV is recommended. It can be used to back up and restore game saves to your microSD card.

    Backing up save data using JKSV

    Instructions:

    1. Launch JKSV from the homebrew menu.
    2. Select your Switch user on the left side with the A button.
    3. Select your desired game and press A to select it.
    4. Press A again to create a new save backup
    5. Enter a name for the save data folder containing the save data and press + or OK.
    6. Wait for it to finish backing up your save data.

    Restoring save data using JKSV

    Instructions:

    1. Launch JKSV from the homebrew menu.
    2. Select your Switch user on the left side with the A button.
    3. Select your desired game and press A to select it.
    4. Hover over the save data folder containing the save data you want and press Y.
    5. Hold the A button to restore the save data, keep holding it until it's finished.

    JKSV Documentation

    Please read JKSV's homepage for information on how to use it.

    ExampleSwitchTheme

    Checkpoint

    Checkpoint is also a save manager. It can be used to back up and restore game saves to your microSD card. It also has the ability to share save data over FTP and WiFi.

    Checkpoint Documentation

    Please read Checkpoint's homepage for information on how to use it.

    ExampleSwitchTheme

  • - + \ No newline at end of file diff --git a/homebrew/ldn_mitm.html b/homebrew/ldn_mitm.html index 976a4db0..7eaffad9 100644 --- a/homebrew/ldn_mitm.html +++ b/homebrew/ldn_mitm.html @@ -20,7 +20,7 @@
    Skip to content

    Information

    ldn_mitm is a sysmodule that allows you to route the local wireless ad-hoc network traffic of the Switch via the network your Switch is connected to, essentially allowing "LAN" functionality between consoles and emulators using ldn_mitm. The official Github repository for ldn_mitm can be found here.

    Common use cases for ldn_mitm:

    • It can be used in combination with lan-play
    • It can be used in combination with XLink Kai
    • It can be used in combination with real Switch consoles and emulators

    Installation requirements:

    • An archive manager like 7-Zip
    • The latest release of ldn_mitm (the ldn_mitm.zip file)

    Installation instructions:

    1. Boot into Hekate and go to Tools > USB Tools > SD Card, then plug your Switch into your PC via USB.
    2. Your microSD card should now be accessible on your PC, open it.
    3. Extract the .zip file to a location on your computer.
      • If your archive manager allows for it, you can also simply open the .zip file directly.
    4. Copy the contents of the (extracted) .zip file to the root of your microSD card.
      • Optional: You can verify if you've installed ldn_mitm correctly, you should have a folder called 4200000000000010 (ldn_mitm) in sd:/atmosphere/contents and the ldnmitm_config.nro file in sd:/switch/ldnmitm_config.
    5. Boot into CFW.

    Basic usage instructions

    You can enable/disable ldn_mitm by opening the Homebrew menu, opening ldn_mitm's config app and pressing Y to toggle ldn_mitm.

    ldn_mitm

    Troubleshooting

    My Switch crashes on boot after I installed ldn_mitm!:

    Cause: If your Switch crashes with Error std::abort (0xFFE) and Title ID 4200000000000010, you're using a version of ldn_mitm that's incompatible with your Atmosphere version. The expected Atmosphere version is mentioned on each release page of an ldn_mitm release.

    ldn_mitm isn't working!:

    Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files.

    This can be done by booting into Hekate and going to Tools > Arch bit • RCM Touch • Pkg1/2 > Fix Archive Bit.

  • - + \ No newline at end of file diff --git a/homebrew/mission-control.html b/homebrew/mission-control.html index 9197b060..8cfd50b6 100644 --- a/homebrew/mission-control.html +++ b/homebrew/mission-control.html @@ -20,7 +20,7 @@
    Skip to content

    MissionControl

    MissionControl is a sysmodule that allows you to pair normally-unsupported controllers as if they were natively supported, like PS3, PS4, PS5 and Xbox One S/X controllers via Bluetooth. The full supported controller list can be found on the official Github repository here including pairing instructions for the supported controllers.

    Installation requirements:

    • An archive manager like 7-Zip
    • The latest release of MissionControl (the MissionControl-(version)-master.zip file)

    Installation instructions:

    1. Boot into Hekate and go to Tools > USB Tools > SD Card, then plug your Switch into your PC via USB.
    2. Your microSD card should now be accessible on your PC, open it.
    3. Extract the .zip file to a location on your computer.
      • If your archive manager allows for it, you can also simply open the .zip file directly.
    4. Copy the contents of the (extracted) .zip file to the root of your microSD card.
      • Optional: You can verify if you've installed MissionControl correctly, you should have a folder called 010000000000BD00 (MissionControl) in sd:/atmosphere/contents.
    5. Boot into CFW.

    Troubleshooting

    My Switch crashes on boot after I installed MissionControl!:

    Cause: If your Switch crashes with Error std::abort (0xFFE) and Title ID 010000000000BD00, you're using a version of MissionControl that's incompatible with your Atmosphere version. The expected Atmosphere version is mentioned on each release page of a MissionControl release.

    MissionControl isn't working!:

    Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files.

    This can be done by booting into Hekate and going to Tools > Arch bit • RCM Touch • Pkg1/2 > Fix Archive Bit.

  • - + \ No newline at end of file diff --git a/homebrew/nx-shell.html b/homebrew/nx-shell.html index 0e24088f..82620c8e 100644 --- a/homebrew/nx-shell.html +++ b/homebrew/nx-shell.html @@ -20,7 +20,7 @@
    Skip to content

    NX-Shell

    NX-Shell is a file manager.

    Common use cases for NX-Shell

    • Copying files
    • Moving files
    • Deleting files
    • View properties of files and folders
    • Create new folders
    • Create new files
    • Set the archive bit on files and folders

    For more information, you can check out NX-Shell's Github repository here.

    NX-Shell screenshots:

    nx-shell-main

    nx-shell-menu

  • - + \ No newline at end of file diff --git a/homebrew/nxtheme-installer.html b/homebrew/nxtheme-installer.html index e0af355a..0377b28a 100644 --- a/homebrew/nxtheme-installer.html +++ b/homebrew/nxtheme-installer.html @@ -20,7 +20,7 @@
    Skip to content

    Theming

    Using NXTheme Installer, you can install and create unique styles and layouts for your Switch Home Menu.

    Index

    Installing a theme

    TIP

    Community Themes

    If you want to use community made themes, for example from the r/NXThemes subreddit or Themezer, you can follow the guide below to install a community provided .nxtheme file.

    What you need:

    Instructions:

    1. Download NXThemesInstaller.nro and put it in sd:/switch.
    2. 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.
    3. 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 on how to install them manually.
    4. 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.
    5. 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).
    6. Reboot into CFW via the Reboot tab to see the changes.

    TIP

    An example of a Home Menu theme being installed

    ExampleSwitchTheme

    Making a theme

    What you need:

    The latest release of Switch Theme Injector

    • You need to download the ReleaseVx.x.zip on the download page

    Making the theme

    1. Unzip ReleaseVx.x.zip to somewhere on your PC's drive.
    2. Open up the SwitchThemes.exe app. Navigate to NXTheme Builder.
    3. Select a Home menu part, A 720p image and a Layout patch. Click on Build NXTheme after selecting your home menu part, image and layout patch.
    4. Fill out the details in the window that pops up. After filling out this window and clicking ok, you will get asked where to save the NXTheme file. Save this file to a temporary folder.
    5. Repeat step 3 and 4 for every Home Menu part of the Switch you want to modify.

    Making the theme

    Make sure that the images you want to use are 1280x720 and in JPG!

    1. Navigate to Exelix's Web Injector.
    2. Select a Theme Target you want to edit. After this, click the Open an Image button and select your background image.
    3. Choose a theme name and an author name and optionally a different layout, then click build NxTheme.
    4. Your browser will prompt you to download a file. Save this file to a temporary folder.
    5. Repeat step 2 to 4 for every Home Menu part of the Switch you want to modify.

    Installing a custom font

    1. Put a font with the .ttf file type into the themes folder (It is recommended you put them into their own folders, e.g. sd:/themes/cool_font/font.ttf).
    2. Boot into sysCFW/emuMMC, launch the Homebrew Menu and launch NXThemes Installer.
    3. You should now see the main menu of NXTheme Installer, the Themes tab is where you will find your font(s).
    4. Install your desired font by selecting the .ttf file in the font folder you created.
    5. Reboot into CFW via the Reboot tab to see the changes.

    Troubleshooting

    My Switch crashes on boot after I installed a theme!:

    Cause 1: You didn't install the required theme patches for your firmware version. You can remove your installed custom theme data by navigating to sd:/atmosphere/contents and deleting the 01000000000001000 folder.

    Cause 2: You didn't extract your home menu data when prompted. You can remove your installed custom theme data by navigating to sd:/atmosphere/contents and deleting the 01000000000001000 folder.

    Cause 3: You installed a bad theme. You can remove them by navigating to sd:/atmosphere/contents and deleting the 01000000000001000 folder.

    • Note: contents is called titles on Atmosphère versions 0.9.4 and below.

    My Switch crashes on boot after I installed a font!:

    Cause 1: You installed a font that was too large in file size (maximum file size being 1.9MB). You can remove your installed custom font data by navigating to sd:/atmosphere/contents and deleting the 0100000000000811 folder.

    Cause 2: You installed a font that wasn't the right file type (e.g. .otf). You can remove your installed custom font data by navigating to sd:/atmosphere/contents and deleting the 0100000000000811 folder.

    • Note: contents is called titles on Atmosphère versions 0.9.4 and below.

    The NXTheme installer crashes when I launch it:

    This is probably due to the archive bit being set on either the app or the .nxtheme files. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files.

    This can be done by booting into Hekate and going to Tools > Arch bit • RCM Touch • Pkg1/2 > Fix Archive Bit.

  • - + \ No newline at end of file diff --git a/homebrew/simplemodmanager.html b/homebrew/simplemodmanager.html index 50e2285c..b90c8784 100644 --- a/homebrew/simplemodmanager.html +++ b/homebrew/simplemodmanager.html @@ -20,7 +20,7 @@
    Skip to content

    SimpleModManager

    SimpleModManager is a homebrew app that allows easily adding and removing mods to the layeredFS directory from another directory on the SD card.

    Common use cases for SimpleModManager:

    • Switching between large modpacks
    • Enabling and disabling individual mods

    WARNING

    What NOT to use SimpleModManager for.

    SimpleModManager should not be used for some specific games like Super Smash Bros. Ultimate and The Legend of Zelda: Breath of the Wild and Tears of the Kingdom. This is due to how these games handle mods differently from others.

    Installation requirements:

    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.

    Usage instructions:

    1. Create a directory named mods/<game name>/<mod name>/ 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 page, skipping the atmosphere folder inside the <mod name> folder.
    3. Launch SimpleModManager via the Homebrew Menu and your games will show up, pressing A on them will show the mods available.

    ExampleSwitchThemeExampleSwitchTheme

  • - + \ No newline at end of file diff --git a/homebrew/sys-botbase.html b/homebrew/sys-botbase.html index 073ecb30..2394a9f9 100644 --- a/homebrew/sys-botbase.html +++ b/homebrew/sys-botbase.html @@ -20,7 +20,7 @@
    Skip to content

    sys-botbase

    sys-botbase is an advanced sysmodule that allows users to interact with their Switch remotely, to "remote control" their Switch. This remote control allows users to create automated tasks, simulate button presses, simulate touchscreen input and read/write to the memory of the Switch while in-game.

    Common use cases for sys-botbase:

    • Use ACNHPokerCore in combination with ACNH
    • Controlling a game remotely
    • Automation

    Installation requirements:

    • An archive manager like 7-Zip
    • The latest release of sys-botbase (the sys-botbase(version).zip file)

    Installation instructions:

    1. Boot into Hekate and go to Tools > USB Tools > SD Card, then plug your Switch into your PC via USB.
    2. Your microSD card should now be accessible on your PC, open it.
    3. Extract the .zip file to a location on your computer.
      • If your archive manager allows for it, you can also simply open the .zip file directly.
    4. Copy the contents of each (extracted) .zip file to the root of your microSD card.
      • Optional: You can verify if you've installed sys-botbase correctly, you should have a folder called 430000000000000B (sys-botbase) in sd:/atmosphere/contents.
    5. Boot into CFW.

    Troubleshooting

    My Switch crashes on boot after I installed sys-botbase!:

    Cause: While it's almost impossible for this to happen, if your Switch crashes with Error 2001-0123 (0xf601) and Title ID 430000000000000B, you're using a version of sys-botbase that's incompatible with your Atmosphere version.

    • Note: sys-botbase will almost never crash unless something is fundamentally wrong with the contents of your microSD card. If it does crash and need an update, an updated release will be mentioned here.

    sys-botbase isn't working!:

    Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files.

    This can be done by booting into Hekate and going to Tools > Arch bit • RCM Touch • Pkg1/2 > Fix Archive Bit.

  • - + \ No newline at end of file diff --git a/homebrew/sys-clk.html b/homebrew/sys-clk.html index 9a2fae4d..d58ca466 100644 --- a/homebrew/sys-clk.html +++ b/homebrew/sys-clk.html @@ -20,7 +20,7 @@
    Skip to content

    sys-clk

    sys-clk is a sysmodule that allows you to overclock the hardware of your Switch. The usage, configuration and clock speed information can be found on the official Github repository here

    DANGER

    Limits of sys-clk

    sys-clk has limits for a reason, which is to not damage the hardware of your Switch. Using any modified version of sys-clk puts your Switch at risk of hardware failure. We do not support any modified version of sys-clk nor should you ever touch them. Overclocking is not something you should be doing 24/7 as overclocking in general will always degrade/wear out the hardware of your Switch faster and you should know what you're doing if you do decide to do so.

    Installation requirements:

    • An archive manager like 7-Zip
    • The latest release of sys-clk (the sys-clk-(version).zip file)

    Installation instructions:

    1. Boot into Hekate and go to Tools > USB Tools > SD Card, then plug your Switch into your PC via USB.
    2. Your microSD card should now be accessible on your PC, open it.
    3. Extract the .zip file to a location on your computer.
      • If your archive manager allows for it, you can also simply open the .zip file directly.
    4. Copy the contents of the (extracted) .zip file to the root of your microSD card.
      • Optional: You can verify if you've installed sys-clk correctly, you should have a folder called 00FF0000636C6BFF (sys-clk) in sd:/atmosphere/contents.
    5. Boot into CFW.

    Basic usage instructions

    Open the Homebrew menu and open sys-clk's manager app. This app allows you to change the global clock speeds or clock speeds based on title.

    Troubleshooting

    My Switch crashes on boot after I installed sys-clk!:

    Cause: If your Switch crashes on boot, make sure you're using the latest release of sys-clk. If it continues to crash afterwards, see the troubleshooting step at the bottom of this page.

    My Switch crashes while using sys-clk!:

    Cause: You're either using a modified version of sys-clk and pushing the hardware of your Switch too far or your console is overheating. The cooling system of the Switch is not the best and overheating can be a cause of dried up thermal paste/lack of thermal paste. Overclock with caution and be careful, monitor the temperatures of your Switch using a Tesla-Menu overlay like Status-Monitor-Overlay (requires Tesla-Menu).

    sys-clk isn't working!:

    Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files.

    This can be done by booting into Hekate and going to Tools > Arch bit • RCM Touch • Pkg1/2 > Fix Archive Bit.

  • - + \ No newline at end of file diff --git a/homebrew/sys-con.html b/homebrew/sys-con.html index b5886235..95e10c66 100644 --- a/homebrew/sys-con.html +++ b/homebrew/sys-con.html @@ -20,7 +20,7 @@
    Skip to content

    sys-con

    sys-con is a sysmodule that allows you to use normally-unsupported controllers as if they were natively supported, like PS3, PS4, PS5 and Xbox One S/X controllers via USB. The full supported feature and controller list can be found on the official Github repository here including usage instructions and configuration options.

    Installation requirements:

    • An archive manager like 7-Zip
    • The latest release of sys-con (the sys-con-(version).zip file)

    Installation instructions:

    1. Boot into Hekate and go to Tools > USB Tools > SD Card, then plug your Switch into your PC via USB.
    2. Your microSD card should now be accessible on your PC, open it.
    3. Extract the .zip file to a location on your computer.
      • If your archive manager allows for it, you can also simply open the .zip file directly.
    4. Copy the contents of the (extracted) .zip file to the root of your microSD card.
      • Optional: You can verify if you've installed sys-con correctly, you should have a folder called 690000000000000D (sys-con) in sd:/atmosphere/contents.
    5. Boot into CFW.

    Troubleshooting

    My Switch crashes on boot after I installed sys-con!:

    Cause: While it's almost impossible for this to happen, if your Switch crashes with Error code 2162-0002 (0x4a2) and Title ID 690000000000000D, you're using a version of sys-con that's incompatible with your Switch firmware version. The expected firmware version is mentioned on each release page of a sys-con release.

    • Note: sys-con hasn't needed an update for years as of the moment of writing this. If it does need an update, an updated release will be mentioned here.

    sys-con isn't working!:

    Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files.

    This can be done by booting into Hekate and going to Tools > Arch bit • RCM Touch • Pkg1/2 > Fix Archive Bit.

  • - + \ No newline at end of file diff --git a/homebrew/sysdvr.html b/homebrew/sysdvr.html index 502a9c4c..8615b209 100644 --- a/homebrew/sysdvr.html +++ b/homebrew/sysdvr.html @@ -20,7 +20,7 @@
    Skip to content

    SysDVR

    SysDVR is a sysmodule that allows you to stream the screen of your Switch (while in-game/in an application) to your PC via the network or USB.

    Usage

    Installation, usage, configuration and extensive troubleshooting information can be found on the SysDVR Wiki.

    SysDVR screenshots:

    sysdvr

    sysdvr

    sysdvr

  • - + \ No newline at end of file diff --git a/homebrew/tesla-menu.html b/homebrew/tesla-menu.html index 9036e26a..101f0b9c 100644 --- a/homebrew/tesla-menu.html +++ b/homebrew/tesla-menu.html @@ -22,7 +22,7 @@
    Skip to content

    Tesla-Menu

    Tesla-Menu is an overlay menu developed by WerWolv, Tesla-Menu is comparable to Rosalina menu on the 3DS and its purpose is to be able to load community made overlays for Homebrew apps and sysmodules that can be accessed at any time. Below you can find common use cases for Tesla-Menu. The official Github page for Tesla-Menu can be found here.

    TIP

    Dependencies

    Tesla-Menu is dependent on a sysmodule called nx-ovlloader, this sysmodule is responsible for loading ovlmenu.ovl from sd:/switch/.overlays.

    Common use cases for Tesla-Menu:

    • Load community made Tesla-Menu overlays
    • Viewing the temperatures/clock speeds of your hardware
    • Editing sysmodule configs on the fly (if applicable)
    • Editing Homebrew app configs on the fly (if applicable)
    • Toggling cheats easily
    • Toggling sysmodules

    Installation requirements:

    • An archive manager like 7-Zip
    • The latest release of Tesla-Menu (the ovlmenu.zip file)
    • The latest release of nx-ovlloader (the nx-ovlloader.zip file)

    Installation instructions:

    1. Boot into Hekate and go to Tools > USB Tools > SD Card, then plug your Switch into your PC via USB.
    2. Your microSD card should now be accessible on your PC, open it.
    3. Extract both .zip files to a location on your computer.
      • If your archive manager allows for it, you can also simply open the .zip files directly.
    4. Copy the contents of each (extracted) .zip file to the root of your microSD card.
      • Optional: You can verify if you've installed Tesla-Menu and nx-ovlloader correctly, you should have a folder called 420000000007E51A (nx-ovlloader) in sd:/atmosphere/contents and the ovlmenu.ovl (Tesla-Menu) file in sd:/switch/.overlays.
    5. Boot into CFW.

    Opening Tesla-Menu

    Tesla-Menu can be opened by pressing L + R Stick press (R3) + DPAD down, assuming you use the default configuration.

    tesla

    Changing the button combination

    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:
      [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.

    Commonly used Tesla-Menu overlays

    Troubleshooting

    My Switch crashes on boot after I installed Tesla-Menu/nx-ovlloader!:

    Cause: If your Switch crashes with Error code 2001-0123 (0xf601) and Title ID 420000000007E51A, you didn't successfully install Tesla-Menu or you aren't using the latest release of Tesla-Menu, re-follow the installation instructions above.

    My Switch crashes when I open an overlay via Tesla-Menu!:

    Cause: If your Switch crashes with Error code 2001-0123 (0xf601) and Title ID 420000000007E51A, the overlay you're trying to open/use isn't up to date. Check its source repository for updates.

    • If this overlay doesn't have an updated release, you may have to look for a forked (updated) release or compile it yourself using the latest libtesla library. The latter is for developers (or advanced users).

    Tesla-Menu is only showing while on the main menu and not in-game!:

    Cause: This issue will only happen when the Switch is docked, ensure that you've set the "Screen size" in System Settings > TV Output to 100%. Adjust your TV/monitor to fit the entirety of the screen of your Switch using its OSD (On Screen Display) or remote.

    Tesla-Menu isn't opening when I press the correct button combination!:

    Assuming you've followed the installation instructions successfully, this is probably due to the archive bit being set on one or more folders/files on your microSD card. This is usually the result of copying files to a microSD card via a Mac. If you are experiencing this issue, try running the archive bit fixer utility via Hekate for all files.

    This can be done by booting into Hekate and going to Tools > Arch bit • RCM Touch • Pkg1/2 > Fix Archive Bit.

  • - + \ No newline at end of file diff --git a/index.html b/index.html index aa4ca9a0..75bca27f 100644 --- a/index.html +++ b/index.html @@ -20,7 +20,7 @@
    Skip to content

    NH Switch Guide

    A collaboration from Nintendo Homebrew's Discord community, getting you from a stock Switch to Atmosphère.

    TIP

    Prepare to set aside a minimum of an hour to follow this guide. This is specifically for you to carefully read and understand each page for safe execution for the safety and longevity of your Switch console. Some required device backups can also take around ten to thirty minutes to create, depending on your Switch model and your microSD card specifications.

    What is Custom Firmware?

    Custom FirmWare (“CFW”) is complex software that modifies the function of a device's operating system, also known as a system firmware. Atmosphère, for example, patches the Switch OS (named Horizon) on the fly.

    Custom firmware can be considered a holy grail in terms of device modding, as it allows nearly limitless control and freedoms than you would get with more primitive "userland" access.  

    What is homebrew?

    Homebrew refers to unofficial software written by hobbyists for locked down systems, like the Nintendo Switch. Homebrew can include original games, emulators, save-editing tools, and much, much more!

    On the Switch in particular, you need CFW to run almost all available homebrew. Some first-gen ("V1") consoles can run homebrew for free, while all other ("patched") consoles require specialized hardware installation beforehand.  

    What are custom operating systems?

    Custom operating systems (OSes) are alternative system software installations, like Android or Linux, that install alongside the default Switch OS. These are usually perfect for powerusers who want to extend the functionality of their console beyond that of a gaming console, transforming Nintendo Switch to a full-fledged hybrid tablet or desktop. These custom OSes run completely independent of the Switch OS, meaning that anything you do in a custom OS cannot be reported back to Nintendo. Custom operating systems are not "emulated"; they run natively on the Switch's Tegra X1 SoC.

    This guide will give you the opportunity to set aside space on your microSD to install these custom OSes onto, if you desire. It is important to note that these installations are optional; you do not need to install any custom OS in order to complete this guide and install Atmosphère. However, it is better to decide sooner rather than later, as the installation process involves formatting your microSD card.

    What does this guide install?

    This guide has the end-goal of taking a completely unmodified Switch from stock firmware to a custom firmware named Atmosphère.

    fusee-gelee is currently the most widespread software entrypoint of launching custom firmware. It utilizes a vulnerability in the bootROM of the first-generation Switch systems, allowing us to boot the console via any payload we choose, instead of only ones that Nvidia and Nintendo authorize. The result allows full baremetal control over your console, including system storage backups, recovery, custom firmwares, and custom operating systems.  

    What can I do with custom firmware?

    • Customize your HOME Menu with user-created themes and splash screens
    • Run “ROM hacks” for games that you own
    • Backup, edit, and restore saves for many games
    • Play games for older systems with various emulators, using RetroArch or other standalone emulators
    • Safely update to the latest system version without fear of losing access to homebrew
    • Safely customise your device while retaining full access to Nintendo online services

    More on this can be found later on in the guide.

    What do I need to know before starting?

    As previously mentioned, this guide will take a minimum of an hour to fully complete. Please responsibly set aside this time before your first run-through.

    Acknowledge that EVERY time you modify your system, there is always the potential for an UNRECOVERABLE brick. A brick is a damaged device that no longer functions; something that becomes as "useful as a brick". On the Switch, they're rare, but still a possibility -- so make sure you read the directions carefully before performing them, and follow them EXACTLY.

    This guide will work on first-generation (V1) and modchipped Switch consoles in all regions on any firmware version.

    TIP

    You will need one of the following in order to successfully follow this guide:

    • A PC, and a USB-C cable capable of data transfer to connect them together
    • An Android device, and a USB-C cable capable of data transfer to connect them together
      • This does not work on every Android phone
    • A Lightning OTG adapter, a jailbroken iOS device, and a USB cable, all capable of data transfer to connect everything together
      • This method is not covered by the guide, but you can read more about it at this website
    • A successfully modchipped Switch

    If you choose the emuMMC path introduced later in the guide, you will also need a microSD card that is at least 128 gigabytes. In this path, it'll be important to disable the Automatic Save Data Cloud function beforehand, as well as making sure the Switch is set as the primary console.

    If you must use a smaller microSD card, you can choose to use the sysCFW path, after assuming the risks involved.

    Additionally, on a V1 "unpatched" Switch, you will need a way to access the ReCovery Mode (this will be further explained in the "Entering RCM section"). While possible with household tools, you may want to shell money out for a "jig" that inserts into the Joy-Con rail to reliably enable RCM.

    Upon completion, you will lose no data, ending up with everything that you started with (games, Nintendo Account, saves, etc will be preserved). Your functionalities will only be enhanced.

    Keep your device plugged in and charged throughout the entire process to avoid data loss or damage from an unexpected power-off.

    Custom firmware is not permanently installed and does not change anything on your console simply by running it. It will be entirely unloaded upon rebooting the console. However, CFW does allow you to make permanent changes to your console at your own will, so be responsible and cautious with the abilities enabled by CFW.

    It is advised that you read the entire guide from start to finish one or more times before actually running through the guide with your system.

    If something doesn't make sense while you follow the guide, please reach out and ask for clarification rather than fumble around on your own. If your English isn't the best, use a translator such as Google Translate to submit your questions, so we can help.


    Note: We are not currently, historically, or will we ever be, associated with Anton Retro, sthetix, Ely M., or other derivative or YouTube/TikTok guide publishers, especially any that claim relation to us.

    Furthermore, we resent any implication to the contrary.

    Frequently Asked Questions about this page
    • Q: What are the differences between "first-generation" ("V1") consoles and "patched" consoles when it comes to running homebrew?

      A: Once you boot into Horizon, not much. The primary things to keep in mind is that only V1 consoles support Atmosphère's "Reboot to Payload" function, but modchips automatically load payloads during reboots on their own.

    • Q: What is Horizon?

      A: Horizon is the name of the Switch's operating system. It is sometimes called "HorizonNX", because it is actually a derivative version of the Nintendo 3DS's operating system of the same name.

    • Q: Why is it called Atmosphère?

      A: Atmosphère "runs on top of the Horizon" operating system. Each layer of Horizon's security is referenced via the atmosphere's different layers. For example, the EL1 "kernel" reimplementation is called mesosphère, while the EL3 "TrustZone" reimplementation is called exosphère. Learn more about ARM Exception Levels here.

    • Q: What exactly is the "emuMMC path," and why is it recommended for the microSD card to be at least 128GB for this path?

      A: The purpose of an emuMMC/emuNAND is to give you a safe place to use custom firmware functions without Nintendo catching sight. As it is an offline clone of your internal storage ran entirely from your microSD card, you will need to set allocate up to 64GB on your microSD card for it (depending on the size of your internal storage), plus a duplicate your of digital game data (emuMMC uses a separate Nintendo folder for game installs).

    • Q: Why do I need to set my console as primary before starting this guide?

      A: The Switch will otherwise try to connect to Nintendo servers before starting apps, which can lead to unexpected delays and make emuMMCs completely unusable.

    • Q: Can I follow this guide if I have a smaller microSD card, and what are the risks involved in choosing the sysCFW path?

      A: Nothing stops you from using sysCFW, but it is recommended for first-timers to get familiar with CFW by starting with an emuMMC. If used improperly, running sysCFW can cause software bricks and/or bans.

    • 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, you can also try the r/SwitchHacks subreddit!

  • - + \ No newline at end of file diff --git a/user_guide/all/cfw_environment.html b/user_guide/all/cfw_environment.html index b908be4f..d0325462 100644 --- a/user_guide/all/cfw_environment.html +++ b/user_guide/all/cfw_environment.html @@ -20,7 +20,7 @@
    Skip to content

    CFW on sysMMC vs. CFW on emuMMC

    A "CFW Environment" describes the context in which you are using custom firmware (CFW). As a reminder, custom firmware is never permanently installed, and runs independently on top of the system firmware. This means that you never have to commit to where you want to use custom firmware.

    Atmosphère temporarily patches HOS (HorizonOS, operating system of the switch) to enable customisations. You can choose what version of HOS it patches, each time you turn on your system. Each option has its own benefits and drawbacks.

    • For the purposes of this guide, the suffix -NAND and -MMC are interchangeable.

    Generally, sys- refers to the physical storage chip (sysMMC/eMMC) inside of your Switch. It stands for "system".

    Generally, emu- refers to a virtual version of the eMMC (internal storage), running from a microSD card. It stands for "emulated".

    For more information on terminology, please refer to the glossary.

    You get to decide! Your choices are between using the internal storage or emulated storage. We will go over the advantages and disadvantages of either decision below.


    CFW on emuMMC has the following benefits:

    • No risk of bans as long as emuMMC remains offline from Nintendo [info]
    • A safe area to test dangerous or risky mods and homebrew
    • No chance of bricking and losing console-unique information while using CFW

    The following drawbacks:

    • Large microSD size requirement (32GB or 64GB will be reserved, depending on if you use a Switch OLED or not). If you want a decent experience, a minimum of 128GB is required (unless you are an advanced user and can resize the USER partition of your NAND)
    • Slower console response times due to the limitation of your microSD card's classifications/specifications
    • No official online play while in CFW
    • More microSD card wear over time
    • Doubled digital game storage requirements

    And the following considerations:

    No parity between sysMMC and emuMMC (Game installs, save data, and system settings will be separated when you boot between the two)

    • 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.

    INFO

    About this path

    This path of the guide also includes sysCFW as launch option.

    INFO

    To proceed with CFW on emuMMC, click on the button below:

    Continue with the emuMMC path

    sysCFW (CFW on sysMMC)

    CFW on sysMMC has the following benefits:

    • Parity of system settings, save data, and titles between CFW usage and standard usage (no need to duplicate digital games)
    • Significantly lower microSD card storage requirements
    • Possibility of online play during CFW use
    • Fast console response time by not having to rely on the speed of your microSD card
    • Longer microSD card lifespan

    The following drawbacks:

    • A brick risk for risky behaviors, especially for modchip users [info]
    • A Nintendo server ban risk for misbehavior [info]
    • No possibility of custom profile pictures (guaranteed ban)
    • 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])

    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.


    INFO

    To proceed with CFW on sysMMC, click on the button below:

    Continue with the sysCFW path

    Modchip Instability

    DANGER

    About Modchipped Switch console users

    Modchips directly infiltrate communication with the internal storage chip. Due to this, there are slight chances of NAND backups being tainted with corrupted data. If a bad backup is restored to sysNAND, the console can be bricked, and a modchip alone won't be able to fix it. To be safe, we recommend setting up an emuMMC on a console with a modchip, verify BOOT0/1 backups using tools like NXNandManager (Windows) or test NAND backups by running them as emuMMCs before you flash them to the sysNAND.

    Frequently Asked Questions about this page
    • Q: Why is CFW referred to as being "never permanently installed"?

      A: Unless you have a modchip of any kind, turning the console off will disactivate the custom firmware. There is no current method for Atmosphère to install-to or permanently replace any part of the Nintendo Switch, so it will need to be triggered by an exploit every time you turn on the console. Atmosphère will then patch Horizon to bring you custom firmware features.

    • Q: Should I personally use sys/emuMMC?

      A: These questions are answered in detail within the webpage. Please make sure that you are fully reading the page before jumping here.

  • - + \ No newline at end of file diff --git a/user_guide/all/launching_cfw.html b/user_guide/all/launching_cfw.html index c6828d88..ec524161 100644 --- a/user_guide/all/launching_cfw.html +++ b/user_guide/all/launching_cfw.html @@ -20,7 +20,7 @@
    Skip to content

    Launching CFW

    Now that the preparation work is out of the way, we're finally ready to launch custom firmware on the Switch.

    Unlike systems such as the DSi, Wii, or 3DS, Switch CFW is currently volatile. It will only work as long as your Switch is on. As soon as your Switch completely loses power for any reason (shutting down, battery dying, etc.), CFW will no longer be active and you will need to follow these instructions again.

    DANGER

    Keep emuMMC offline at all times

    Your emuMMC (emuNAND) should never connect to Nintendo. For online play, eShop browsing, or any other Nintendo online activity, use your sysNAND. Using both emuMMC and sysNAND online will likely result in a ban.

    Instructions:

    1. From Hekate's Home menu, navigate to the Launch menu.
    2. Find Atmosphere FSS0 emuMMC and launch it.

    Hekate is now booting into your emuMMC. To verify that your emuMMC launched properly, open System Settings and navigate to System. You should see AMS next to the version number (AMS indicating that you're booted into Atmosphere), as well as an E at the end (indicating you are booted into emuMMC).

    INFO

    If you wish to set up an extra method of blocking Nintendo's servers on your emuMMC, visit this page to set up 90DNS.

    Atmosphere version string

    Instructions:

    1. From Hekate's Home menu, navigate to the Launch menu.
    2. Find Atmosphere FSS0 sysMMC and launch it.

    Hekate is now booting into sysCFW. To verify that sysCFW launched properly, open System Settings and navigate to System. You should see AMS next to the version number (AMS indicating that you're booted into Atmosphere), as well as an S at the end (indicating you are booted into sysCFW).

    • Note: You will also have the Atmosphere FSS0 EmuMMC launch option in Hekate, launching it will just result in an error and is expected because you don't have an emuMMC.

    Atmosphere version string

    TIP

    Rebooting to Hekate

    Once booted into CFW, you can easily get back to Hekate by holding the power button, and selecting Restart in the power menu or by using the "reboot to payload" homebrew app in the homebrew menu. (Note that while the Reboot to Payload app app does not work on modchipped Switch consoles, those already automatically run payloads upon reboot in the first place by default.)


    Launching the Homebrew Menu

    You will now be able to launch the Homebrew Menu by opening the album or by holding the R button while launching any game (including demos/cartridges), or application (e.g. YouTube/Hulu). If R is not held, the game or application will launch like normal.

    WARNING

    A note about using the album for the Homebrew Menu

    • Using Album for the Homebrew Menu instead of a game or application has several limitations, including but not limited to: a smaller amount of available memory (RAM), as well as being unable to launch a full-featured web browser. It is strongly recommended to launch homebrew through applications or games instead.

    About the included Homebrew apps

    See the Homebrew tab for information about what the included Homebrew apps do and if you want to check out more Homebrew apps and read about sysmodules like MissionControl, ldn_mitm, sys-con and more.

    If you wish to install more homebrew apps, place them (.nro files) in the switch folder on your microSD card.


    Installing Android/Linux

    If you've partitioned your microSD card for preparation of Android/Linux earlier, you can continue with the installation of Android/Linux here with the guides below:

    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, hosted by 4TU. You can also browse the r/SwitchHacks subreddit.

  • - + \ No newline at end of file diff --git a/user_guide/all/making_essential_backups.html b/user_guide/all/making_essential_backups.html index 71a1b698..e16646a4 100644 --- a/user_guide/all/making_essential_backups.html +++ b/user_guide/all/making_essential_backups.html @@ -20,7 +20,7 @@
    Skip to content

    Making Essential Backups

    Making a NAND Backup

    DANGER

    Important

    A NAND backup is crucial to have, it's a full backup of the internal storage of your Switch and can be used to restore the device to a working state in case of emergencies. DO NOT SKIP THIS STEP

    Once the backup is finished, keep it somewhere safe. The best backup is the one you have but never need, and the worst backup is the one you need but never made. To save space, it's recommended to compress the end-result with a .zip file or something similar.

    It's highly recommended that you use an microSD card that is formatted to FAT32 and has at least 32 gigabytes of space free. This will still work on smaller cards, but it's not ideal.

    Instructions:

    1. Enter RCM and inject the Hekate payload.
      • If you use a modchipped Switch, you can simply just turn your Switch on with the Hekate payload renamed to payload.bin on the root of your microSD card.
    2. Use the touch screen or Joy-Cons to navigate to Tools > Backup eMMC.
    3. Tap on eMMC BOOT0 & BOOT1
      • This should only take a few seconds, but if your microSD card is very slow, it may take around a minute.
    4. Tap on Close to continue, then tap on eMMC RAW GPP
      • This will take a long time. Expect it to take between 10 minutes to an hour (or more, if your microSD card is very slow).
      • If your microSD card has less than 32GB of space available, please follow these instructions 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.
    About microSD cards with less than 32GB of free space

    On FAT32 formatted microSD cards or cards that have less than 32 gigabytes of space available, the NAND backup will be split into 1 or 2 gigabyte parts.

    Hekate will stop producing these parts when it runs out of space. When this happens, do the following:

    1. Press OK when Hekate tells you to back up your stuff. nandbackup
    2. Press Close > Close > USB Tools > SD Card and connect your Switch to your PC via USB.
    3. Your microSD card should now be accessible on your PC, move the backup folder on the root of your microSD card to a safe location on your PC.
      • If you are prompted to merge folders, do so.
    4. Eject the UMS device safely from within your computer's operating system and close the UMS window in Hekate.
    5. Press Close > Backup eMMC > eMMC RAW GPP and continue backing up your NAND.
    6. Repeat step 2-5 until the NAND is completely dumped.
    7. Once done, return to Hekate's Home menu.

    Booting into CFW

    TIP

    Click the link below to continue to Launching emuMMC!

    Launching CFW (emuMMC)

    TIP

    Click the link below to continue to Launching sysCFW!

    Launching CFW (sysCFW)

    Frequently Asked Questions about this page
    • Q: Why is making a NAND backup considered crucial?

      A: A NAND backup contains a complete snapshot of the internal files of your Switch, including console-specific files that cannot be regenerated if accidentally lost. This is why it is mandatory to keep at least one copy of your NAND backup in a safe place, even if it takes a lot of space. The consequence to not having one is, at best, a Switch that cannot connect to Nintendo Network, or at worst, a full brick. However, it is important to note that it is nearly impossible to permanently brick a hackable Nintendo Switch.

  • - + \ No newline at end of file diff --git a/user_guide/all/partitioning_sd.html b/user_guide/all/partitioning_sd.html index b0cee251..d53ce008 100644 --- a/user_guide/all/partitioning_sd.html +++ b/user_guide/all/partitioning_sd.html @@ -20,7 +20,7 @@
    Skip to content

    Partitioning the microSD Card and creating the emuMMC

    What you need:

    • Your Switch loaded into Hekate

    DANGER

    Partitioning WILL wipe all data on your microSD card!

    In case you missed the warning earlier, your microSD card will be wiped during this page. Go to Tools > USB Tools > SD Card, plug your switch into your PC via USB and back up the contents of your microSD card to your PC if you haven't done so yet. If you don't mind redownloading all the games stored on the microSD card and/or all other (potentially important) files getting deleted, you may skip this.

    Instructions:

    1. Navigate to Tools > Partition SD card
    2. Set the emuMMC (RAW) slider to 29 FULL in the middle of the bar.
      • Set the emuMMC (RAW) slider to 58 FULL if you're on an OLED Switch.
      • If you wish to install Android and/or Linux later, partition your microSD card here accordingly by moving the sliders you see during this step. We recommend setting the Android (USER) and Linux (EXT4) sliders to at least 16GB.
    3. 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.
      • 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.

    hekate-partitioning-emu

  • - + \ No newline at end of file diff --git a/user_guide/all/partitioning_sd_syscfw.html b/user_guide/all/partitioning_sd_syscfw.html index b6b8328d..422ae94d 100644 --- a/user_guide/all/partitioning_sd_syscfw.html +++ b/user_guide/all/partitioning_sd_syscfw.html @@ -20,7 +20,7 @@
    Skip to content

    Formatting and/or partitioning the microSD Card

    What you need:

    • Your Switch loaded into Hekate

    DANGER

    Partitioning WILL wipe all data on your microSD card!

    In case you missed the warning earlier, your microSD card will be wiped during this page. Go to Tools > USB Tools > SD Card, plug your switch into your PC via USB and back up the contents of your microSD card to your PC if you haven't done so yet. If you don't mind redownloading all the games stored on the microSD card and/or all other (potentially important) files getting deleted, you may skip this.

    Instructions:

    1. Navigate to Tools > Partition SD card
    2. Navigate to Next Step at the bottom right, then select Start in the menu that appears.
      • If you wish to install Android and/or Linux later, partition your microSD card here accordingly by moving the sliders you see during this step. We recommend setting the Android (USER) and Linux (EXT4) sliders to at least 16GB.
      • For Android; Select Legacy partitioning for Android 10/11 and Dynamic partitioning for Android 13+. Legacy and Dynamic partitioning are NOT intercompatible.
    3. Once done, go to Hekate's Home menu and then Tools > USB Tools > SD Card and plug your Switch into your PC via USB.
    4. Continue with the next step of the guide.
      • Your microSD card should now be accessible on your PC. If not, consult the warning message below.

    WARNING

    Your microSD card is not showing up

    If your microSD card isn't showing up at all, ensure that you're using a USB cable capable of data transfer and that if you use Windows, Windows has assigned a drive letter to the FAT32 partition of your microSD card. If you still experience errors, join the NH-Discord server for support.

    hekate-partitioning-emu

  • - + \ No newline at end of file diff --git a/user_guide/all/sd_preparation.html b/user_guide/all/sd_preparation.html index 4c812f69..97402130 100644 --- a/user_guide/all/sd_preparation.html +++ b/user_guide/all/sd_preparation.html @@ -20,7 +20,7 @@
    Skip to content

    microSD Card preparations

    We will now place the required files for the Atmosphère custom firmware and some additional homebrew files on the microSD card.

    Atmosphere has its own bootloader, called fusee. For the purposes of this guide we will be using Hekate instead, so that we can back up the system's NAND (internal storage) and take advantage of other advanced features in the future.

    WARNING

    File name extensions

    If you use Windows, you should enable file name extensions before continuing. See this link for a guide on how to do this.

    What you need:

    • The latest release of Hekate (Download the hekate_ctcaer_(version).zip release of hekate)
    • The Hekate config file: hekate_ipl.ini
    • The DNS.MITM DNS redirection config: emummc.txt
    • The bootlogo zip folder: bootlogos.zip
    • The latest release of Atmosphere. Download the atmosphere-(version)-master-(version)+hbl-(version)+hbmenu-(version).zip release of Atmosphere.
    • The latest release of JKSV (Download the JKSV.nro release of JKSV)
    • The latest release of FTPD (Download the ftpd.nro release of FTPD)
    • The latest release of NXThemesInstaller (Download the NXThemesInstaller.nro release of NXThemesInstaller)
    • The latest release of NX-Shell (Download the NX-Shell.nro release of nx-shell)
    • The latest release of Goldleaf (Download the Goldleaf.nro release of Goldleaf)

    Instructions:

    1. Navigate to the accessible drive.

    2. Copy the contents of the Atmosphère.zip file to the root of your microSD card.

    3. Copy the bootloader folder from the Hekate .zip file to the root of your microSD card.

      • 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.

      • If you're asked to merge the bootloader folders, do so.
    5. 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.

      • If you created an emuMMC on the previous page, don't forget to copy the Nintendo folder to sd:/emuMMC/RAW1/!

      DANGER

      About emummc.txt

      Putting the emummc.txt file provided by this guide into /atmosphere/hosts will prevent your emuMMC (emuNAND) from connecting to Nintendo. Not doing this will likely result in a ban.

      TIP

      Your microSD card should look similar to the image below. The Nintendo folder will not be present if your Switch has not already booted with the microSD card inserted and the emuMMC folder will not be present if you're following the sysCFW path of the guide/you haven't created an emuMMC! payload.bin will not be present if you're using an unpatched Switch.

      sdfilesimg

  • - + \ No newline at end of file diff --git a/user_guide/getting_started.html b/user_guide/getting_started.html index 0d40f945..d5cc0359 100644 --- a/user_guide/getting_started.html +++ b/user_guide/getting_started.html @@ -20,7 +20,7 @@
    Skip to content

    Getting Started

    TIP

    About modchipped Switch console users

    If you already know you have a modchipped Switch console, you can skip ahead to the Modchip Introduction page.

    Finding your serial number

    In the RCM path, we'll first determine if your Switch is vulnerable to fusee-gelee, the exploit we will be using to launch CFW.

    The fusee-gelee vulnerability was discovered independently by different Switch hacking teams, who all independently released versions of the exploit in April 2018. Nintendo and NVIDIA were informed 90 days before these releases, and patched consoles were launched by mid-2018. NVIDIA publicly acknowledged the flaw in April as well. In July 2019, Nintendo announced updated consoles: the Switch Lite (HDH-001), and a new model of original Switch (HAC-001(-01)/"V2") with better battery life. Both of these new models use the Tegra X1+ (also known as Mariko, the T214, and T210B01) with a brand-new bootROM, and cannot currently be hacked without a modchip.

    Patched and Mariko units can be identified by their serial number. This number can be found in the Settings applet at System -> Serial Information. You can also find it on the bottom of the console, adjacent to the charging port. However, it is always more accurate to use the serial reported in Settings instead, especially if you aren't the original owner of the console.

    Visual for System Settings serial location

    Visual for serial location on the bottom of console

    Determining if your Switch is vulnerable

    The community has crowdsourced a list of known serial numbers which are vulnerable to fusee-gelee.

    • If your serial number is on this list as "potentially patched", follow the notice directly after this list.
    • If your serial number is listed as "patched", there is nothing you can do at this time besides installing a modchip (hardware modification. It requires experience with microsoldering.).
    • If your system is patched, it is highly advised to keep it on 7.0.1 or lower, if possible, as there may be a vulnerability for these versions in the far future. DO NOT update patched consoles past 7.0.1 if you want to ever have a chance of running homebrew and/or CFW on them if you do not have the skills required to install a modchip.

    TIP

    Notice

    If you are unsure if your serial is patched, you can test your console yourself following the instructions here.

    Serial list

    The following information is based on this GBATemp thread.

    Serial NumbersUnpatchedPotentially patchedPatched
    XAW1XAW10000000000 to XAW10074000000XAW10074000000 to XAW10120000000XAW10120000000 and up
    XAW4XAW40000000000 to XAW40011000000XAW40011000000 to XAW40012000000XAW40012000000 and up
    XAW7XAW70000000000 to XAW70017800000XAW70017800000 to XAW70030000000XAW70030000000 and up
    XAJ1XAJ10000000000 to XAJ10020000000XAJ10020000000 to XAJ10030000000XAJ10030000000 and up
    XAJ4XAJ40000000000 to XAJ40046000000XAJ40046000000 to XAJ40060000000XAJ40060000000 and up
    XAJ7XAJ70000000000 to XAJ70040000000XAJ70040000000 to XAJ70050000000XAJ70050000000 and up
    XAK1N/AXAK10000000000 and upN/A

    If your serial number is not listed above, your device is not vulnerable to the fusee-gelee exploit.

    Version Table

    TIP

    Note

    While the "New" Switch (HAC-001(-01)'s earliest possible firmware is 7.0.1, it is not vulnerable to déjà vu, the exploit used by Nereba and Caffeine, because of hardware differences from the "old" Switch (HAC-001).

    Firmware VersionUnpatched Switch systems (HAC-001)Patched Switch systems (HAC-001)"New" Switch (HAC-001(-01)Switch Lite (HDH-001)
    1.0.0Nereba or RCMN/AN/AN/A
    2.0.0 - 3.0.2Caffeine or RCMN/AN/AN/A
    4.0.0 - 4.1.0Caffeine or RCMCaffeineN/AN/A
    5.0.0 - 7.0.0RCMModchip / Wait for CFWN/AN/A
    7.0.1RCMModchip (no software exploit)Modchip (no software exploit)N/A
    8.0.1RCMModchip (no software exploit)Modchip (no software exploit)Modchip (no software exploit)
    8.1.0 and upRCMModchip (no software exploit)Modchip (no software exploit)Modchip (no software exploit)

    TIP

    About Mariko Switch models

    All Mariko (V2) Switch models (HAC-001(-01), HDH-001, HEG-001) are currently unhackable via software. If Modchip is listed as a method for your console model, then that means the device is currently unhackable without a hardware modification (modchip). If there are theoretical exploits that may lead to CFW or homebrew for that device, you also have the choice to "wait" for their release. These exploits may (and will likely) never launch and there is NO ETA, so what you choose to do is up to you. This guide assumes you have a functional modchip installation if you do have a Patched console.

    Console Preparation

    Important

    Before setting up for homebrew, install at least one eShop title to utilize "title takeover", an Atmosphère feature that allows homebrew to use more resources than they would normally have. Try downloading a free game (like Fallout Shelter), application (like YouTube), or a game demo (like 10 Second Run RETURNS). Running the Homebrew Menu via a game cartridge is an alternative, but requires the game to be inserted any time you want to launch the Homebrew Menu. Generally, title takeover doesn't permanently alter the donor game or application.
    Once you obtain any bootable title, you are prepared to continue on with the guide.


    TIP

    If your Switch is not patched, click the button below to follow the RCM path of the guide.

    Continue to RCM

    TIP

    If your Switch is patched and modchipped, click the button below to follow the Modchip path of the guide.

    Continue to Modchip introduction

    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+.

  • - + \ No newline at end of file diff --git a/user_guide/modchip/index.html b/user_guide/modchip/index.html index 3d976c50..c27ac128 100644 --- a/user_guide/modchip/index.html +++ b/user_guide/modchip/index.html @@ -20,7 +20,7 @@
    Skip to content

    Introduction to Modchips

    Prerequisites

    A modchip is a physical modification to the motherboard of your Switch. It cannot be installed without decent microsoldering experience. You can outsource this work to people who are willing to do the job for you, or you can also view the following guide if you are willing to install one yourself.

    Note: The above guide is not hosted or supported by NH Server; we cannot provide support for reviving consoles ruined by inexperience.

    Information

    Unlike "unpatched" consoles, modchips enable CFW via CPU voltage glitching, which bypass bootROM firmware verifications. It allows a payload.bin file to be launched in place of BOOT0, loaded via a modchip firmware module named sdloader. This is much different from RCM and its exploit, fusee-gelee, which "unpatched" consoles use. Modchips allow any console, including all patched consoles, to run CFW!

    General knowledge

    Patched Switch consoles (consoles produced after mid-2018) are immune to the fusee-gelee exploit in RCM. Attempting to inject a payload on a Patched console will be unsuccessful.

    Depending on your modchip's firmware, you may not be able to boot the console without a microSD card inserted. This means without a microSD inserted at all times, your Switch becomes unusable.

    If you do turn on your Switch without a microSD card inserted, you should end up at a splash screen saying something along the lines of NO SD.

    About modchips and their firmware versions

    Some modchip firmwares (e.g., Spacecraft-NX, Hwfly-NX and the Picofly firmware) allow bypassing sdloader by holding one - or both - of the volume buttons during power-on, enabling normal boot without a microSD card. Not all modchips support manual firmware updates.

    Modchipped Switch consoles allow untethered, coldboot CFW loading, directly entering custom firmware without external devices like dongles or jigs. This is in contrast to the tethered coldboot "RCM" entrypoint.

    • "Untethered coldboot" means being able to turn on your console from a fully-off ("cold") state directly into custom firmware, without external devices such as a dongle, payload injector, or jig.

    Running CFW on modchipped consoles is more simplistic, as it only requires you to have payload.bin present on the root of your microSD card when you turn on the system.

    Furthermore, this guide assumes you have a functional modchip installation.

    Important

    If you do decide to follow the recommended emuMMC path later in the guide, make sure you disable Automatic Save Data Cloud backups/downloads beforehand as well as making sure the Switch is set as Primary Console.

    DANGER

    Disclaimer

    We ONLY support the Picofly modchip (the RP2040 Zero development board and the "modchip variant" of it). Installing a modchip safely is your responsibility, so if you don't trust yourself, get someone trusted to perform the install.

    There is always a risk of your Switch being rendered dysfunctional when messing with its hardware without proper experience.

    The NH-Discord server is not for fixing bad/failed modchip installations.

    We can give advice and installation tips for the installation as long as it's for a Picofly modchip.

    Frequently Asked Questions about this page
    • Q: Can you provide more information about modchip firmwares, specifically regarding their impact on the boot process and the ability to bypass the sdloader?

      A: Modchip firmwares indirectly determine the functionality of your system. Modern modchips (such as Picofly) typically have firmware flashed to them that support all hardware configurations (namely eMMC brands like Hynix, Samsung and Toshiba) "out-of-the-box" and also allow you to bypass sdloader. If this is not the case however, flashing the firmware manually is required by opening up the Switch and using the USB debug port that comes with the modchip to flash the modchip directly. This is especially required in the cases where the eMMC brand is not supported, as your Switch wouldn't boot whatsoever and the modchip would be stuck while trying to glitch/train and write its payload to the BOOT0 partition of the internal storage.

    • Q: What different types of modchips are there?

      A: There are three main types of modchips for the Nintendo Switch. Only two of them are relevant for this guide.

      On the V1 Nintendo Switch, a chip can be installed which automatically injects a payload whenever the console is detected in RCM. This type of modchip is not supported by this guide.

      On all other Switch consoles, there are DIY "Picofly" modchips which can be created with Raspberry Pi parts and custom cables. These use special firmwares, and are not compatible with firmwares intended for other modchips.

      There are also other "commercial" modchips of dubious origin by the name of "hwfly" or "SX Core/Lite"; we only will help with flashing new firmwares onto these, if you happen to already have one of them installed. Do not ask for assistance installing or sourcing this type of modchip.

    • Q: Can you further explain the concept of running homebrew "over a title" and why it allows for higher resource allocation?

      A: The default way to run homebrew within Atmosphère is via the Album applet on the HOME Menu. However, applets have significantly less resources compared to full applications, and homebrew tools often run into constraints with these limits. By holding a button while launching normal apps while in CFW, you can load the Homebrew menu in their stead with full resources.

    • Q: What makes Picofly the only supported modchip, and what are the potential risks associated with installing a modchip on your Switch without proper experience?

      A: Picofly is a fully open-source modchip, from the firmware to the RP2040 microcontroller it uses. Other "commercial" modchips have dubious origins, or were manufactured by established illegal piracy groups 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.

  • - + \ No newline at end of file diff --git a/user_guide/modchip/preparing_hekate.html b/user_guide/modchip/preparing_hekate.html index 72ae94ee..64e8262f 100644 --- a/user_guide/modchip/preparing_hekate.html +++ b/user_guide/modchip/preparing_hekate.html @@ -21,7 +21,7 @@
    Skip to content

    Payload and bootloader folder placement

    To get ready for formatting and/or partitioning your microSD card, we will need to prepare and place the required files on the microSD card.

    DANGER

    Following the guide will delete everything on your microSD card!

    Later in the guide, you will be formatting and/or partitioning your microSD card. This means that all data on the microSD card will be lost. Now is a good time to back up all of its data to a safe place (for example, on your PC or external drive) so that you can restore it later. You can do this by following the instructions below.

    What you need:

    • The latest release of Hekate (Download the hekate_ctcaer_(version).zip release of Hekate)
    • Your microSD card

    Instructions:

    1. Extract the Hekate .zip to a location on your computer.
    2. Insert your microSD card into your computer.
    3. Copy the Nintendo folder (and any other important data) from the root of your microSD card to a safe space on your device.
    4. Inside of the extracted Hekate folder, you will find the bootloader folder and the hekate_ctcaer_(version).bin payload.
    5. Copy the bootloader folder and hekate_ctcaer_(version).bin payload to the root of your microSD card.
    6. Rename the hekate_ctcaer_(version).bin payload to payload.bin
    7. Insert your microSD card back into your Switch, then turn it on.
    8. You should now be loaded into the Hekate GUI (Nyx), pictured below, within seconds. Nyx
      • If you are unable to load into Nyx, consult the warning message below.

    WARNING

    If your Switch does not load into the Hekate GUI, or shows a No SD Card/No Payload screen when turning on the console, ensure that you inserted your microSD card and that Hekate's payload.bin is on the root of the microSD card.

    Frequently Asked Questions about this page

    Q: Can I use a microSD card with existing data, or does it need to be formatted specifically for this process?

    A: It is recommended that you use a microSD that is already formatted as FAT32 before starting. In addition, it is important that the microSD card does not have any data from other Switch consoles already on it.

    Q: What makes Hekate the recommended choice in this guide?

    A: Hekate is a polished, multi-purpose bootloader for the Switch. It has the tools to facilitate simple usage of custom firmware and custom operating systems, and aids with organisation and formatting later on in this guide.

    Q: How do you pronounce "Hekate"?

    A: Hekate comes from Greek. The most commonly accepted pronunciations are "HEK-ate", "HEK-uh-tee", and "hek-AH-tay".

    Q: What role does the /bootloader folder play in the overall functionality of Hekate?

    A: The bootloader folder contains crucial parts of Hekate that can't fit in the injectable RCM/modchip payload, such as Nyx; Hekate's touch-enabled GUI. If you start Hekate without these files on your microSD, Hekate's functionality will be severely limited.

    Q: How often should I check for updates to Hekate, and what benefits do newer releases bring to the process?

    A: Nintendo Homebrew's #announcements channel will automatically poll for updates to Atmosphère and Hekate, letting you know when updates are available for them. In general, you'll want to look for updates whenever a major Switch system update is launched, as major updates will stop Horizon from booting until Hekate and Atmosphère are updated accordingly.

    Q: Does this process have any effect on the Switch's system or data?

    A: No, nothing in the guide has had any permanent effect on the Switch so far.

  • - + \ No newline at end of file diff --git a/user_guide/rcm/entering_rcm.html b/user_guide/rcm/entering_rcm.html index 07d640cc..adc76637 100644 --- a/user_guide/rcm/entering_rcm.html +++ b/user_guide/rcm/entering_rcm.html @@ -20,7 +20,7 @@
    Skip to content

    Entering RCM

    The Switch's Tegra X1 processor has a recovery mode referred to shorthand as RCM, intended to be useless for end-users. Fortunately, due to the fusee-gelee vulnerability, this special mode acts as our gateway into CFW.

    Methods to enter RCM can require nothing more than household items (not recommended) to affordable tools ($5-10) available on platforms like AliExpress and Amazon. Avoid the "metal bridge" or "paperclip method" as it can damage your console. You can also consider 3D printing necessary tools.

    DANGER

    Patched Switch

    Note that patched units can enter RCM, but it is not possible to send a payload on those systems. Also note that RCM is a different recovery mode than the one accessed by holding Volume Up, Volume Down and powering on your console.

    TIP

    Information about the methods below

    The order of methods on this page is in the order of ease. The easiest method to immediately accomplish is the RCM Jig method. The most advanced/difficult methods are mentioned in the other tabs and should not be attempted by most people as they require voiding your warranty and/or soldering.

    USING A PAPERCLIP OR TIN FOIL CAN/WILL DAMAGE YOUR CONSOLE, DO NOT DO THIS!

    Instructions:

    1. Power off the Switch and short the pins on the 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.
      • 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.

    Some jig designs use paperclips, inheriting the same risks as the "metal bridge" / "paperclip method" and should not be done.

    Once you have successfully entered RCM, you can take the jig out of the Joy-Con rail.

    This method is similar to the "metal bridge" / "paperclip method", but is more reliable and safer in many cases. Jigs hold a wire in place so the correct pins (10 and a ground) are reliably shorted.

    The RCM jig pictured below is the model we recommend:

    recommended_jig


    Making your own RCM Jig

    If you plan on making your own jig, the second image lays out the right Joy-Con pad out on the console. Make sure your jig NEVER touches pin 4. Pin 4 provides 5 volts of power to the Joy-Con, and can permanently damage the rail or console if shorted. switchjigs.com jigs

    Console Numbered Pads Refrence

    This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart.

    This method comes to us from the mind of pbanj on Discord. All pictures of this method in action were provided by him, with some supplementary images provided by eip618 on Discord.

    The goal of this method is to open the right Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however you will be soldering wires to pins 7 and 10 (shown below) and wiring them to the "rail release button" at the top back of the right Joy-Con.

    JoyCon pad pinout:

    joycon numbered pads reference

    In order to start this method you will want to take two lengths of wire, and wrap one end of each into a small circle.

    Wire reference:

    wire reference

    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

    Joy-Con button:

    pbanj joycon button reference

    The first wire should now be in place as seen by the green circle below. The second wire does not need any solder, instead you will hold it in place using the screw as shown by the red circle in the picture below.

    Joy-Con button in place:

    pbanj joycon button reference

    Pressing the Joy-Con button in you should now notice the solder point you created making contact with the piece of metal held in by the screw. Once you have these elements in place you want to connect one wire to pad 7 and the other to pad 10 (it doesn't matter which is which). After that you have successfully created an RCM button on your Joycon. You will now need to hold down the Joycon release button when attempting to boot RCM.

    Successful installation:

    pbanj joycon button reference

    This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart.

    The goal of this method is to open the right handed Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however the goal is to solder pins 7 and 10 (shown below) together with a surface-mount 0805 10k resistor. Apart from using a physical switch/button, this is currently considered the safest method that involves soldering to pads.

    JoyCon pad pinout:

    joycon numbered pads reference

    Here is an example from stuck_pixel from the ReSwitched Discord server.

    Successful installation:

    stuckpixel solder example

    This method will result in the right Joy-Con being seen as "detached" while physically connected to the Switch, so it will not be able to charge. This method may result in the Joy-Con being permanently detected as wireless if you update the Joy-Con firmware while this mod is installed. In the latter case, fixing this requires opening up the Joy-Con and reseating the battery. It is recommended to solder pads 7 and 10 together with a resistor instead.

    This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart.

    The goal of this method is to open the right Joy-Con to the point that you can reach the contact pads easily. This is similar to the previous method, however the goal is to solder pads 9 and 10 (seen below) together. This can either be done using a small wire, or directly bridging the pads with solder.

    JoyCon pad pinout:

    joycon numbered pads reference

    Below is an example from yami0666 from our Discord server.

    Successful soldering job:

    YyAoMmIi solder example

    This method will result in the right Joy-Con being detected as in wireless mode while attached to the Switch, and this method may result in the Joy-Con being permanently detected as wireless if you update the Joy-Con firmware while this mod is installed. In the latter case, fixing this requires opening up the Joy-Con and reseating the battery.

    This method requires opening your right Joy-Con, voiding its warranty. Not for the faint of heart.

    The goal of this method is to open the right handed Joy-Con to the point that you can reach the contact pads easily, and use a thin object such as a knife to gently bend pin 9 and 10 (shown below) slightly up and towards each other so they touch, shorting them.

    JoyCon pinout:

    Joycon Pin Reference

    Here is an example from sonlen on our Discord server.

    Bent Joy-Con pins:

    Sonlen's example

  • - + \ No newline at end of file diff --git a/user_guide/rcm/index.html b/user_guide/rcm/index.html index fe15153a..7588668c 100644 --- a/user_guide/rcm/index.html +++ b/user_guide/rcm/index.html @@ -20,7 +20,7 @@
    Skip to content

    RCM

    RCM (short for ReCovery Mode) is a pre-boot mode for Tegra processors that allows NVIDIA and Nintendo to send the Switch tiny programs for various internal uses. On unpatched consoles, once a payload was sent, then quickly copied into the memory buffer behind the stack, it overflowed the memory buffer into the stack. This leads to a "smashed stack" and unsigned code execution within a bootROM context, giving us access to nearly everything on the console. We use it here to launch Atmosphère.

    If you choose the emuMMC path introduced later in the guide, it'll be important to disable the Automatic Save Data Cloud function beforehand, as well as making sure the Switch is set as the primary console.

    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. There is also a Medium article about it here.

    • 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.

  • - + \ No newline at end of file diff --git a/user_guide/rcm/sending_payload.html b/user_guide/rcm/sending_payload.html index 376dff99..488e1307 100644 --- a/user_guide/rcm/sending_payload.html +++ b/user_guide/rcm/sending_payload.html @@ -21,7 +21,7 @@
    Skip to content

    Sending a Payload

    WARNING

    If you are here to test if your Switch is patched

    Make sure you have put your device into RCM and downloaded Hekate. Once finished, if your console is not patched, continue with the "Preparing Hekate" section at the bottom of the page.

    Now that the device is in RCM, we will need to send it a payload. The methods are mostly the same but slightly differ depending on what hardware you have available.

    Injecting a payload

    What you need:

    • The latest release of TegraRcmGUI (either the MSI or zip)
    • A USB-A to USB-C cable (or a standard USB-C cable if your computer natively supports USB-C)
    • The latest release of Hekate. The Hekate payload (hekate_ctcaer_(version).bin) is located inside of the hekate_ctcaer_(version).zip.

    Instructions:

    1. Install and run TegraRcmGUI.
    2. Navigate to the Settings tab, then press Install Driver and follow the on-screen instructions.
    3. Connect your Switch in RCM to your PC using the USB cable.
    4. Navigate to the Payload tab of TegraRcmGUI.
      • Your Switch should be shown as detected in the bottom left corner.
    5. Press the file button next to Inject payload, and navigate to and select the hekate_ctcaer_X.X.X.bin file.
    6. Click Inject payload to launch the payload you selected.
      • 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.

    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.

    What you need:

    • The latest release of fusee-nano (also available on the AUR)
      • If you use Arch Linux or a derivative distro, the AUR package is recommended.
    • A USB-A to USB-C cable (or a standard USB-C cable if your computer natively supports USB-C)
    • The latest release of Hekate. The Hekate payload (hekate_ctcaer_(version).bin) is located inside of the hekate_ctcaer_(version).zip.

    Instructions:

    1. Download and run the payload injector from your terminal. You will need to run the injector as root, unless you follow the instructions at Linux injection without root.
    2. Connect your Switch in RCM to your PC using the USB cable.
    3. Run fusee-nano with: ./fusee-nano /path/to/hekate-ctcaer_X.X.X.bin
      • As mentioned earlier, unless you have followed the instructions at Linux injection without root, 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.

    What you need:

    • The latest release of CrystalRCM (the CrystalRCM.(version).dmg file)
    • A USB-A to USB-C cable (or a standard USB-C cable if your computer natively supports USB-C)
    • The latest release of Hekate. The Hekate payload (hekate_ctcaer_(version).bin) is located inside of the hekate_ctcaer_(version).zip.

    Instructions:

    1. Download the latest release of CrystalRCM.
    2. 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.
      • macOS may warn you about the application being downloaded from the internet. To get around this warning, hold the control key while clicking the application, then click Open and Open again.
      • macOS Sequoia users: Apple has changed how unsigned applications from the internet are opened. You will need to follow the instructions here to open the application.
    4. Connect your Switch in RCM to your PC using the USB cable, make sure it's also detected in CrystalRCM.
    5. 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.

    What you need:

    • The latest release of Rekado
    • You will need to enable Unknown Sources in your device settings to install this
    • A USB-C cable
    • If your device has a USB-C port, you may use a C-C cable
    • If your device only has a Micro USB port, you will need a USB OTG adapter and a USB A-C cable
      • This will not work on every phone!
    • The latest release of Hekate. The Hekate payload (hekate_ctcaer_(version).bin) is located inside of the hekate_ctcaer_(version).zip.

    Instructions:

    1. Copy the hekate_ctcaer .bin file from the Hekate .zip file to a location on your phone.
      • A tool such as Amaze File Manager can do this.
    2. Launch Rekado on your phone.
    3. Navigate to Payloads (Signified by a downwards arrow with a line), then press the + button at the bottom right.
    4. Navigate to your hekate_ctcaer .bin file and tap it to add it to Rekado's menu.
    5. Optional, but recommended: Navigate to Rekado's settings in the top right and enable Hide bundled.
    6. Connect your Switch in RCM to your phone using the USB cable.
    7. If prompted, grant Rekado access to the Switch.
    8. Select the hekate_ctcaer_X.X.X.bin file in the dialog that pops up.
      • If your payload was successfully injected your switch should have yellow text that says "Update bootloader folder!", this will be resolved soon.

    What you need:

    • A USB-A to USB-C cable

    WARNING

    About USB-C

    If your Chromebook has a USB-C port, do note that this will not work using a C-C cable.

    Instructions:

    1. Go to the injection website 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.
      • 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

    If your console's screen remains black after you've sent Hekate (or any other payload), it's possible your payload was corrupted, or that your console is patched. If your payload injector program shows that zero or 0x0000 bytes were sent, then it is patched. This isn't a one-time glitch or up for debate; it is patched. Consider an alternate method that isn't via RCM.

    Preparing Hekate

    We will prepare the microSD card for formatting/partitioning before going to the next page. Removing the microSD card while in Hekate is safe so turning off the console is not necessary and keeping it on will save time that would be spent reinjecting the payload.

    DANGER

    Following the guide will delete everything on your microSD card!

    Later in the guide, you will be formatting and/or partitioning your microSD card. This means that all data on the microSD card will be lost. Now is a good time to back up all of its data to a safe place (for example, on your PC or external drive) so that you can restore it later. You can do this by following the instructions below.

    What you need:

    • The latest release of Hekate.
    • Your microSD card

    Instructions:

    1. Without turning your Switch off, remove the microSD card from the Switch.
    2. Insert your microSD card into your computer.
    3. Copy the Nintendo folder (and any other important data) from the root of your microSD card to a safe space on your device.
    4. Extract the Hekate .zip to a location on your computer
    5. Inside the extracted Hekate folder you will find a folder named bootloader.
    6. Copy the bootloader folder to the root of your microSD card.
    7. Put your microSD card back into your Switch.
    8. 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. Nyx
  • - + \ No newline at end of file