diff --git a/docs/extras/installing_android.md b/docs/extras/installing_android.md index 7bb7950..0bcca56 100644 --- a/docs/extras/installing_android.md +++ b/docs/extras/installing_android.md @@ -19,10 +19,12 @@ This page assumes that you've followed our guide to partition your microSD card Click the following link to continue to the official LineageOS documentation for installing Android 15 (external link): ::: tip -[Install Android 15](https://wiki.lineageos.org/devices/nx_tab/) -::: -* **Note:** You can skip the partitioning mentioned in the LineageOS documentation. You already did this during the guide and do *not* have to do so again. +Install Android 15 → + +**Note:** You can skip the partitioning mentioned in the LineageOS documentation. You already did this during the guide and do *not* have to do so again. + +::: If you already have Android fully installed, do not follow this guide, as your current installation would be erased. diff --git a/docs/extras/installing_linux.md b/docs/extras/installing_linux.md index 0a640cd..6d9fb43 100644 --- a/docs/extras/installing_linux.md +++ b/docs/extras/installing_linux.md @@ -16,12 +16,12 @@ Click the following link to continue to the official Switchroot documentation fo ::: tip -[Install a Linux Distribution](https://wiki.switchroot.org/wiki/linux/linux-distributions) +Install a Linux Distribution → + +**Note:** You can skip the partitioning mentioned in the Switchroot documentation. You already did this during the guide and do *not* have to do so again. ::: -* **Note:** You can skip the partitioning mentioned in the Switchroot documentation. You already did this during the guide and do *not* have to do so again. - If you already have Linux fully installed, do not follow this guide, as your current installation would be erased. --- diff --git a/docs/index.md b/docs/index.md index 7b681b4..75bf200 100644 --- a/docs/index.md +++ b/docs/index.md @@ -119,7 +119,13 @@ If you choose the emuMMC path introduced later in the guide, you will also need If you must use a smaller microSD card or don't wish to use an emuMMC, you can choose to use the sysCFW path instead. -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 of the guide). 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. +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 of the guide). While *technically* possible with household items, we do not support this method of entering RCM, you will want to shell money out for an "RCM jig" that inserts into the right-hand Joy-Con rail to reliably enter RCM. + +### Important Information + +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](https://www.nintendo.com/games/detail/fallout-shelter-switch/)), application (like [YouTube](https://www.nintendo.com/games/detail/youtube-switch/)), or a game demo (like [10 Second Run RETURNS](https://www.nintendo.com/games/detail/10-second-run-returns-switch)). 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 launchable title, you are prepared to continue on with the guide. ## What else should I know before proceeding? @@ -157,7 +163,7 @@ If your English isn't the best, use a translator such as [Google Translate](http ::: tip -**Compatability** +**Compatibility** This guide will work on first-generation (V1) and modchipped Switch consoles in all regions on any firmware version. @@ -165,15 +171,19 @@ This guide will work on first-generation (V1) and modchipped Switch consoles in ## Ready to start? -If so, please follow the link below to proceed to the main guide. +If so, please click the button below to proceed to the main guide. -::: tip +::::: cards -[Continue to Getting Started](user_guide/getting_started) +:::: card + +Continue to Getting Started → Once you have finished reading the above information, proceed to Get Started to determine your console exploitability, and resulting exploit method. -::: +:::: + +::::: --- @@ -199,10 +209,6 @@ Once you have finished reading the above information, proceed to Get Started to A: The Switch will otherwise try to connect to Nintendo servers before starting apps, which can lead to unexpected delays and make emuMMCs completely unusable. -* **Q: Can I follow this guide if I have a smaller microSD card, and what are the risks involved in choosing the sysCFW path?** - - A: Nothing stops you from using sysCFW, but it is recommended for first-timers to get familiar with CFW by starting with an emuMMC. If used improperly, running sysCFW can cause software bricks and/or [bans](https://nx.eiphax.tech/ban.html). - * **Q: 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. @@ -210,5 +216,9 @@ Once you have finished reading the above information, proceed to Get Started to * **Q: Is there any community support or forums recommended for users who may have questions or issues during the process?** A: Of course! As well as the [Nintendo Homebrew Discord server](https://discord.gg/C29hYvh), you can also try the [r/SwitchHacks subreddit](https://www.reddit.com/r/SwitchHacks/)! + +* **Q: 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. ::: diff --git a/docs/user_guide/all/cfw_environment.md b/docs/user_guide/all/cfw_environment.md index a2d1fd3..0840bba 100644 --- a/docs/user_guide/all/cfw_environment.md +++ b/docs/user_guide/all/cfw_environment.md @@ -20,8 +20,6 @@ For more information on terminology, please refer to the [glossary](../../extras **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. ---- - ::::: cards :::: card @@ -68,7 +66,7 @@ This path of the guide ***also*** includes sysCFW as launch option. To proceed with CFW on **emuMMC**, click on the button below: -[Continue with the emuMMC path](../all/partitioning_sd) +Continue with the emuMMC path → ::: @@ -102,13 +100,11 @@ To proceed with CFW on **emuMMC**, click on the button below: 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 utilized for online play. ---- - ::: info To proceed with CFW on **sysMMC**, click on the button below: -[Continue with the sysCFW path](../all/partitioning_sd_syscfw) +Continue with the sysCFW path → ::: diff --git a/docs/user_guide/all/launching_cfw.md b/docs/user_guide/all/launching_cfw.md index 5e755ad..d0e7462 100644 --- a/docs/user_guide/all/launching_cfw.md +++ b/docs/user_guide/all/launching_cfw.md @@ -1,4 +1,5 @@ --- +aside: false outline: false --- @@ -86,17 +87,25 @@ If you wish to install more homebrew apps, place them (`.nro` files) in the `swi If you've partitioned your microSD card for preparation of Android/Linux earlier, you can continue with installing either operating system with the guides below: -::: tip +::::: cards -[Android installation guide](../../extras/installing_android) +:::: card -::: +Click the button below to continue to the Android installation guide! -::: tip +Android installation guide → -[Linux installation guide](../../extras/installing_linux) +:::: -::: +:::: card + +Click the button below to continue to the Linux installation guide! + +Linux installation guide → + +:::: + +::::: ::: details Frequently Asked Questions about this page diff --git a/docs/user_guide/all/making_essential_backups.md b/docs/user_guide/all/making_essential_backups.md index 5d55988..0e2538f 100644 --- a/docs/user_guide/all/making_essential_backups.md +++ b/docs/user_guide/all/making_essential_backups.md @@ -1,3 +1,8 @@ +--- +aside: false +outline: false +--- + # Making Essential Backups This guide will instruct you on how to create a NAND backup of your Nintendo Switch. @@ -51,21 +56,25 @@ hekate will stop producing these parts when it runs out of space. When this happ ## Booting into CFW -::: tip +::::: cards -Click the link below to continue to Launching **emuMMC**! +:::: card -[Launching CFW (emuMMC)](launching_cfw?tab=instructions-for-emummc) +Click the button below to continue to Launching **emuMMC**! -::: +Launching CFW (emuMMC) → -::: tip +:::: -Click the link below to continue to Launching **sysCFW**! +:::: card -[Launching CFW (sysCFW)](launching_cfw?tab=instructions-for-syscfw) +Click the button below to continue to Launching **sysCFW**! -::: +Launching CFW (sysCFW) → + +:::: + +::::: ::: details Frequently Asked Questions about this page diff --git a/docs/user_guide/all/partitioning_sd.md b/docs/user_guide/all/partitioning_sd.md index 6ee9fbc..25f443d 100644 --- a/docs/user_guide/all/partitioning_sd.md +++ b/docs/user_guide/all/partitioning_sd.md @@ -38,8 +38,15 @@ If your microSD card isn't showing up at all, ensure that you're using a USB cab ![hekate-partitioning-emu](img/hekate-partitioning-emu.png) -::: tip +::::: cards -[Continue to SD Preparations](sd_preparation) +:::: card + +Click the button below to continue to SD Preparations. + +Continue to SD Preparations → + +:::: + +::::: -::: diff --git a/docs/user_guide/all/partitioning_sd_syscfw.md b/docs/user_guide/all/partitioning_sd_syscfw.md index fd3457f..2fe2996 100644 --- a/docs/user_guide/all/partitioning_sd_syscfw.md +++ b/docs/user_guide/all/partitioning_sd_syscfw.md @@ -32,8 +32,14 @@ If your microSD card isn't showing up at all, ensure that you're using a USB cab ![hekate-partitioning-emu](img/hekate-partitioning-sys.png) -::: tip +::::: cards -[Continue to SD Preparations](sd_preparation) +:::: card -::: +Click the button below to continue to SD Preparations. + +Continue to SD Preparations → + +:::: + +::::: diff --git a/docs/user_guide/all/sd_preparation.md b/docs/user_guide/all/sd_preparation.md index 09f4b3b..1ef3db5 100644 --- a/docs/user_guide/all/sd_preparation.md +++ b/docs/user_guide/all/sd_preparation.md @@ -145,8 +145,14 @@ Below you will find the full folder/file structure on your microSD card. :::: -::: tip +::::: cards -[Continue to Making Essential Backups](making_essential_backups) +:::: card -::: +Click the button below to continue to Making Essential Backups. + +Continue to Making Essential Backups → + +:::: + +::::: diff --git a/docs/user_guide/getting_started.md b/docs/user_guide/getting_started.md index b104831..43f335f 100644 --- a/docs/user_guide/getting_started.md +++ b/docs/user_guide/getting_started.md @@ -1,3 +1,8 @@ +--- +aside: false +outline: false +--- + # Getting Started ::: tip @@ -24,34 +29,40 @@ Patched and Mariko units can be identified by their serial number. This number c 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 besides installing a modchip (hardware modification. It **requires** experience with microsoldering.). +::: info -::: tip - -**Notice** - -If you are unsure if your serial is patched, you can test your console yourself following the instructions on the [sending RCM payload](rcm/sending_payload) page. +Enter your Switch serial number to check if it's exploitable via RCM: + ::: -## Serial list +If you would rather look at a table containing serial number ranges, unfold the `Serial list` section below. +::: details Serial list The following information is based on [this GBATemp thread](https://gbatemp.net/threads/switch-informations-by-serial-number-read-the-first-post-before-asking-questions.481215/). | Serial Numbers | Unpatched | Potentially patched | Patched | | :------------- | :----------------------------------------- | :---------------------------------------------------- | :------------------------------------- | -| XAW1 | XAW10000000000 to XAW10074000000 | XAW10074000000 to XAW10120000000 | XAW10120000000 and up | +| XAW1 | XAW10000000000 to XAW10065000000 | XAW10065000000 to XAW10120000000 | XAW10120000000 and up | | XAW4 | XAW40000000000 to XAW40011000000 | XAW40011000000 to XAW40012000000 | XAW40012000000 and up | -| XAW7 | XAW70000000000 to XAW70017800000 | XAW70017800000 to XAW70030000000 | XAW70030000000 and up | +| XAW7 | XAW70000000000 to XAW70017500000 | XAW70017500000 to XAW70030000000 | XAW70030000000 and up | +| XAW9 | **N/A** | XAW90000000000 and up | **N/A** | | XAJ1 | XAJ10000000000 to XAJ10020000000 | XAJ10020000000 to XAJ10030000000 | XAJ10030000000 and up | -| XAJ4 | XAJ40000000000 to XAJ40046000000 | XAJ40046000000 to XAJ40060000000 | XAJ40060000000 and up | +| XAJ4 | XAJ40000000000 to XAJ40044000000 | XAJ40044000000 to XAJ40083000000 | XAJ40083000000 and up | | XAJ7 | XAJ70000000000 to XAJ70040000000 | XAJ70040000000 to XAJ70050000000 | XAJ70050000000 and up | | XAK1 | **N/A** | XAK10000000000 and up | **N/A** | If your serial number is not listed above, your device is not vulnerable to the fusee-gelee exploit. -## Version Table +::: + +## Firmware Version Table + +The table below shows firmware version information regarding the available exploits based on the firmware version your Switch is on. Any firmware version past `4.1.0` is not vulnerable to software exploits. + +* **RCM** means your Switch is vulnerable to the fusee-gelee exploit in RCM. +* **Caffeine** is an old software exploit that works with firmware version `4.1.0`. +* **Modchip** means you need to have a modchipped Switch. | System Version | Unpatched Switch Systems | Patched or Mariko Switch Systems | | :------------- | :----------------------- | :------------------------------- | @@ -59,47 +70,32 @@ If your serial number is not listed above, your device is not vulnerable to the | 4.1.0 | [**RCM**](rcm/index) | Caffeine | | 5.0.0+ | [**RCM**](rcm/index) | [**Modchip**](modchip/index) | -::: tip +## Continue with the right path for your Switch -**About Mariko Switch models** +::::: cards -All Mariko (V2) Switch models (`HAC-001(-01)`, `HDH-001`, `HEG-001`) are un-hackable via software. If **Modchip** is listed as a method for your console model, then that means the device is un-hackable without a hardware modification (modchip). This guide assumes you have a functional modchip installation if you *do* have a Patched console. - -::: - -## **Console Preparation** - -### Important Information - -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](https://www.nintendo.com/games/detail/fallout-shelter-switch/)), application (like [YouTube](https://www.nintendo.com/games/detail/youtube-switch/)), or a game demo (like [10 Second Run RETURNS](https://www.nintendo.com/games/detail/10-second-run-returns-switch)). 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 +:::: card **If your Switch is not patched, click the button below to follow the RCM path of the guide.** -[Continue to RCM](rcm/index) +Continue to RCM → -::: +:::: -::: tip +:::: card **If your Switch is patched and modchipped, click the button below to follow the Modchip path of the guide.** -[Continue to Modchip introduction](modchip/index) +Continue to Modchip introduction → -::: +:::: + +::::: ::: details 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. + ::: diff --git a/docs/user_guide/modchip/index.md b/docs/user_guide/modchip/index.md index efcda64..5255250 100644 --- a/docs/user_guide/modchip/index.md +++ b/docs/user_guide/modchip/index.md @@ -6,12 +6,12 @@ A modchip is a physical modification to the motherboard of your Switch. It canno ::: tip -[Modchip Installation guide](https://guide.nx-modchip.info/) - -::: +Modchip Installation guide → **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](https://github.com/Qyriad/fusee-launcher/blob/master/report/fusee_gelee.md), which "unpatched" consoles use. @@ -48,21 +48,27 @@ If you do decide to follow the recommended emuMMC path later in the guide, make **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. +We **ONLY** support the Picofly modchip (`RP2040` microcontroller based development boards and "pre-made" modchips). + +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. ::: -::: tip +::::: cards -[Continue to Preparing hekate](preparing_hekate) +:::: card -::: +Click the button below to continue to Preparing hekate. + +Continue to Preparing hekate → + +:::: + +::::: ::: details Frequently Asked Questions about this page diff --git a/docs/user_guide/modchip/preparing_hekate.md b/docs/user_guide/modchip/preparing_hekate.md index e148ddf..2191bb6 100644 --- a/docs/user_guide/modchip/preparing_hekate.md +++ b/docs/user_guide/modchip/preparing_hekate.md @@ -34,11 +34,17 @@ If your Switch does not load into the hekate GUI, or shows a `No SD Card`/`No Pa ::: -::: tip +::::: cards -[Continue to choosing your CFW environment](../all/cfw_environment) +:::: card -::: +Click the button below to continue to choosing your CFW environment. + +Continue to choosing your CFW environment → + +:::: + +::::: ::: details Frequently Asked Questions about this page diff --git a/docs/user_guide/rcm/entering_rcm.md b/docs/user_guide/rcm/entering_rcm.md index 44826ae..5993264 100644 --- a/docs/user_guide/rcm/entering_rcm.md +++ b/docs/user_guide/rcm/entering_rcm.md @@ -162,8 +162,14 @@ Here is an example from `sonlen` on our Discord server. ::::: -::: tip +::::: cards -[Continue to Sending a Payload](sending_payload) +:::: card -::: +Click the button below to continue to Sending a Payload. + +Continue to Sending a Payload → + +:::: + +::::: diff --git a/docs/user_guide/rcm/index.md b/docs/user_guide/rcm/index.md index 28c15a5..223a568 100644 --- a/docs/user_guide/rcm/index.md +++ b/docs/user_guide/rcm/index.md @@ -4,11 +4,17 @@ RCM (short for **R**e**C**overy **M**ode) is a pre-boot mode for Tegra processor If you choose the emuMMC path introduced later in the guide, it'll be important to disable the [Automatic Save Data Cloud](https://en-americas-support.nintendo.com/app/answers/detail/a_id/41209) function beforehand, as well as making sure [the Switch is set as the primary Pass-Enabled console](https://en-americas-support.nintendo.com/app/answers/detail/a_id/41221/~/how-to-set-or-change-the-primary-nintendo-switch-console-for-a-nintendo-account). -::: tip +::::: cards -[Continue to Entering RCM](entering_rcm) +:::: card -::: +Click the button below to continue to Entering RCM. + +Continue to Entering RCM → + +:::: + +::::: ::: details Frequently Asked Questions about this page diff --git a/docs/user_guide/rcm/sending_payload.md b/docs/user_guide/rcm/sending_payload.md index ba0e77c..a7e236f 100644 --- a/docs/user_guide/rcm/sending_payload.md +++ b/docs/user_guide/rcm/sending_payload.md @@ -117,7 +117,7 @@ If you experience issues with JTegraNX, you just want to try a different payload :::: -:::: tab Mac +:::: tab macOS ### Section I - Requirements @@ -231,8 +231,14 @@ Later in the guide, you will be formatting and/or partitioning your microSD card ![Nyx](../all/img/nyx.bmp){ width="600" } -::: tip +::::: cards -[Continue to choosing your CFW environment](../all/cfw_environment) +:::: card -::: +Click the button below to continue to choosing your CFW environment. + +Continue to choosing your CFW environment → + +:::: + +::::: diff --git a/package-lock.json b/package-lock.json index fad65a4..8ed37e0 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11,7 +11,11 @@ "markdown-it-container": "4.0.0" }, "devDependencies": { +<<<<<<< Updated upstream "vitepress": "2.0.0-alpha.16" +======= + "vitepress": "^2.0.0-alpha.16" +>>>>>>> Stashed changes } }, "node_modules/@babel/helper-string-parser": {