NUT

Nut is a multi-purpose utility to organize, manage, and install Nintendo Switch files (NSP, NSZ, XCI, XCZ). It has the ability to act as a USB and network server for Tinfoil.

Buttons

• Scan - populates file list
• Organize Files - moves files on disk to match the format specified in the configuration
• Pull - gets new files that match your filters from the remote locations (see configuration)
• Update TitleDB - force-reloads the latest title database
• Decompress NSZ - for any NSZ.XCZ files found, uncompresses them to NSP/XCI
• Compress NSP - for any NSP/XCI files found, compresses them to NSZ/XCZ CPU INTENSIVE
• Setup GDrive OAuth - see below

Configuration

The GUI has the ability to set the most common configuration options, see the below images. You can also create a custom configuration by creating conf/nut.conf. The format should mirror nut.default.conf.

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.

THe body shows a table containing a list of files that were 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.

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

Google Drive Integration

NUT has the ability to interact with Google Drive. For this to work, you will need to download a credentials.json, using the guide found here. Once you have this file placed either in NUT's root or conf directory, click the Setup GDrive OAuth button in the GUI and follow the prompts. You will be able to access your GDrive through Tinfoil via the gdrive:/ protocol after copying credentials.json and token.json to /switch/tinfoil on your microSD card. (This is automatically done if you connect Tinfoil to nut)

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.
• Install the latest version of Tinfoil and open it.

Usage guide (UNIX users)

Requirements

• Python 3.9+ (tested: 3.9.7)
• OpenSSL-backed curl (for pycurl)
• Python modules as listed in requirements.txt

Installation guide (Linux)

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

Installation guide (macOS)

on M1:
PYCURL_SSL_LIBRARY=openssl LDFLAGS="-L/opt/homebrew/opt/openssl/lib" CPPFLAGS="-I/opt/homebrew/opt/openssl/include" pip install pycurl
on Intel:
PYCURL_SSL_LIBRARY=openssl LDFLAGS="-L/usr/local/opt/openssl/lib" CPPFLAGS="-I/usr/local/opt/openssl/include" pip install pycurl --compile --no-cache-dir

License

This software is licensed under the terms of the GPLv3, with exemptions for specific projects noted below. You can find a copy of the license in the LICENSE file.

Exemptions:

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

Contributing

Contributions are welcome, and there is a pre-commit hook - run pip3 install -r requirements_dev.txt