ns-usbloader/README.md

62 lines
2.1 KiB
Markdown
Raw Normal View History

2019-02-10 04:59:54 +03:00
# NS-USBloader
NS-USBloader is a PC-side tinfoil NSP USB uploader. Replacement for default usb_install_pc.py
2019-02-12 00:56:42 +03:00
2019-02-10 04:59:54 +03:00
With GUI and cookies.
2019-02-12 00:56:42 +03:00
2019-02-11 18:44:12 +03:00
Read more: https://developersu.blogspot.com/2019/02/ns-usbloader-en.html
2019-02-10 04:59:54 +03:00
2019-02-12 00:56:42 +03:00
Here is the version of 'not perfect byt anyway' [tinfoil I use](https://cloud.mail.ru/public/DwbX/H8d2p3aYR).
2019-02-10 04:59:54 +03:00
## License
Source code spreads under the GNU General Public License v.3. You can find it in LICENSE file.
2019-02-10 13:07:40 +03:00
## Requirements
JRE 8 or higher. See below.
2019-02-10 13:07:40 +03:00
2019-02-10 04:59:54 +03:00
## Used libraries
2019-02-12 00:56:42 +03:00
* [OpenJFX](https://wiki.openjdk.java.net/display/OpenJFX/Main)
* [usb4java](https://mvnrepository.com/artifact/org.usb4java/usb4java)
* Few icons taken from: [materialdesignicons](http://materialdesignicons.com/)
2019-02-10 04:59:54 +03:00
2019-02-10 17:40:29 +03:00
## Usage
### Linux:
Install JRE/JDK 8 or higher (openJDK is good. Oracle's one is also good). JavaFX not needed, if you're interested (it's embedded).
2019-02-10 05:01:20 +03:00
2019-02-10 17:40:29 +03:00
`root # java -jar /path/to/NS-USBloader.jar`
2019-02-10 05:01:20 +03:00
2019-02-12 00:56:42 +03:00
### macOS
See 'Linux' section.
Set 'Security & Privacy' if needed.
### Windows:
* Download Zadig: https://zadig.akeo.ie/
* Open tinfoil. Set 'Title Managment' -> 'Usb install NSP'
* Connect NS to pc
* Open Zadig, select NS in dropdown, select 'libusbK (v3.0.7.0)' (version may vary), click 'Install WCID Driver'
* Check that in device list of you system you have 'libusbK USB Devices' folder and your NS inside of it
* Download and install Java JRE (8+)
* Get this application (JAR file) double-click on on it (alternatively open 'cmd', go to place where jar located and execute via 'java -jar thisAppName.jar')
* Remember to have fun!
2019-02-10 17:40:29 +03:00
## Tips&tricks
### Add user to udev rules to use NS non-root (Linux):
2019-02-10 17:40:29 +03:00
`root # vim /etc/udev/rules.d/99-NS.rules`
2019-02-11 05:16:07 +03:00
2019-02-10 17:40:29 +03:00
`SUBSYSTEM=="usb", ATTRS{idVendor}=="057e", ATTRS{idProduct}=="3000", GROUP="plugdev"`
2019-02-11 05:16:07 +03:00
2019-02-10 17:40:29 +03:00
`root # udevadm control --reload-rules && udevadm trigger`
2019-02-10 04:59:54 +03:00
## Known bugs
* Unable to interrupt transmission when libusb awaiting for read event (when user sent NSP list but didn't selected anything on NS).
## TODO:
2019-02-12 00:56:42 +03:00
- [x] macOS QA by [Konstanin Kelemen](https://github.com/konstantin-kelemen). Appreciate assistance of [Vitaliy Natarov](https://github.com/SebastianUA).
- [x] Windows support
- [ ] code refactoring