nstool/README.md

NXTools

Tools & Libraries for NX (Nintendo Switch).

Tools

• nstool - read *.npdm, read/extract PartitionFS (PFS0|HFS0) blobs (including *.nsp), read/extract RomFS blobs, read/extract *.xci, read/extract *.nca, read *.cnmt, read *.nso, read *.nro, read *.nacp

Libraries

• libfnd - Foundation library.
• libcrypto - Cryptographic functions (AES,SHA,RSA). Wrapper for mbedTLS
• libcompress - Compression algorithms (LZ4). Wrapper for lz4
• libpki - Processes Nintendo's proprietary PKI.
• libes - Processes Nintendo's eShop file types.
• libnx - Processes NX file types.
• libnx-hb - Processes NX file types (homebrew extensions).

Building

On MacOS/Linux/WSL run make.

For Windows, Visual Studio 2017 is supported.

External Keys

Programs/libraries don't embed any keys that are copyright protected. However keys can be imported via a keyset file.

For programs that support it, the keyset file can be provided via the command line (see program usage for details). Alternatively a keyset file located in $HOME/.switch/prod.keys (or $HOME/.switch/dev.keys for dev) will be imported automatically if one is not provided at the command line.

Keyset files are ASCII text files containing one key per line, in the form "key_name = HEXADECIMALKEY". Case and whitespace do not matter, ';' character can be used to insert comments.

See KEYS.md for more details.