hacks-guide/Guide_3DS
1
0
Fork 0
mirror of https://github.com/hacks-guide/Guide_3DS.git synced 2025-02-16 23:48:34 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
Guide_3DS/docs/finalizing-setup.md

157 lines
7.8 KiB
Markdown
Raw Permalink Normal View History

docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
# Finalizing Setup
boot9strap
2017-05-19 21:03:56 -04:00
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
## Required Reading
boot9strap
2017-05-19 21:03:56 -04:00
finalizing-setup: qol, including moving src links - Reword Required Reading to be more clear about what the user has done (this line is a holdover from the Plailect days) - Move homebrew links to "source code" dropdown to avoid people accidentally clicking them - Add inline troubleshooting for missing title database
2025-02-16 05:40:27 -08:00
On the previous page, you installed boot9strap, a custom firmware loader that loads the file `boot.firm` from SD card or NAND (internal memory). In this case, we are using Luma3DS by [LumaTeam](https://github.com/LumaTeam/) as our `boot.firm` to patch the console, allowing it to run homebrew software.
cut down on the number of notices
2017-08-12 18:56:04 -04:00
finalize: switch to auto-script (#2249) it's real testing in production hours
2023-07-02 17:15:17 -07:00
On this page, we will make critical system file backups and install some homebrew programs. Most of these steps will be automated using a script that you will run on your console.
cut down on the number of notices
2017-08-12 18:56:04 -04:00
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
::: info
finalize: undropdown application list better for developer visibility + hard to find
2023-07-07 00:43:19 -07:00
The script will install the following applications:
finalize: switch to auto-script (#2249) it's real testing in production hours
2023-07-02 17:15:17 -07:00
finalizing-setup: qol, including moving src links - Reword Required Reading to be more clear about what the user has done (this line is a holdover from the Plailect days) - Move homebrew links to "source code" dropdown to avoid people accidentally clicking them - Add inline troubleshooting for missing title database
2025-02-16 05:40:27 -08:00
+ **FBI** by Steveice10 *(installs CIA formatted applications)*
+ **Homebrew Launcher Loader** by PabloMK7 *(runs Homebrew Launcher, for 3DSX format homebrew)*
+ **Anemone3DS** by astronautlevel2 *(installs custom themes, splashes, and badges)*
+ **Checkpoint** by BernardoGiordano/FlagBrew *(manages 3DS/DS game save data)*
+ **ftpd** by mtheall *(allows wireless 3DS SD card access over FTP)*
+ **Universal-Updater** by Universal-Team *(on-device app store for downloading homebrew over Wi-Fi)*
+ **GodMode9** by d0k3 *(multipurpose tool for extracting data from internal memory or cartridges)*
finalize: add how to remove if undesired
2023-07-07 01:28:39 -07:00
If you don't want one of these applications, you can remove them after you have finished this page by navigating to System Settings -> Data Management -> Nintendo 3DS -> Software. (GodMode9 cannot be removed in this way and is generally required for other functions.)
Finalizing Setup rework
2022-01-20 01:23:51 -08:00
finalizing-setup: qol, including moving src links - Reword Required Reading to be more clear about what the user has done (this line is a holdover from the Plailect days) - Move homebrew links to "source code" dropdown to avoid people accidentally clicking them - Add inline troubleshooting for missing title database
2025-02-16 05:40:27 -08:00
::: details Source code links (optional)
All applications installed on this guide are open-source. If you are interested in seeing how they work, or would like to leave a star to show your appreciation, their source code is linked here:
- [FBI](https://github.com/lifehackerhansol/FBI)
- [Homebrew Launcher Loader](https://github.com/PabloMK7/homebrew_launcher_dummy)
- [Anemone3DS](https://github.com/astronautlevel2/Anemone3DS)
- [Checkpoint](https://github.com/bernardogiordano/checkpoint/releases)
- [ftpd](https://github.com/mtheall/ftpd)
- [Universal-Updater](https://github.com/Universal-Team/Universal-Updater/)
- [GodMode9](https://github.com/d0k3/GodMode9)
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
:::
## Compatibility Notes
::: info
finalizing: re-add + re-word 2.1 warning
2022-01-20 15:11:12 -08:00
Finalizing Setup rework
2022-01-20 01:23:51 -08:00
If your previous CFW setup was EmuNAND-based and you wish to move the contents of your EmuNAND/RedNAND to SysNAND, follow [Move EmuNAND](move-emunand) before following this page. If you don't know what an EmuNAND is, this doesn't apply to you.
boot9strap
2017-05-19 21:03:56 -04:00
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
:::
## What You Need
Remove OCS I have changed my mind about sacrificing flexibility for convenience. OCS was too much of a black box which, while well intentioned, just didn't work very well in the environment we have available to us.
2017-09-17 01:32:43 -04:00
finalize: x_finalize_helper.firm finalize_helper now made to boot with X (formerly Twitter). This avoids conflicts/confusion w/ chainloader.
2024-08-14 01:26:13 +02:00
* [x_finalize_helper.firm](https://github.com/hacks-guide/finalize/releases/latest/download/x_finalize_helper.firm) (direct download)
finalize: anemone3ds 3.0.1 / misc - finalize: (Overdue) update anemone3ds to 3.0.1 hotfix - finalize: Direct link to GitHub releases page for finalize_helper.firm and finalize.romfs (so that manually updating assets is no longer necessary) - note: /assets/ copies of finalize.romfs and finalize_helper will be maintained in the meantime until translations catch up - troubleshooting: adjust mset9 error (error 18a/18b) to account for (overdue) new script behaviour
2024-06-30 04:32:28 +02:00
* [finalize.romfs](https://github.com/hacks-guide/finalize/releases/latest/download/finalize.romfs) (direct download)
Remove OCS I have changed my mind about sacrificing flexibility for convenience. OCS was too much of a black box which, while well intentioned, just didn't work very well in the environment we have available to us.
2017-09-17 01:32:43 -04:00
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
## Instructions
boot9strap
2017-05-19 21:03:56 -04:00
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
### Section I - Prep Work
Squashed revert of Luma3DS v12.0.1: --- Revert "safecerthax: use Luma3DS v12.0.1" This reverts commit 643d765387bf1eb12bc674394ed25bd88f596bc7. --- Revert "installing-boot9strap-(ntrboot): sync v12.0.1 release string with other pages" This reverts commit 96e5a8dde8d0f53cce6e03a62155e3902aa89c00. --- Revert "bb3-twn: use latest luma" This reverts commit 9eed676426eadc0160011a2fa3cb4e611d396a80. --- Revert "treewide: use luma latest; change finalize" This reverts commit 54fa51da39720f510ed47c31e51ad79135248de4. --- Revert "atob: specify 12.0.1 in instructions" This reverts commit 73a9ddb3c4aea4c4ff77318f9e91dea7e9cb4685. --- Revert "TEMP: use 12.0.1, update to 13.x in finalize" This reverts commit a2e847c7badaef12bdfce51529989914b7e5ee8c. --- Revert "TEMPORARY: use luma v12.0.1 for soundhax, ntrboot" This reverts commit b47ab171d1938522f26e79427ab104a9a2143541.
2023-08-13 22:05:14 -07:00
In this section, you will copy the files necessary to follow the rest of the instructions on this page.
1. Power off your console
1. Insert your SD card into your computer
finalizing: switch to file-management scriptrunner (#2427) choo choo, all aboard the train to OCS * finalizing: switch to file-management scriptrunner Switch to scriptrunner for file management (to lessen user error from incorrectly copying files). Thus, users will need to copy just two files: finalize_helper.firm to SD:/luma/payloads/ (which will have to be created by the user) and finalize.romfs (which ends up on root of SD). This change allows for better checking of file integrity and lessens the chance of user error from incorrectly copying files. The scriptrunner's task is to load finalize.romfs from the SD card, unpack it, and to copy its contents to root of SD. The intended location of finalize.romfs is root of SD, but the scriptrunner will attempt to move the file if it is found in SD:/Nintendo 3DS, SD:/DCIM, SD:/luma, or SD:/luma/payloads. Remove errors relating to missing files (since that should no longer be possible). Add visuals on the top screen for error resolution, with QR codes to the guide / NH where appropriate. * finalizing: inline chainloader in case people have more than one payload
2024-02-06 01:21:02 +01:00
1. Copy `finalize.romfs` to the root of your SD card
finalizing-setup: Hopefully clarify that the luma folder is on the SD card and not in the romfs
2024-02-16 19:01:37 -05:00
1. Open the `luma` folder on your SD card and create a folder named `payloads` inside, if it does not already exist
finalize: x_finalize_helper.firm finalize_helper now made to boot with X (formerly Twitter). This avoids conflicts/confusion w/ chainloader.
2024-08-14 01:26:13 +02:00
1. Copy `x_finalize_helper.firm` to the `payloads` folder
Re-sync a few strings
2023-08-15 11:23:51 -07:00
1. Reinsert your SD card into your console
Squashed revert of Luma3DS v12.0.1: --- Revert "safecerthax: use Luma3DS v12.0.1" This reverts commit 643d765387bf1eb12bc674394ed25bd88f596bc7. --- Revert "installing-boot9strap-(ntrboot): sync v12.0.1 release string with other pages" This reverts commit 96e5a8dde8d0f53cce6e03a62155e3902aa89c00. --- Revert "bb3-twn: use latest luma" This reverts commit 9eed676426eadc0160011a2fa3cb4e611d396a80. --- Revert "treewide: use luma latest; change finalize" This reverts commit 54fa51da39720f510ed47c31e51ad79135248de4. --- Revert "atob: specify 12.0.1 in instructions" This reverts commit 73a9ddb3c4aea4c4ff77318f9e91dea7e9cb4685. --- Revert "TEMP: use 12.0.1, update to 13.x in finalize" This reverts commit a2e847c7badaef12bdfce51529989914b7e5ee8c. --- Revert "TEMPORARY: use luma v12.0.1 for soundhax, ntrboot" This reverts commit b47ab171d1938522f26e79427ab104a9a2143541.
2023-08-13 22:05:14 -07:00
The screenshot below indicates the minimum SD card layout that is required to follow this page. You may have extra files or folders on your SD card, depending on your previous setup or the method that you followed.
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
::: info
![](/images/screenshots/finalizing-root-layout.png)
:::
Squashed revert of Luma3DS v12.0.1: --- Revert "safecerthax: use Luma3DS v12.0.1" This reverts commit 643d765387bf1eb12bc674394ed25bd88f596bc7. --- Revert "installing-boot9strap-(ntrboot): sync v12.0.1 release string with other pages" This reverts commit 96e5a8dde8d0f53cce6e03a62155e3902aa89c00. --- Revert "bb3-twn: use latest luma" This reverts commit 9eed676426eadc0160011a2fa3cb4e611d396a80. --- Revert "treewide: use luma latest; change finalize" This reverts commit 54fa51da39720f510ed47c31e51ad79135248de4. --- Revert "atob: specify 12.0.1 in instructions" This reverts commit 73a9ddb3c4aea4c4ff77318f9e91dea7e9cb4685. --- Revert "TEMP: use 12.0.1, update to 13.x in finalize" This reverts commit a2e847c7badaef12bdfce51529989914b7e5ee8c. --- Revert "TEMPORARY: use luma v12.0.1 for soundhax, ntrboot" This reverts commit b47ab171d1938522f26e79427ab104a9a2143541.
2023-08-13 22:05:14 -07:00
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
::: info
finalizing-setup: CFW check before doing system update I'm not even going to try to point people to the right direction from here, if they literally couldn't even get CFW installed and got to this page then they need help.
2023-05-22 20:17:45 -07:00
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
![](/images/screenshots/finalizing-luma-payloads.png)
:::
### Section II - Updating the System
boot9strap
2017-05-19 21:03:56 -04:00
super epic omega very cool explanations and pics
2022-10-01 15:55:27 -07:00
In this section, you will update your system to the latest version, which is safe to do with custom firmware.
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
<!--@include: ./_include/sysupdate.md -->
boot9strap
2017-05-19 21:03:56 -04:00
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
### Section III - RTC and DSP setup
finalizing: use luma for rtc/dsp setup
2022-03-20 00:53:15 -07:00
super epic omega very cool explanations and pics
2022-10-01 15:55:27 -07:00
In this section, you will sync your 3DS internal clock with the actual time and dump the sound firmware (which is necesssary for some homebrew software to use sound properly).
finalizing: use luma for rtc/dsp setup
2022-03-20 00:53:15 -07:00
1. Press (Left Shoulder) + (D-Pad Down) + (Select) at the same time to open the Rosalina menu
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
+ If one of these buttons is broken, download [config.ini](/assets/config.ini) and put it in your `luma` folder, replacing the existing one. This will change the Rosalina menu key combination to (X) + (Y)
finalizing: use luma for rtc/dsp setup
2022-03-20 00:53:15 -07:00
1. Select "Miscellaneous options"
1. Select "Dump DSP firmware"
1. Press (B) to continue
1. Select "Nullify user time offset"
1. Press (B) to continue
1. Press (B) to return to the Rosalina main menu
1. Press (B) to exit the Rosalina menu
boot9strap
2017-05-19 21:03:56 -04:00
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
### Section IV - Setup Script
super epic omega very cool explanations and pics
2022-10-01 15:55:27 -07:00
finalizing: switch to file-management scriptrunner (#2427) choo choo, all aboard the train to OCS * finalizing: switch to file-management scriptrunner Switch to scriptrunner for file management (to lessen user error from incorrectly copying files). Thus, users will need to copy just two files: finalize_helper.firm to SD:/luma/payloads/ (which will have to be created by the user) and finalize.romfs (which ends up on root of SD). This change allows for better checking of file integrity and lessens the chance of user error from incorrectly copying files. The scriptrunner's task is to load finalize.romfs from the SD card, unpack it, and to copy its contents to root of SD. The intended location of finalize.romfs is root of SD, but the scriptrunner will attempt to move the file if it is found in SD:/Nintendo 3DS, SD:/DCIM, SD:/luma, or SD:/luma/payloads. Remove errors relating to missing files (since that should no longer be possible). Add visuals on the top screen for error resolution, with QR codes to the guide / NH where appropriate. * finalizing: inline chainloader in case people have more than one payload
2024-02-06 01:21:02 +01:00
In this section, you will use a series of scripts to automate homebrew installation, SD card cleanup, and system file backup.
super epic omega very cool explanations and pics
2022-10-01 15:55:27 -07:00
treewide: s/device/console
2023-06-07 18:35:50 -07:00
1. Power off your console
finalize: x_finalize_helper.firm finalize_helper now made to boot with X (formerly Twitter). This avoids conflicts/confusion w/ chainloader.
2024-08-14 01:26:13 +02:00
1. Press and hold (X), and while holding (X), power on your console. This will launch the Finalizing Setup Helper
finalizing: switch to file-management scriptrunner (#2427) choo choo, all aboard the train to OCS * finalizing: switch to file-management scriptrunner Switch to scriptrunner for file management (to lessen user error from incorrectly copying files). Thus, users will need to copy just two files: finalize_helper.firm to SD:/luma/payloads/ (which will have to be created by the user) and finalize.romfs (which ends up on root of SD). This change allows for better checking of file integrity and lessens the chance of user error from incorrectly copying files. The scriptrunner's task is to load finalize.romfs from the SD card, unpack it, and to copy its contents to root of SD. The intended location of finalize.romfs is root of SD, but the scriptrunner will attempt to move the file if it is found in SD:/Nintendo 3DS, SD:/DCIM, SD:/luma, or SD:/luma/payloads. Remove errors relating to missing files (since that should no longer be possible). Add visuals on the top screen for error resolution, with QR codes to the guide / NH where appropriate. * finalizing: inline chainloader in case people have more than one payload
2024-02-06 01:21:02 +01:00
+ If you boot to the HOME Menu, your `payloads` folder may be incorrectly spelled or in the wrong location
treewide: link directly to troubleshooting fragments
2024-10-07 20:54:38 -07:00
+ If you encounter an error, consult the [troubleshooting](troubleshooting-finalizing-setup) page
finalizing: switch to file-management scriptrunner (#2427) choo choo, all aboard the train to OCS * finalizing: switch to file-management scriptrunner Switch to scriptrunner for file management (to lessen user error from incorrectly copying files). Thus, users will need to copy just two files: finalize_helper.firm to SD:/luma/payloads/ (which will have to be created by the user) and finalize.romfs (which ends up on root of SD). This change allows for better checking of file integrity and lessens the chance of user error from incorrectly copying files. The scriptrunner's task is to load finalize.romfs from the SD card, unpack it, and to copy its contents to root of SD. The intended location of finalize.romfs is root of SD, but the scriptrunner will attempt to move the file if it is found in SD:/Nintendo 3DS, SD:/DCIM, SD:/luma, or SD:/luma/payloads. Remove errors relating to missing files (since that should no longer be possible). Add visuals on the top screen for error resolution, with QR codes to the guide / NH where appropriate. * finalizing: inline chainloader in case people have more than one payload
2024-02-06 01:21:02 +01:00
1. If the Helper was successful, your console will boot into GodMode9
+ From this point forward, you can access GodMode9 by holding START while powering on your console
setup ctrnand luma3ds script
2017-07-16 16:30:57 -04:00
1. If you are prompted to create an essential files backup, press (A) to do so, then press (A) to continue once it has completed
GM9 RTC and Scripts changes (Close #1339)
2017-09-16 15:47:08 -04:00
1. If you are prompted to fix the RTC date&time, press (A) to do so, then set the date and time, then press (A) to continue
setup ctrnand luma3ds script
2017-07-16 16:30:57 -04:00
1. Press (Home) to bring up the action menu
1. Select "Scripts..."
finalize: switch to auto-script (#2249) it's real testing in production hours
2023-07-02 17:15:17 -07:00
1. Select "finalize"
finalizing: script v1.3.0 - Move script backups to /gm9/backups/. - Remove redundant silent A:/backups/essential.exefs backup. - Fix logical error relating to moving Nintendo 3DS folder off of SD card. - If Nintendo 3DS folder is not detected, script will now propmt user to skip to making a NAND backup - This will create a file in SD:/gm9/flags/ called BACKUPFLAG - If this flag is present when the Nintendo 3DS folder is present (re-added), the script will tell the user that a NAND backup likely already exists and prompt the user to either create another backup or to skip creating the backup - Move database dummyflag from A:/dbs/ to SD:/gm9/flags/ - Change errors to error levels, and adjust top screen accordingly - "Information" indicates that the user didn't do anything wrong, but that the user must do something that deviates from the normal guide (e.g. create title database, NAND backup flag tripped) - indicated on top screen with `(i)` - "Warning" indicates that the script will continue, but will not complete as intended (e.g. no Nintendo 3DS folder) - indicated on top screen with `/!\` - "Error" indicates that the script cannot continue due to user error (incorrect GM9 version, missing files, etc) - indicated on top screen with `:(` - "Fatal Error" indicates that the script has triggered an error that should not occur and requires debugging (CIA install fail, invalid SD size) - indicated on top screen with `wtf?` Guide also adjusted accordingly.
2023-07-06 03:11:29 -07:00
1. Follow the prompts in the script, answering any questions that you are asked
finalizing-setup: qol, including moving src links - Reword Required Reading to be more clear about what the user has done (this line is a holdover from the Plailect days) - Move homebrew links to "source code" dropdown to avoid people accidentally clicking them - Add inline troubleshooting for missing title database
2025-02-16 05:40:27 -08:00
+ If you see "Information #05: No title database", press (A) to import and enter the buttons on-screen to proceed
treewide: link directly to troubleshooting fragments
2024-10-07 20:54:38 -07:00
+ If you encounter an error, follow the instructions in the error message or consult the [troubleshooting](troubleshooting-finalizing-setup) page
finalize: switch to auto-script (#2249) it's real testing in production hours
2023-07-02 17:15:17 -07:00
1. Once the script says "Setup complete!", press (A) to power off the device
finalizing: switch to file-management scriptrunner (#2427) choo choo, all aboard the train to OCS * finalizing: switch to file-management scriptrunner Switch to scriptrunner for file management (to lessen user error from incorrectly copying files). Thus, users will need to copy just two files: finalize_helper.firm to SD:/luma/payloads/ (which will have to be created by the user) and finalize.romfs (which ends up on root of SD). This change allows for better checking of file integrity and lessens the chance of user error from incorrectly copying files. The scriptrunner's task is to load finalize.romfs from the SD card, unpack it, and to copy its contents to root of SD. The intended location of finalize.romfs is root of SD, but the scriptrunner will attempt to move the file if it is found in SD:/Nintendo 3DS, SD:/DCIM, SD:/luma, or SD:/luma/payloads. Remove errors relating to missing files (since that should no longer be possible). Add visuals on the top screen for error resolution, with QR codes to the guide / NH where appropriate. * finalizing: inline chainloader in case people have more than one payload
2024-02-06 01:21:02 +01:00
+ If you do NOT see the message "Setup complete!", the script was not successful and you will need to redo this section from Step 3
finalizing: tell people to backup gm9/out also adds explanation of what each file is
2023-07-03 05:10:14 -07:00
1. Insert your SD card into your computer
finalizing: script v1.3.0 - Move script backups to /gm9/backups/. - Remove redundant silent A:/backups/essential.exefs backup. - Fix logical error relating to moving Nintendo 3DS folder off of SD card. - If Nintendo 3DS folder is not detected, script will now propmt user to skip to making a NAND backup - This will create a file in SD:/gm9/flags/ called BACKUPFLAG - If this flag is present when the Nintendo 3DS folder is present (re-added), the script will tell the user that a NAND backup likely already exists and prompt the user to either create another backup or to skip creating the backup - Move database dummyflag from A:/dbs/ to SD:/gm9/flags/ - Change errors to error levels, and adjust top screen accordingly - "Information" indicates that the user didn't do anything wrong, but that the user must do something that deviates from the normal guide (e.g. create title database, NAND backup flag tripped) - indicated on top screen with `(i)` - "Warning" indicates that the script will continue, but will not complete as intended (e.g. no Nintendo 3DS folder) - indicated on top screen with `/!\` - "Error" indicates that the script cannot continue due to user error (incorrect GM9 version, missing files, etc) - indicated on top screen with `:(` - "Fatal Error" indicates that the script has triggered an error that should not occur and requires debugging (CIA install fail, invalid SD size) - indicated on top screen with `wtf?` Guide also adjusted accordingly.
2023-07-06 03:11:29 -07:00
1. Copy the `/gm9/backups/` folder to a safe location on your computer
treewide: two space indent -> four space indent Apparently, this is the correct way to do markdown indents. This should allow portability of markdown files, should we ever move elsewhere.
2023-07-19 19:28:01 -07:00
+ This folder contains critical file backups and should be backed up to multiple locations (i.e. cloud storage) if possible
+ The two SysNAND files are your NAND backup and can be used to revert your console to a working state if it is bricked by a software issue
+ The `essential.exefs` file contains your console's system-unique files and can be used to recover your data in the event of a hardware failure
finalizing: script v1.3.0 - Move script backups to /gm9/backups/. - Remove redundant silent A:/backups/essential.exefs backup. - Fix logical error relating to moving Nintendo 3DS folder off of SD card. - If Nintendo 3DS folder is not detected, script will now propmt user to skip to making a NAND backup - This will create a file in SD:/gm9/flags/ called BACKUPFLAG - If this flag is present when the Nintendo 3DS folder is present (re-added), the script will tell the user that a NAND backup likely already exists and prompt the user to either create another backup or to skip creating the backup - Move database dummyflag from A:/dbs/ to SD:/gm9/flags/ - Change errors to error levels, and adjust top screen accordingly - "Information" indicates that the user didn't do anything wrong, but that the user must do something that deviates from the normal guide (e.g. create title database, NAND backup flag tripped) - indicated on top screen with `(i)` - "Warning" indicates that the script will continue, but will not complete as intended (e.g. no Nintendo 3DS folder) - indicated on top screen with `/!\` - "Error" indicates that the script cannot continue due to user error (incorrect GM9 version, missing files, etc) - indicated on top screen with `:(` - "Fatal Error" indicates that the script has triggered an error that should not occur and requires debugging (CIA install fail, invalid SD size) - indicated on top screen with `wtf?` Guide also adjusted accordingly.
2023-07-06 03:11:29 -07:00
1. If you still have them, delete the two `SysNAND` files from the `/gm9/backups/` folder from your SD card
treewide: two space indent -> four space indent Apparently, this is the correct way to do markdown indents. This should allow portability of markdown files, should we ever move elsewhere.
2023-07-19 19:28:01 -07:00
+ The `essential.exefs` file is small and may be kept on your SD card for ease of access
boot9strap
2017-05-19 21:03:56 -04:00
___
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
::: tip
treewide: s/device/console
2023-06-07 18:35:50 -07:00
You're done! Custom firmware is now fully configured on your console.
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
:::
::: info
boot9strap
2017-05-19 21:03:56 -04:00
finalizing: it's wiki time
2023-07-05 00:08:37 -07:00
Trying to figure out what to do with your newly modded device? Visit [our wiki](https://wiki.hacks.guide/wiki/3DS:Things_to_do)!
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
:::
finalizing: it's wiki time
2023-07-05 00:08:37 -07:00
finalizing: switch to file-management scriptrunner (#2427) choo choo, all aboard the train to OCS * finalizing: switch to file-management scriptrunner Switch to scriptrunner for file management (to lessen user error from incorrectly copying files). Thus, users will need to copy just two files: finalize_helper.firm to SD:/luma/payloads/ (which will have to be created by the user) and finalize.romfs (which ends up on root of SD). This change allows for better checking of file integrity and lessens the chance of user error from incorrectly copying files. The scriptrunner's task is to load finalize.romfs from the SD card, unpack it, and to copy its contents to root of SD. The intended location of finalize.romfs is root of SD, but the scriptrunner will attempt to move the file if it is found in SD:/Nintendo 3DS, SD:/DCIM, SD:/luma, or SD:/luma/payloads. Remove errors relating to missing files (since that should no longer be possible). Add visuals on the top screen for error resolution, with QR codes to the guide / NH where appropriate. * finalizing: inline chainloader in case people have more than one payload
2024-02-06 01:21:02 +01:00
### Information and Notes
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
::: info
Grammarly suggestions
2022-01-30 19:31:57 +01:00
Here are some key combos that you should know:
Tell users how they can upgrade to a new SD card at the end of the guide (#1540)
2018-06-15 02:07:35 +01:00
treewide: standardize bullet points, miscellaneous formatting fixes What You Need: * All others: + Add newline to end of all files. Convert all indentation to spaces except console output in f3-(linux).
2023-07-22 13:58:11 -07:00
+ Holding (Select) on boot will launch the Luma3DS configuration menu.
+ Holding (Start) on boot will launch GodMode9, or if you have multiple payloads in `/luma/payloads/`, the Luma3DS chainloader.
+ By default, pressing (Left Shoulder) + (Down D-Pad) + (Select) while in 3DS mode will open the Rosalina menu, where you can check system information, take screenshots, enable cheats, and more. This can be changed from the Rosalina menu.
+ Holding (Start) + (Select) + (X) on boot will make the notification LED show a color for debug purposes. See the [changelog](https://github.com/SciresM/boot9strap/releases/tag/1.4) for a list.
Tell users how they can upgrade to a new SD card at the end of the guide (#1540)
2018-06-15 02:07:35 +01:00
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
:::
::: info
Tell users how they can upgrade to a new SD card at the end of the guide (#1540)
2018-06-15 02:07:35 +01:00
Finalizing Setup rework
2022-01-20 01:23:51 -08:00
For information on using GodMode9's various features, check out the [GodMode9 Usage](godmode9-usage) and [Dumping Titles and Game Cartridges](dumping-titles-and-game-cartridges) pages.
docs: port to VitePress Things that happen in this shameless squash: - Removed 404 page - It doesn't work in VitePress and making it work in VitePress needs some invasive hack in the theme that I'm not willing to do - The default is more than enough, though - Moved consoleVersionSelect include to another directory - This avoids being uploaded to Crowdin for translation - Inline all SafeB9SInstaller includes - Not only do parameterized includes not work, but if/else statements don't work at all - The sysupdate include parameter hasn't been used since MSET9, so it actually works just fine without any parameters. Hooray(?) - Move mset9-chorus to an include, that logic doesn't work in VitePress - Removed Get Started button from homepage, it breaks translations - Tables in get-started are now shown by default; it seems VitePress really does not want us to use inline script. So we cannot enable it upon realizing that the browser is JS capable - Include parameters are now in frontmatter to allow translation - Hacked in a bunch of CSS values kanged from the old theme to make it look not stupid - Drop headers down one level to make table of contents work
2024-09-16 01:58:08 -07:00
:::
Reference in New Issue Copy Permalink