Skip to content

Commit

Permalink
Markdown formatting adjustments (#228)
Browse files Browse the repository at this point in the history 
* gitignore: Ignore venv directory

Needed on systems that enforce PEP668

* treewide: use `1.` numbering for all ordered lists

Following specifications at [0] the formatting for lists "have no
effect on the HTML output Markdown produces".

This means we can consolidate all ordered lists to `1.`, which makes it
easier for the end user to add and remove steps and retain the
numbering.

It should be noted some Markdown implementations may use the first
number as a starting number for ordered lists, so it's best to start
with `1.`.

[0]: https://daringfireball.net/projects/markdown/syntax#list

* treewide: default to 4-space indents

There is a mix of tabs, 4-space and 6-space indents; standardize
indentation across all pages to 4-spaces to keep consistency.

* treewide: consolidate unordered lists to `-`

Standardize the unordered list marker to `-`, which is currently the
most widely used form of indentation in this repository.

* treewide: remove usage of <a> tags where applicable

Use Markdown links instead.
  • Loading branch information
@lifehackerhansol
lifehackerhansol authored Sep 29, 2024
1 parent a231731 commit 30ff537
Show file tree
Hide file tree
Showing 37 changed files with 406 additions and 406 deletions.
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
site
venv
2 changes: 1 addition & 1 deletion docs/about.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<a href="https://discord.gg/C29hYvh" target="_blank"><img style="float: right;" src="../img/discord.png"></a>
<a href="https://discord.gg/C29hYvh"><img style="float: right;" src="../img/discord.png"></a>

# About this guide

Expand Down
29 changes: 14 additions & 15 deletions docs/extras/adding_udev.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,22 @@ The following instructions are not for beginners. Only do this if you understand
To start, we will create a new group and add ourselves to it. The group the Nintendo Switch device will be owned by on Linux will be set to this group.

1. Open a terminal.
2. Enter the following command: `sudo groupadd nintendo_switch`.
3. Enter your password when prompted.
4. Enter the following command: `sudo usermod -a -G nintendo_switch $USER`. Make sure that the `G` is capitalized!
5. Close the terminal.
1. Enter the following command: `sudo groupadd nintendo_switch`.
1. Enter your password when prompted.
1. Enter the following command: `sudo usermod -a -G nintendo_switch $USER`. Make sure that the `G` is capitalized!
1. Close the terminal.

#### **Adding a udev rule**

Next we're gonna add a new `udev` rule. `udev` is a device manager for the linux kernel. The rule we're gonna specify is that if the Switch is connected in `RCM`, the group the Switch belongs to will be the group we made in the previous section.

1. Open a terminal.
2. Change to the root user with the following command: `sudo -i`. Enter your password when prompted.
3. Enter the following command: `mkdir -p /etc/udev/rules.d`.
4. Enter the following command: `echo 'SUBSYSTEMS=="usb", ATTRS{manufacturer}=="NVIDIA Corp.", ATTRS{product}=="APX", GROUP="nintendo_switch"' > /etc/udev/rules.d/10-switch.rules`.
5. Enter the following command: `udevadm control --reload`.
6. Enter the following command: `udevadm trigger`.
7. Logout and log back in.
1. Change to the root user with the following command: `sudo -i`. Enter your password when prompted.
1. Enter the following command: `mkdir -p /etc/udev/rules.d`.
1. Enter the following command: `echo 'SUBSYSTEMS=="usb", ATTRS{manufacturer}=="NVIDIA Corp.", ATTRS{product}=="APX", GROUP="nintendo_switch"' > /etc/udev/rules.d/10-switch.rules`.
1. Enter the following command: `udevadm control --reload`.
1. Enter the following command: `udevadm trigger`.
1. Logout and log back in.

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

Expand All @@ -45,11 +45,10 @@ You should now be able to run the payload sender without having to use `sudo`.

These rules will actually allow _ANY_ user to access your Switch via USB, not only _your_ user.

You may just follow the instructions at <a href="https://github.com/pheki/nx-udev" target="_blank">nx-udev</a>, or if you're on Ubuntu / Debian:
You may just follow the instructions at [nx-udev](https://github.com/pheki/nx-udev), or if you're on Ubuntu / Debian:

1. Download <a href="https://github.com/pheki/nx-udev/releases/latest/download/nx-udev_latest_all.deb
" target="_blank">nx-udev_latest_all.deb</a>.
2. Open a terminal in the same directory as your download.
3. Run `sudo dpkg -i nx-udev_latest_all.deb` to install the package
1. Download [nx-udev_latest_all.deb](https://github.com/pheki/nx-udev/releases/latest/download/nx-udev_latest_all.deb).
1. Open a terminal in the same directory as your download.
1. Run `sudo dpkg -i nx-udev_latest_all.deb` to install the package

You should now be able to run the payload injector and homebrew with USB communication without having to use `sudo`.
16 changes: 8 additions & 8 deletions docs/extras/alternate_bootsetups.md
View file
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.

&nbsp;

Expand All @@ -16,11 +16,11 @@ If you need to troubleshoot something, or need to try a different boot setup, re
#### **Instructions:**

1. Insert your Switch's microSD card into your PC.
2. Copy *the contents of* the Atmosphere `.zip` file to the root of your microSD card.
3. Copy the `bootloader` folder from the Hekate `.zip` file to the root of your microSD card.
4. Copy `fusee.bin` to the `sd:/bootloader/payloads` folder on your microSD card.
5. The setup is complete, you can inject the Hekate payload (Unpatched Switch users) or place the Hekate payload on the root of your microSD card and rename it to `payload.bin` (Modchipped Switch users).
6. Navigate to and select `Payloads` > `fusee.bin`.
1. Copy *the contents of* the Atmosphere `.zip` file to the root of your microSD card.
1. Copy the `bootloader` folder from the Hekate `.zip` file to the root of your microSD card.
1. Copy `fusee.bin` to the `sd:/bootloader/payloads` folder on your microSD card.
1. The setup is complete, you can inject the Hekate payload (Unpatched Switch users) or place the Hekate payload on the root of your microSD card and rename it to `payload.bin` (Modchipped Switch users).
1. Navigate to and select `Payloads` > `fusee.bin`.
- Note: `fusee` uses a set boot order that is not as easily configurable as Hekate. Its boot order is `emuMMC` > `sysCFW` > `stock`.
If an emuMMC isn't present, it will boot into sysCFW for example. Make sure you have a method of blocking Nintendo's servers set up (such as [DNS-MITM](../extras/blocking_nintendo.md/#instructions-ams-dns-redirection)) if you do use `fusee` and have an `emuMMC`.

Expand All @@ -37,7 +37,7 @@ This method will *not* work for Modchipped Switch users.
#### **Instructions:**

1. Insert your Switch's microSD card into your PC.
2. Copy *the contents of* the Atmosphere `.zip` file to the root of your microSD card.
3. The setup is complete, you can inject the `fusee.bin` payload.
1. Copy *the contents of* the Atmosphere `.zip` file to the root of your microSD card.
1. The setup is complete, you can inject the `fusee.bin` payload.
- Note: `fusee` uses a set boot order that is not as easily configurable as Hekate. Its boot order is `emuMMC` > `sysCFW` > `stock`.
If an emuMMC isn't present, it will boot into sysCFW for example. Make sure you have a method of blocking Nintendo's servers set up (such as [DNS-MITM](../extras/blocking_nintendo.md/#instructions-ams-dns-redirection)) if you do use `fusee` and have an `emuMMC`.
20 changes: 10 additions & 10 deletions docs/extras/autorcm.md
View file
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
1. Go to `Tools`, and select `Backup eMMC`
1. Then tap `eMMC BOOT0 & BOOT1` and let the process complete.

### **Disadvantages of AutoRCM**

There are some disadvantages you should consider before installing AutoRCM:

- Please keep in mind that the console can no longer boot on its own, so you'll need a PC, phone, or other payload injector to start the console after letting the console fully shut off. (AutoRCM by itself is considered a "tethered jailbreak").
- Note: Sleep Mode is not considered "powering off/on" the console. Sleep Mode will still work as intended and is fully unchanged with AutoRCM.
- Note: Sleep Mode is not considered "powering off/on" the console. Sleep Mode will still work as intended and is fully unchanged with AutoRCM.
- When completely discharged, your Switch will take a very long time to charge while in RCM. To solve this, charge the console for approximately twenty minutes before booting into Hekate and selecting a boot option. After it's done booting, the console will now charge at a normal speed with a battery icon in the corner.
- When a system update is completed while stock firmware is running, AutoRCM becomes disabled so you need to turn it on again. AutoRCM can be preserved by updating while CFW is active.

Expand All @@ -26,19 +26,19 @@ 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**

If, despite all of the information above, you still wish to enable (or disable) AutoRCM, and understand the risks, do the following:

1. Boot into Hekate
2. Go to `Tools`
3. At the bottom of the page, tap `Arch Bit • AutoRCM • Touch • Pkg1/2`
4. Then tap `AutoRCM`. It will show a little `ON` next to the option once you have done this.
1. Go to `Tools`
1. At the bottom of the page, tap `Arch Bit • AutoRCM • Touch • Pkg1/2`
1. Then tap `AutoRCM`. It will show a little `ON` next to the option once you have done this.
- If you wish to disable it instead, follow these same steps and ensure the `AutoRCM` option is set to `OFF`.
52 changes: 26 additions & 26 deletions docs/extras/blocking_nintendo.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ You can configure Atmosphère to automatically redirect any requests directed to

1. Enter RCM and inject the Hekate payload.
- If you use a modchipped Switch, you can simply just turn your Switch on with the Hekate payload renamed to `payload.bin` on the root of your SD.
2. Navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB.
3. Enter the `atmosphere` folder.
4. If it doesn't exist already, create a folder named `hosts` in the `atmosphere` folder.
1. Navigate to `Tools` > `USB Tools` > `SD Card` and plug your Switch into your PC via USB.
1. Enter the `atmosphere` folder.
1. If it doesn't exist already, create a folder named `hosts` in the `atmosphere` folder.
- You should end up with the `sd:/atmosphere/hosts` directory.
5. Copy the `emummc.txt` file into the hosts folder.
1. Copy the `emummc.txt` file into the hosts folder.
- If you want to apply the DNS redirection to sysmmc instead of emummc, rename the file to `sysmmc.txt`
6. Eject the `UMS` device safely from within your computer's operating system and boot into CFW.
1. Eject the `UMS` device safely from within your computer's operating system and boot into CFW.

!!! note "Verify functionality"
You can verify the functionality of the DNS redirection by booting into emummc (or sysmmc if you applied the config to sys), and powering off after.
Expand All @@ -42,33 +42,33 @@ Enter the console's System Settings, and then proceed to the Internet tab. From
Not all WiFi networks require a password to connect. If your network does not use one, you can use the `Manual Setup` option, located at the very bottom of the `Internet Settings` screen below all other WiFi networks.

1. Select your WiFi network from the list of networks.
2. Enter an **incorrect** password that is 8 characters long and press `OK`.
3. After a few moments of attempting to connect, the console will display a connection error.
4. Press `OK` to close the error message.
5. Press `Close` when it offers to display more details about the error.
6. When asked if you want to re-enter the password, pick `View Settings`.
7. Change `DNS Settings` to `Manual`.
8. Pick the server that is the closest to your location out of the below chart and enter its `Primary` and `Secondary` DNS into your connection settings.
9. Enter the correct password for your WiFi connection.
10. Save the settings and test the connection.
1. Enter an **incorrect** password that is 8 characters long and press `OK`.
1. After a few moments of attempting to connect, the console will display a connection error.
1. Press `OK` to close the error message.
1. Press `Close` when it offers to display more details about the error.
1. When asked if you want to re-enter the password, pick `View Settings`.
1. Change `DNS Settings` to `Manual`.
1. Pick the server that is the closest to your location out of the below chart and enter its `Primary` and `Secondary` DNS into your connection settings.
1. Enter the correct password for your WiFi connection.
1. Save the settings and test the connection.

-----

#### **Editing an existing WiFi connection**
1. Select your existing WiFi network from the list of networks.
2. Select `Change Settings`.
3. Pick the server that is the closest to your location out of the below chart and enter its Primary and Secondary DNS into your connection settings.
4. Save the settings and test the connection.
1. Select `Change Settings`.
1. Pick the server that is the closest to your location out of the below chart and enter its Primary and Secondary DNS into your connection settings.
1. Save the settings and test the connection.

-----

#### **Using homebrew to set 90DNS on all existing WiFi networks**
1. Download [switch-90dns-setter](https://github.com/suchmememanyskill/switch-90dns-setter/releases) and put it in the `/switch` folder.
2. Launch CFW and open the homebrew menu.
3. Launch `90DNS Setter`.
4. Press X to apply 90DNS to all WiFi networks.
5. Press Y to reboot the Switch.
6. Check in system settings if networks have a custom DNS applied.
1. Launch CFW and open the homebrew menu.
1. Launch `90DNS Setter`.
1. Press X to apply 90DNS to all WiFi networks.
1. Press Y to reboot the Switch.
1. Check in system settings if networks have a custom DNS applied.


| Location | Primary DNS | Secondary DNS |
Expand All @@ -88,13 +88,13 @@ Enter the console's System Settings, and then proceed to the Internet tab. From

#### **Testing via the eShop (Stock)**
1. Open the eShop. Wait until it either opens or displays an error.
2. If it displays "Unable to display page.", you seem to have blocked Nintendo's servers.
1. If it displays "Unable to display page.", you seem to have blocked Nintendo's servers.

#### **Testing via a homebrew app (CFW)**
1. Download the latest release of the [90DNS Tester](https://github.com/meganukebmp/Switch_90DNS_tester/releases)
2. Place the `Switch_90DNS_tester.nro` in the `switch` folder on your SD.
3. Enter the homebrew menu and run the 90DNS Tester.
4. After the test finished it should look similar to the below picture, with every `nintendo` domain being blocked.
1. Place the `Switch_90DNS_tester.nro` in the `switch` folder on your SD.
1. Enter the homebrew menu and run the 90DNS Tester.
1. After the test finished it should look similar to the below picture, with every `nintendo` domain being blocked.

!!! tip ""
![tester example](../extras/img/90dns_tester_switch.jpg)
12 changes: 6 additions & 6 deletions docs/extras/game_modding.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ LayeredFS, a tool built into Atmosphere, allows you to (temporarily) replace a g
Check the section below to find your mod's folder/file structure, then install your mod accordingly.

!!! note "**Checking folder/file structures**"
* If the mod solely includes a `romfs` (and/or `exefs` folder), you will need to place that folder inside of `sd:/atmosphere/contents/<title_id>/`.
- 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](https://switchbrew.org/wiki/Title_list/Games) and [nswdb](https://nswdb.com/).

* If the mod solely includes a `contents` folder, you can simply copy that folder to `sd:/atmosphere/` on your microSD card and merge folders if prompted.
- If the mod solely includes a `contents` folder, you can simply copy that folder to `sd:/atmosphere/` on your microSD card and merge folders if prompted.

* If the mod has the complete folder structure set up (i.e. `atmosphere/contents/<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.
- 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`**
Expand All @@ -32,11 +32,11 @@ If you want to disable mods on launch of a game, hold the `L` button before laun

While most games only require Atmosphere's LayeredFS to enable game modding, there are some games that may require more specialized setup. For example:

* Modding Super Smash Bros. requires [ARCropolis](https://github.com/Raytwo/ARCropolis/releases) and [skyline](https://github.com/skyline-dev/skyline/releases). Skyline's `exefs` folder goes into the `atmosphere/contents/01006A800016E000/` directory. ARCropolis looks for mods in the `sd:/ultimate/mods` directory on your microSD card.
- Modding Super Smash Bros. requires [ARCropolis](https://github.com/Raytwo/ARCropolis/releases) and [skyline](https://github.com/skyline-dev/skyline/releases). Skyline's `exefs` folder goes into the `atmosphere/contents/01006A800016E000/` directory. ARCropolis looks for mods in the `sd:/ultimate/mods` directory on your microSD card.

* Modding Breath of the Wild and Tears of the Kingdom with multiple mods requires the use of [BCML](https://github.com/NiceneNerd/BCML) or [UKMM](https://github.com/NiceneNerd/UKMM/releases) (Recommended) and [TKMM](https://github.com/TKMM-Team/Tkmm/releases) respectively.
- Modding Breath of the Wild and Tears of the Kingdom with multiple mods requires the use of [BCML](https://github.com/NiceneNerd/BCML) or [UKMM](https://github.com/NiceneNerd/UKMM/releases) (Recommended) and [TKMM](https://github.com/TKMM-Team/Tkmm/releases) respectively.

* Animal Crossing: New Horizons requires some extra setup for mods to work. The folder that would normally be called `romfs` has to be called `romFs` and you'll need to create an empty file inside of `atmosphere/contents/01006F8002326000/romFs/System/Resource/` called `ResourceSizeTable.srsizetable`. More information on this can be found on the [ac-modding website](https://ac-modding.com/ACNH/mods.html).
- Animal Crossing: New Horizons requires some extra setup for mods to work. The folder that would normally be called `romfs` has to be called `romFs` and you'll need to create an empty file inside of `atmosphere/contents/01006F8002326000/romFs/System/Resource/` called `ResourceSizeTable.srsizetable`. More information on this can be found on the [ac-modding website](https://ac-modding.com/ACNH/mods.html).

-----

Expand Down
Loading

0 comments on commit 30ff537

Please sign in to comment.