Skip to content

Commit

Permalink
treewide: default to 4-space indents
Browse files Browse the repository at this point in the history
There is a mix of tabs, 4-space and 6-space indents; standardize
indentation across all pages to 4-spaces to keep consistency.
  • Loading branch information
lifehackerhansol committed Sep 27, 2024
1 parent 01b0aae commit 5e9ce32
Show file tree
Hide file tree
Showing 14 changed files with 80 additions and 80 deletions.
2 changes: 1 addition & 1 deletion docs/extras/alternate_bootsetups.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
If you need to troubleshoot something, or need to try a different boot setup, read on.

!!! danger "Do I need any of these?"
Unless you are experiencing problems with booting or Atmosphère itself, it's strongly recommended to use the main guide instead of these. They are provided for the sake of completeness.
Unless you are experiencing problems with booting or Atmosphère itself, it's strongly recommended to use the main guide instead of these. They are provided for the sake of completeness.

 

Expand Down
14 changes: 7 additions & 7 deletions docs/extras/autorcm.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ AutoRCM causes the console to believe it is bricked, and will automatically laun
- Note: If the console screen stays black when pressing the power button after activating AutoRCM, remember that it's not broken. It's in RCM.

!!! warning "If you don't have a BOOT0/1 backup yet..."
You really want to kill your console, huh? If you haven't made a BOOT0/1 backup yet, it is recommended to make one **right now**.
You really want to kill your console, huh? If you haven't made a BOOT0/1 backup yet, it is recommended to make one **right now**.

1. Boot into Hekate
2. Go to `Tools`, and select `Backup eMMC`
3. Then tap `eMMC BOOT0 & BOOT1` and let the process complete.
1. Boot into Hekate
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.
- 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.

Expand All @@ -26,11 +26,11 @@ AutoRCM can be used for good as well:

- If you were having trouble getting into RCM before (i.e you were using the tinfoil method), now you can get into RCM without any hassle.
- If you want to keep fuses unburned, you can do so with AutoRCM, as the Switch never gets the chance to burn them. Nintendo's bootloaders burn the fuses, but those bootloaders cannot be used if AutoRCM is enabled.
- Note: updating the console while booted into Hekate's "stock" configuration will clear AutoRCM on the next reboot. Please update while using custom firmware, or be sure to use a jig after the console reboots.
- Note: updating the console while booted into Hekate's "stock" configuration will clear AutoRCM on the next reboot. Please update while using custom firmware, or be sure to use a jig after the console reboots.
- It's easier to inject a payload using a payload injector, as using your jig and booting into RCM manually is no longer required.

!!! tip "Other information..."
- This method corrupts a single byte in both your BOOT0 and your BOOT1 partitions. This is why a backup of those is recommended.
- This method corrupts a single byte in both your BOOT0 and your BOOT1 partitions. This is why a backup of those is recommended.
- This software version of AutoRCM can almost always be reversed, so don't freak out if it doesn't work out the way you'd like it to.

### **Enable/Disable AutoRCM**
Expand Down
2 changes: 1 addition & 1 deletion docs/extras/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The following list is in alphabetical order.
- **DNS**: [Domain Name System](https://en.wikipedia.org/wiki/Domain_Name_System). Basically, the internet's addressbook. If you visit a website, the DNS lookup is what tells you what server the site is hosted on.
- **Dongle**: Device you can plug in the USB-C of your Switch to automatically send a payload if your Switch is in RCM.
- **Encryption keys**: Keys used to encrypt data from the Nintendo Switch.
- **BIS keys**: Built-in Storage keys. They are used to encrypt/decrypt the NAND's contents.
- **BIS keys**: Built-in Storage keys. They are used to encrypt/decrypt the NAND's contents.
- **[fusee-gelee](https://github.com/Qyriad/fusee-launcher/blob/master/report/fusee_gelee.md)/[ShofEL2](https://github.com/fail0verflow/shofel2)**: Two names for two different implementations of the [same exploit](https://nvd.nist.gov/vuln/detail/CVE-2018-6242). This is an exploit that grants full bootROM access to the Nintendo Switch from the Tegra X1's RCM, and permitting us to run CFW. This exploit requires an external device or a tiny hardware modification. fusee-gelee is developed by an ex-ReSwitched developer, while ShofEL2 is developed by the failoverfl0w team. This guide uses fusee-gelee.
- **[hactool](https://github.com/SciresM/hactool)**: Software used to decrypt Nintendo Switch files like .XCI and .NSP files.
- **[Hekate](https://github.com/CTCaer/hekate)**: A bootloader for the Nintendo Switch. The current guide uses this in combination with essential files from Atmosphère to boot CFW.
Expand Down
26 changes: 13 additions & 13 deletions docs/extras/nandrestore.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## Restore a NAND backup to the Switch

!!! danger "Warning:"
- This will reset all of your saves, games, system version and other system settings back to the point of when you made the NAND backup. Keep this in mind, as you probably don't have to restore a NAND backup unless you have bricked your Switch or want to go back online safely after using CFW.
- This will reset all of your saves, games, system version and other system settings back to the point of when you made the NAND backup. Keep this in mind, as you probably don't have to restore a NAND backup unless you have bricked your Switch or want to go back online safely after using CFW.

- If you're going to restore an old NAND which will downgrade your firmware it's best to create a second NAND backup before restoring the first one in case something goes wrong.
- If you're going to restore an old NAND which will downgrade your firmware it's best to create a second NAND backup before restoring the first one in case something goes wrong.

### What you need:
- Your `rawnand.bin` (Combined or in 15 or 30 parts)
- Your `BOOT0` and `BOOT1`
- If you're missing any of the files above, ask for further help in the [Nintendo Homebrew](https://discord.gg/C29hYvh) Discord server.
- If you're missing any of the files above, ask for further help in the [Nintendo Homebrew](https://discord.gg/C29hYvh) Discord server.
- The <a href="https://github.com/CTCaer/hekate/releases/" target="_blank">Hekate</a> Payload
- A microSD card larger than 32GB

Expand All @@ -17,11 +17,11 @@
Before we start, check if you have a tree of folders called `backup/[8 Character NAND id]/restore` on your microSD card.

!!! warning "If you don't see a backup or [8 Character NAND id] folder on your microSD card:"
This means you do not have a nand backup, it is highly recommended you make one as soon as possible. Follow the steps below to make one.
This means you do not have a nand backup, it is highly recommended you make one as soon as possible. Follow the steps below to make one.

1. Launch the latest Hekate payload on your Switch.
2. Navigate to `Tools` > `Backup eMMC` > `eMMC BOOT0 & BOOT1` and let it do its thing.
3. Wait for the process to complete. When it's completed, you now have a `backup/[8 Character NAND id]/restore` folder on your microSD card. Continue with step 1 of the instructions below.
1. Launch the latest Hekate payload on your Switch.
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.
Expand All @@ -33,13 +33,13 @@ Before we start, check if you have a tree of folders called `backup/[8 Character
- This will generally take a long time to complete, the time it takes depends on your microSD card's specifications. (10-15 minutes is expected.)

!!! danger "If you're downgrading using your NAND backup"
If the security version you were on before you performed the NAND restore is HIGHER than the NAND backup itself, you have to enable autoRCM to not get stuck in a boot crash.
If the security version you were on before you performed the NAND restore is HIGHER than the NAND backup itself, you have to enable autoRCM to not get stuck in a boot crash.

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

A system update is considered a security version when a fuse is burned, you can check **<a href="https://switchbrew.org/wiki/Fuses#Anti-downgrade" target=blank>which versions burn fuses here</a>**.
A system update is considered a security version when a fuse is burned, you can check **<a href="https://switchbrew.org/wiki/Fuses#Anti-downgrade" target=blank>which versions burn fuses here</a>**.

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

1. In Hekate's main menu, navigate to `Tools` and go to the bottom of the page where you will find a button called `Archive bit - AutoRCM`
2. Select the `AutoRCM` buttom and you will see `ON` written next to it. This means it is enabled.
1. In Hekate's main menu, navigate to `Tools` and go to the bottom of the page where you will find a button called `Archive bit - AutoRCM`
2. Select the `AutoRCM` buttom and you will see `ON` written next to it. This means it is enabled.
8 changes: 4 additions & 4 deletions docs/homebrew/nxtheme-installer.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Using NXTheme Installer, you can install and create unique styles and layouts fo
### **Installing a theme**

!!! note "Community Themes"
If you want to use community made themes, for example from the <a href="https://www.reddit.com/r/NXThemes/" target="_blank">r/NXThemes</a> subreddit or [Themezer](https://themezer.net), you can follow the guide below to install a community provided `.nxtheme` file.
If you want to use community made themes, for example from the <a href="https://www.reddit.com/r/NXThemes/" target="_blank">r/NXThemes</a> subreddit or [Themezer](https://themezer.net), you can follow the guide below to install a community provided `.nxtheme` file.

#### **What you need:**

Expand All @@ -27,11 +27,11 @@ Using NXTheme Installer, you can install and create unique styles and layouts fo

1. Download `NXThemesInstaller.nro` and put it in `sd:/switch`.
1. Copy the `.nxtheme` files to the `themes` folder on your microSD card (It is recommended you put them into their own folders, e.g. `sd:/themes/awesome_theme/awesome.nxtheme`).
- Create the `themes` folder on the root of your microSD card if it does not exist.
- Create the `themes` folder on the root of your microSD card if it does not exist.
1. Boot into sysCFW/emuMMC and launch the Homebrew Menu, then launch `NXThemes Installer` *with* an internet connection.
- NXTheme Installer will automatically download the required theme patches if it has a connection to the internet. These theme patches are required for themes to work.
If you don't want to or don't have the ability connect to a Wi-Fi network, installing the theme patches can be done manually.
See the instructions [here](https://github.com/exelix11/theme-patches#if-you-dont-want-to-connect-your-console-to-the-internet) on how to install them manually.
If you don't want to or don't have the ability connect to a Wi-Fi network, installing the theme patches can be done manually.
See the instructions [here](https://github.com/exelix11/theme-patches#if-you-dont-want-to-connect-your-console-to-the-internet) on how to install them manually.
1. If you get prompted about extracting your home menu data, do so.
- You can always do this manually via the `Extract home menu` tab in `NXTheme Installer`.
1. You should now see the main menu of `NXTheme Installer`, the `Themes` tab is where you will find your themes. To install them, press the folder name of your theme and go through each home menu section to install the desired theme for that section (e.g. going to `/awesome_theme` and selecting your theme for the specific menu you want to change, do the same for the other menus).
Expand Down
32 changes: 16 additions & 16 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,26 +102,26 @@ Note: We are not currently, historically, or will we ever be, associated with An

Furthermore, we resent any implication to the contrary.
??? "Frequently Asked Questions about this page"
- **Q: What are the differences between "first-generation" ("V1") consoles and "patched" consoles when it comes to running homebrew?** <br>
A: Once you boot into Horizon, not much. The primary things to keep in mind is that only V1 consoles support Atmosphère's "Reboot to Payload" function, but modchips automatically load payloads during reboots on their own.
- **Q: What are the differences between "first-generation" ("V1") consoles and "patched" consoles when it comes to running homebrew?** <br>
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?** <br>
A: Horizon is the name of the Switch's operating system. It is sometimes called "HorizonNX", because it is actually a derivative version of the Nintendo 3DS's operating system of the same name.
- **Q: What is Horizon?** <br>
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?** <br>
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. <br> Learn more about ARM Exception Levels [here](https://developer.arm.com/documentation/102412/0103/Privilege-and-Exception-levels/Exception-levels).
- **Q: Why is it called Atmosphère?** <br>
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. <br> Learn more about ARM Exception Levels [here](https://developer.arm.com/documentation/102412/0103/Privilege-and-Exception-levels/Exception-levels).

- **Q: What exactly is the "emuMMC path," and why is it recommended for the microSD card to be at least 128GB for this path?** <br>
A: The purpose of an emuMMC/emuNAND is to give you a safe place to use custom firmware functions without Nintendo catching sight. As it is an offline clone of your internal storage ran entirely from your microSD card, you will need to set allocate up to 64GB on your microSD card for it (depending on the size of your internal storage), plus a duplicate your of digital game data (emuMMC uses a separate Nintendo folder for game installs).
- **Q: What exactly is the "emuMMC path," and why is it recommended for the microSD card to be at least 128GB for this path?** <br>
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?** <br>
A: The Switch will otherwise try to connect to Nintendo servers before starting apps, which can lead to unexpected delays and make emuMMCs completely unusable.
- **Q: Why do I need to set my console as primary before starting this guide?** <br>
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?** <br>
A: Nothing stops you from using sysCFW, but it is recommended for first-timers to get familiar with CFW by starting with an emuMMC. If used improperly, running sysCFW can cause software bricks and/or [bans](https://nx.eiphax.tech/ban.html).
- **Q: Can I follow this guide if I have a smaller microSD card, and what are the risks involved in choosing the sysCFW path?** <br>
A: Nothing stops you from using sysCFW, but it is recommended for first-timers to get familiar with CFW by starting with an emuMMC. If used improperly, running sysCFW can cause software bricks and/or [bans](https://nx.eiphax.tech/ban.html).

- **Q: Are there any specific restrictions or limitations imposed by Nintendo on consoles running custom firmware and homebrew?** <br>
A: Nintendo has shown a distinct tolerance for users using CFW while online. They __do not__ ban for the presence of CFW, they ban for misbehavior - such as piracy or cheating online. Otherwise, you are treated like all other users.
- **Q: Are there any specific restrictions or limitations imposed by Nintendo on consoles running custom firmware and homebrew?** <br>
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?** <br>
A: Of course! As well as the [Nintendo Homebrew Discord server](https://discord.gg/C29hYvh), you can also try the [r/SwitchHacks subreddit](https://www.reddit.com/r/SwitchHacks/)!
- **Q: Is there any community support or forums recommended for users who may have questions or issues during the process?** <br>
A: Of course! As well as the [Nintendo Homebrew Discord server](https://discord.gg/C29hYvh), you can also try the [r/SwitchHacks subreddit](https://www.reddit.com/r/SwitchHacks/)!
Loading

0 comments on commit 5e9ce32

Please sign in to comment.