nstool/README.md

# NXTools

Tools & Libraries for NX (Nintendo Switch).

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

# Tools

* __nstool__ - read *.npdm, read/extract PartitionFS (PFS0|HFS0) blobs (including *.nsp), read/extract *.xci, read/extract *.nca

# Libraries

* __libfnd__	- Foundation library.
* __libcrypto__	- Cryptographic functions (AES,SHA,RSA). Wrapper for [mbedTLS](https://github.com/ARMmbed/mbedtls)
* __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](/KEYS.md) for more details.
Create README.md 2017-07-18 14:23:37 +00:00			`# NXTools`

Change readme. Add information about keys. 2018-04-24 09:25:05 +00:00			`Tools & Libraries for NX (Nintendo Switch).`
Create README.md 2017-07-18 14:23:37 +00:00
Add link to license in readme 2018-04-24 10:11:47 +00:00			`[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)`
Change readme. Add information about keys. 2018-04-24 09:25:05 +00:00
			`# Tools`

Update readme 2018-05-18 08:47:55 +00:00			`* __nstool__ - read .npdm, read/extract PartitionFS (PFS0\|HFS0) blobs (including .nsp), read/extract .xci, read/extract .nca`
Change readme. Add information about keys. 2018-04-24 09:25:05 +00:00
			`# Libraries`

Fix wording/formatting in readme. 2018-04-24 10:18:01 +00:00			`* __libfnd__ - Foundation library.`
			`* __libcrypto__ - Cryptographic functions (AES,SHA,RSA). Wrapper for [mbedTLS](https://github.com/ARMmbed/mbedtls)`
Update readme 2018-05-18 08:47:55 +00:00			`* __libes__ - Handling of (NX relevant) eShop file type processing. (eTickets, etc)`
			`* __libnx__ - Handling of NX file types`
Change readme. Add information about keys. 2018-04-24 09:25:05 +00:00
Add Visual Studio (2017) support. 2018-04-25 04:59:42 +00:00			`# Building`

			On MacOS/Linux/WSL run `make`.

			`For Windows, Visual Studio 2017 is supported.`

Change readme. Add information about keys. 2018-04-24 09:25:05 +00:00			`# External Keys`

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

Fix wording/formatting in readme. 2018-04-24 10:18:01 +00:00			`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.`
Change readme. Add information about keys. 2018-04-24 09:25:05 +00:00
Fix wording/formatting in readme. 2018-04-24 10:18:01 +00:00			`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.`
Change readme. Add information about keys. 2018-04-24 09:25:05 +00:00
			`See [KEYS.md](/KEYS.md) for more details.`