NS-USBloader is a PC-side installer for Huntereb/Awoo-Installer / other compatible installers (USB and Network supported) and XorTroll/Goldleaf (USB) NSP installer. Alternative to default usb_install_pc.py, remote_install_pc.py, GoldTree/Quark.
This application also could be used as RCM payload on Windows, MacOS and Linux.
Requirements
Java JRE/JDK 11+ or higher for mac and linux.
How to setup
Linux:
👉 For more insights, check out this resource.
- Install JRE/JDK 8u60 or higher (openJDK is good. Oracle's one is also good). JavaFX not needed (it's embedded).
root # java -jar /path/to/NS-USBloader.jar- Optional: add user to 'udev' rules to use NS not-from-root-account
root # vim /etc/udev/rules.d/99-NS.rulesSUBSYSTEM=="usb", ATTRS{idVendor}=="057e", ATTRS{idProduct}=="3000", MODE="0666"root # udevadm control --reload-rules && udevadm trigger
- For RCM part
root # vim /etc/udev/rules.d/99-NS-RCM.rulesSUBSYSTEM=="usb", ATTRS{idVendor}=="0955", ATTRS{idProduct}=="7321", MODE="0666"root # udevadm control --reload-rules && udevadm trigger
- For HiDPI use scaling like
java -Dglass.gtk.uiScale=150% -jar application.jar
Raspberry Pi:
- Install JDK:
sudo apt install default-jdk - For UI install JavaFX:
sudo apt install openjfx - See "Linux" section to update "udev" and the RCM part.
macOS:
👉 Discover more in this in-depth guide.
- Double-click on downloaded .jar file. Follow instructions. Or see "Linux" section.
- Set "Security & Privacy" settings if needed.
- Please note: JDK 19 is recommended for using on macOS. There are issues already reported from users on Mac with JDK 14.
macOS on Apple Silicon (ARM):
- Download application with
-m1.jarpostfix.
Windows:
- Once application opens click on "Gear" icon.
- Click "Download and install drivers". Install drivers.
Supports
- Awoo installer.
- GoldLeaf v0.10 (NS-USBloader v6.0).
- GoldLeaf v0.8-0.9 (since NS-USBloader v1.0+).
- GoldLeaf v0.7.x (since NS-USBloader v0.7+).
- GoldLeaf v0.6.1 (NS-USBloader v0.6).
- GoldLeaf v0.5 (NS-USBloader v0.4 - v0.5.2, v0.8+).
- TinFoil - both USB and Net methods (developed by Adubbz, 0.2.1).
How to use
The first thing you should do it install Awoo (Huntereb) or Goldleaf (XorTroll) on your NS.
Take a look on app, find where is the option to install from USB and/or Network. Maybe (very old) this article (about TinFoil) will be helpful.
"Gamepad" tab:
At the top of you selecting from drop-down application and protocol that you're going to use. For Goldleaf only USB is available. Lamp icon stands for switching themes (light or dark). Then you may drag-n-drop files (split-files aka folders) to application or use "Select NSP files" button. Multiple selection for files available. Click it again and select files from another folder it you want, it will be added into the table.
There you can select checkbox for files that will be sent to application (AW/GL). Also, you can use space to select/un-select files and "delete" button for deleting. By right-mouse-click you can see context menu where you can delete one OR all items from the table.
For Goldleaf v0.6.1 and NS-USBloader v0.6 (and higher) you will have to use "Explore content" > "Remote PC (via USB)". You will see two drives HOME:/ and VIRT:/. First drive is pointing to your home directory. Second one is reflection of what you've added to table (first application tab). Also VIRT:/ drive have limited functionality in comparison to HOME:/. E.g. you can't write files to this drive since it's not a drive. But don't worry, it won't make any impact on Goldleaf or your NS if you try.
Also, for Goldleaf write files (from NS to PC): You have to "Stop execution" properly before accessing files transferred from GL. Usually you have to wait 5sec or less. It will guarantee that your files properly written to PC.
"RCM" tab:
On this tab you can select payloader like Hekate or LockPick_RCM and send it to NS. Drag-n-drop supported. Also some in-app validations for payload takes place.
"Folder with arrows and zeroes" tab:
On this tab you can split and merge files. Select "Split" or "Merge" and split (or merge). BTW Drag-n-drop supported.
"Gears" tab:
Here you can configure settings for network file transmission. Usually you shouldn't change anything. But it you're cool hacker, go ahead! The most interesting option here is "Don't serve requests". Architecture of the Awoo's NET part is working interesting way. When you select in Awoo network NSP transfer, application will wait at port 2000 for the information about where should it take files from. Like "192.168.1.5:6060/my file.nsp".
Usually NS-USBloader serves requests by implementing simplified HTTP server and bringing it up and so on. But if this option selected, you can define path to remote location of the files. For example if you set in settings "192.168.4.2:80/ROMS/NS/" and add in table file "my file.nsp" then NS-USBloader will simply tell Awoo "Hey, go take files from "192.168.4.2:80/ROMS/NS/my%20file.nsp". Of course you have to bring "192.168.4.2" host up and make file accessible from such address (just go install nginx).
Also here you can:
- Set "Auto-check for updates" for checking for updates when application starts, or click button to verify if new version released immediately.
- Set "Show only *.nsp in Goldleaf" to filter all files displayed at HOME:/ drive. So only NSP files will appear.
"Dialog with three dots" tab:
That's where all logs dropped. Verbose information about transmissions comes here.
CLI (command line interface)
To get help run $ java -jar ns-usbloader-4.0.jar --help
-c,--clean Remove/reset settings and exit -g,--Goldleaf <...> Install via Goldleaf mode. Check '-g help' for information. -h,--help Show this help -m,--merge <...> Merge files. Check '-m help' for information. -n,--tfn <...> Install via Awoo Network mode. Check '-n help' for information. -r,--rcm <[PATH/]payload.bin> Send payload -s,--split <...> Split files. Check '-s help' for information. -t,--tinfoil <FILE...> Install via Awoo USB mode. -v,--version Show application version
For more complex commands help use help argument after the fists key. For example:
$ java -jar ns-usbloader-4.0.jar -n help Usage: ns-usbloader -n nsip=<arg1> [hostip=<arg2>] FILE1 ... ns-usbloader --tfn nsip=<arg1> [hostip=<arg2>] FILE1 ... Options: nsip=<ip> Define NS IP address (mandatory) hostip=<ip[:port]> Define this host IP address. Will be obtained automatically if not set.
Usage examples:
Send RCM payload: $ java -jar ns-usbloader-4.0.jar -r C:\Users\Superhero\hekate.bin Send files to Awoo Installer via Net-install: $ java -jar ns-usbloader-4.0.jar -n nsip=192.168.0.1 ./file.nsz ./file.nsp ~/*.xci Send files to Goldleaf v0.8: $ java -jar ns-usbloader-4.0.jar -g ver=v0.8 ./* Split files: $ java -jar ns-usbloader-4.0.jar -s /tmp/ ~/*.nsp Merge files: $ java -jar ns-usbloader-4.0.jar -m /tmp/ ~/*.nsp
Notes
"Status" = "Uploaded" that appears in the table does not mean that file has been installed. It means that it has been sent to NS without any issues. That's what this app about. Handling successful/failed installation is a purpose of the other side application: Awoo/Awoo-like or Goldleaf. And they don't provide any feedback interfaces so I can't detect success/failure.
What is this "-legacy" jar:
- JAR with NO postfixes recommended for Windows users, Linux users and macOS users who're using Mojave or later versions.
- JAR with "-legacy" postfix is for macOS users who're still using OS X releases before (!) Mojave. (It also works for Linux and for Windows, but sometimes it doesn't work for Windows).
- We have this situation because of weird behaviour inside usb4java library used in this application for USB interactions. In "-legacy" it's v1.2.0 and in 'normal' it's v1.3.0.
In some moments you can't interrupt file(s) transmission from application side if using Tinfoil/Net-install.
List of awesome code contributors, translators and other great people: