cvakiitho/nut repository overview

⁠NUT

This is a program that acts as a USB and network server for use with Tinfoil⁠.

⁠Usage guide (Windows users)

• Download tinfoil_driver.exe and nut.exe from here⁠.
• Install the drivers by running the tinfoil_driver.exe in the previous step.
• Run nut.exe. You should be presented with a GUI as shown in the picture above.

⁠Usage guide (UNIX users)

⁠Requirements

• Python 3.6+
• PIP modules from requirements.txt
• Few braincells & the ability to read

⁠Installation guide

• Install Python 3.6+ from your preferred package manager, along with the libusb, python3-pip & python3-pyqt5 packages.
• Clone this repository to desired directory and change your working directory to the cloned repository.
• Install the PIP modules with the following command pip3 install -r requirements.txt.
• (Linux only) Add the following code snippet to /etc/udev/rules.d/99-switch.rules using your favorite editor.

SUBSYSTEM=="usb", ATTRS{idVendor}=="16c0", ATTRS{idProduct}=="27e2", GROUP="plugdev"

• Run python3 nut.py to launch the application.

⁠Application Summary

The GUI is divided into three distinct sections (header, body, footer).

⁠Application Header

The top section has a textbox to input a folder path to scan, along with a Scan button to scan the path specified in the textbox. Next to it, you should see a GDrive Auth button. A detailed explaination of what it does can be found below. The IP/Port/User/Password are the information needed to login to the NUT server. To the right of those, you can also see a USB Status indicator, indicating whether a tinfoil client is connected via USB with the server.

⁠Application Body

This shows a table containing a list of NSW files that was detected by NUT from the scanned paths. It shows the title count, file name, title ID, title type and title size for each scanned file.

⁠Application Footer

This shows the progress information of any file that is currently being downloaded from the server.

⁠GDrive Auth

NUT will authenticate with GDrive if you create a GDrive application, and place its credentials.json file either in nut's root directory, or in the conf directory. You can generate / download credentials.json from https://developers.google.com/drive/api/v3/quickstart/python⁠.

Once this is set up, you can access your gdrive through tinfoil, by using either the usbfs, nutfs, or GDrive protocol.

⁠License

This project is licensed under the terms of GPLv3, with the exemptions for specific projects noted below.

You can find a copy of the license in the LICENSE file⁠.

Exemptions:

• nsz⁠ is exempt from the GPLv3 licensing and can license any source code from this project under MIT License instead. In doing so, they may alter, supplement, or entirely remove the copyright notice for each file they choose to relicense.