Skip to content

Commit d9585d1

Browse files
author
rlaphoenix
authored
Update README.md
1 parent daa2591 commit d9585d1

1 file changed

Lines changed: 37 additions & 18 deletions

File tree

README.md

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,18 @@ NTON is a Nintendo Switch NRO to NSP Forwarder for firmware 12.0.0 and newer.
1414
A forwarder lets you open Homebrew files from your SD card through the Nintendo Switch Home Screen instead
1515
of the Homebrew Launcher.
1616

17+
> [!TIP]
18+
> Want to generate NSP forwarders directly on your Switch via Homebrew? Check out [TooTallNate's switch-nsp-forwarder](https://github.com/TooTallNate/switch-nsp-forwarder)!
19+
1720
<img src="https://user-images.githubusercontent.com/17136956/206882948-4f05cace-16a3-4300-9047-8cba33106a64.jpg" style="width:505px" />
1821

22+
> [!CAUTION]
23+
> Installing NSP files, like NRO to NSP forwarders, can result in your console getting banned as they do not contain valid signatures verified by Nintendo.
24+
> This applies to all forms of NRO to NSP forwarders, including homebrew and web versions. We do not possess Nintendo's private key to generate valid signatures.
25+
> NSP forwarders are only safe if used on an emuMMC with all Nintendo servers blocked with [DNS.mitm](https://github.com/Atmosphere-NX/Atmosphere/blob/master/docs/features/dns_mitm.md).
26+
> Do not install them on sysMMC (system eMMC/NAND). Do not use 90DNS or any manual DNS server approach. DNS.mitm is a much safer and faster approach.
27+
> To run NSP forwarders you need to make further modifications to the boot process and your system. I do not support Piracy on any Nintendo device therefore support on that is not provided.
28+
1929
## Features
2030

2131
- ⚙ Firmware 12.0.0+ Support
@@ -41,7 +51,7 @@ $ pip install nton[gui]
4151

4252
*(Exclude `[gui]` if you do not plan on using the GUI)*
4353

44-
> **Note**
54+
> [!NOTE]
4555
If pip gives you a warning about a path not being in your PATH environment variable then promptly add that path then
4656
close all open command prompt Windows, or running `nton` won't work as it will not be recognized as a program.
4757

@@ -54,7 +64,7 @@ Otherwise, use the CLI by checking out `nton --help`.
5464
### Keys
5565

5666
Proprietary Keys known as `prod.keys` are required. You can obtain them from your own personal Switch using
57-
Lockpick_RCM.
67+
[Lockpick_RCM](https://gbatemp.net/download/lockpick_rcm-1-9-15-fw-20-zoria.39129).
5868

5969
It must be placed at `C:\Users\<User>\.switch\prod.keys`, in your current working directory, or in
6070
NTON's installation directory for NTON to be able to find and use the keys.
@@ -77,7 +87,7 @@ The Title ID is automatically checked against a periodically updated list of pre
7787
to ensure a collision does not occur. However, you should still be cautious and verify the Title ID is not already used
7888
by other Software before using.
7989

80-
> **Note**<br>
90+
> [!NOTE]
8191
> While NTON can be used on NRO files stored on your PC, it was designed to be used directly from your Switch's
8292
> microSD card. If you prefer to create forwarders with NRO files on your PC, or for batch purposes, you can specify
8393
> the path that the NRO file will reside on your microSD card during generation with `--sdmc`.
@@ -94,7 +104,7 @@ Use a RetroArch Game Core as the NRO path and provide the path to the ROM on you
94104
This will then load the Core directly under RetroArch and provide the path to the ROM as a startup argument to the
95105
RetroArch Core.
96106

97-
> **Note**
107+
> [!NOTE]
98108
> - You must use a path to a RetroArch Game Core NRO, not the path to the RetroArch NRO itself.
99109
> - Do not move, delete, or rename the ROM or the Core NRO files that are on your microSD card, or it will break.
100110
@@ -128,15 +138,17 @@ yourself.
128138

129139
### The forwarder does not launch, "The software was closed because an error occurred."
130140

131-
Your "sigpatches" (signature patches) that allow unsigned titles to launch is likely outdated or not set up correctly.
132-
Sigpatches can go outdated from Horizon OS firmware updates, Atmosphere updates (as well as silent updates). It is
133-
recommended to use the [sys-patch](https://github.com/ITotalJustice/sys-patch) sys-module to automatically patch your
134-
system from signature checks as well as other useful patches. The default configuration is fine for the majority of
135-
systems and is a simple copy & paste to your microSD card to install.
141+
As the NSP forwarder's signature is not valid as we do not possess Nintendo's private signing keys, you cannot boot
142+
any NSP forwarder with CFW alone. Nintendo has DMCA'd the options that allow you to run these kinds of NSP files due
143+
to it allowing piracy. Support on this matter cannot be provided as I do not support piracy on any Nintendo system.
144+
145+
If you do not agree with enabling piracy, do not want to enable piracy, or do not know how to proceed from here, then
146+
I do not recommend using NRO to NSP forwarders at all and stick with the Homebrew launcher through the Album icon, or
147+
by opening any Game or Software while holding (R).
136148

137-
It's also possible the `prod.keys` you used with NTON is outdated for your firmware. Get new ones with Lockpick_RCM
138-
and make sure you choose to get keys from the SysMMC or EmuMMC that you will be installing the forwarder on (or
139-
whichever has a newer firmware version).
149+
However, it's also possible the `prod.keys` you used with NTON is outdated for your firmware. Re-download the latest
150+
Lockpick_RCM and re-obtain this `prod.keys` file from your own Switch. Make sure you choose to get keys from the SysMMC
151+
or EmuMMC that you will be installing the forwarder on (or whichever has a newer firmware version).
140152

141153
### The forwarder starts loading but then crashes
142154

@@ -150,7 +162,7 @@ This happens when the `icon_AmericanEnglish.dat` within the built forwarder is n
150162
some way. This is usually caused by the format of the image not being JPEG, or it has EXIF data or other unnecessary
151163
extra metadata.
152164

153-
> **Note**<br>
165+
> [!NOTE]
154166
This is considered a bug if it happens to you after using NTON as it should automatically sanitize the
155167
images when building the forwarder. If this happens to you, please report what image you chose to use, or give
156168
information on what exact NRO you were making a forwarder from.
@@ -170,14 +182,20 @@ help you resolve this issue as it has tools to remove partial installs and lefto
170182

171183
### The forwarder randomly stopped working, I've read everything so far
172184

173-
You most likely updated Atmosphere or Horizon OS's Firmware and need to update your Sigpatches. If that hasn't fixed
174-
it, make sure you haven't deleted or moved the NRO on your Switch's microSD card. It cannot be moved as the built
175-
forwarder has a hardcoded file path that it loads the NRO from when launched.
185+
There are numerous reasons why this could be, see the following main reasons:
176186

177-
If it still does not work, it's possible a firmware update has broken the [forwarder ROM][ROM] that is used and needs
187+
1. Make sure you haven't deleted or moved the NRO on your Switch's microSD card. It cannot be moved as the built
188+
forwarder has a hardcoded file path that it loads the NRO from when launched.
189+
2. You may have since updated Atmosphere or your Firmware which broke the changes you made to the bootloader that enabled
190+
the use of custom NSP files. As this project does not support piracy on any Nintendo system, support is not provided.
191+
4. It's possible a firmware update has broken the [forwarder ROM][ROM] that is used and needs
178192
to be updated. Both Firmware 9.0.0 and 12.0.0 have previously broken different forwarder ROMs requiring updates. If
179193
you believe this to be the case then please make an Issue.
180194

195+
If after reading all of these troubleshooting steps, you still cannot get the NSP forwarder to work, then I do not
196+
recommend the use of them and instead recommend using the Homebrew launcher from the album or from title takeover
197+
(holding R while booting any Game or Software).
198+
181199
## Development
182200

183201
The following steps are basic instructions on downloading and working on the code under a [Poetry] environment.
@@ -189,7 +207,8 @@ The following steps are basic instructions on downloading and working on the cod
189207
5. Install NTON's dependencies and development tools, `poetry install -E gui`
190208
6. Run NTON from within the Poetry venv, `poetry run nton --help`
191209

192-
> **Note** If you plan to work on or use the GUI during development, then add `-E gui` during Step 5.
210+
> [!NOTE]
211+
> If you plan to work on or use the GUI during development, then add `-E gui` during Step 5.
193212
194213
As shown, running the `nton` executable is somewhat different to a normal installation. This is because Poetry installs
195214
all dependencies and the `nton` shim itself within a virtual-environment, which is like a clone of your Python install

0 commit comments

Comments
 (0)