mirrors/nstool
1
0
Fork 0
mirror of https://github.com/jakcron/nstool.git synced 2024-10-18 05:21:11 +00:00
Code Issues Packages Projects Releases Wiki Activity
General purpose read/extract tool for Nintendo Switch file formats.
219 commits 34 branches 22 tags 2.2 MiB
C++ 98.3%
Makefile 1.6%
Go to file
jakcron 5a2f998cb9 [nstool] Update readme and help text to reflect present functionality.
2018-06-01 22:35:48 +08:00
.vscode [programs] Remove xcitool, npdmtool, pfstool. Add nstool. 2018-04-24 13:24:20 +08:00
lib [nx|nstool] Encapsulated NsoHeader parsing into nx::NsoHeader 2018-06-01 21:35:36 +08:00
programs [nstool] Update readme and help text to reflect present functionality. 2018-06-01 22:35:48 +08:00
.gitignore Update project metadata 2018-04-07 15:56:38 +08:00
KEYS.md Fix typo in KEYS.md 2018-05-11 20:17:55 +08:00
LICENSE [libcompress] Add libcompress with LZ4 implemented. 2018-06-01 20:18:36 +08:00
makefile [ncatool] Add program. Can only process header currently. 2017-07-05 18:58:33 +10:00
NXTools.sln Include License in VS project files. 2018-05-18 16:47:45 +08:00
NXTools.vcxproj Initial commit of support libraries. 2017-07-03 01:18:59 +10:00
NXTools.vcxproj.filters Initial commit of support libraries. 2017-07-03 01:18:59 +10:00
README.md [nstool] Update readme and help text to reflect present functionality. 2018-06-01 22:35:48 +08:00

README.md

NXTools

Tools & Libraries for NX (Nintendo Switch).

License

Tools

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

Libraries

  • libfnd - Foundation library.
  • libcrypto - Cryptographic functions (AES,SHA,RSA). Wrapper for mbedTLS
  • libcompress - Compression algorithms (LZ4). Wrapper for lz4
  • libes - Handling of (NX relevant) eShop file type processing. (eTickets, etc)
  • libnx - Handling of NX file types

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.