Skip to main content

Organize a Nintendo Switch NSP/NSZ library and convert between NSP and NSZ

Project description

nsptool

CLI to organize a Nintendo Switch NSP/NSZ library into a clean per-game layout and convert between NSP and NSZ (delegating to nsz).

Library layout

Library/
  Game Name [0100XXXXXXXX0000] [US]/
    Game Name [0100XXXXXXXX0000][v0] [US].nsp            <- base game
    Game Name [0100XXXXXXXX0800][v65536] [US].nsp        <- update
    Game Name (DLC Name)[0100XXXXXXXX1234][v] [US].nsp   <- DLC

Files are identified by decrypting the CNMT metadata inside the container (authoritative), falling back to filename parsing ([titleid][vN]) when the title uses a master key that isn't in your prod.keys. Display names come from an existing library folder for the same title first, then from titledb.

Install

uv tool install nsptool     # or: pipx install nsptool / pip install nsptool

Requirements:

  • prod.keys dumped from your own console (Lockpick_RCM or similar). Titles newer than your dump's highest master key can't be decrypted, so keep it current.

Setup

The first run opens a short wizard asking for your library directory, the path to prod.keys, and the region tag, saved to ~/.config/nsptool/config.toml. Re-run it anytime with nsptool config --setup.

nsptool config              # show current settings
nsptool update-titledb      # one-time (~150 MB) download, cached as a small index

nsptool links your keys file to ~/.switch/prod.keys, where nsz expects it.

Commands

# inspect files (titleid, version, type, name)
nsptool scan ~/Downloads/incoming

# add new files to the library; dry run by default, shows the full plan
nsptool library add ~/Downloads/incoming
nsptool library add ~/Downloads/incoming --apply          # move for real
nsptool library add ~/Downloads/incoming --apply --copy   # copy instead
nsptool library add ~/Downloads/incoming --library /path  # different target

# normalize the library itself (fix drifted names/locations); dry run by default
nsptool library organize
nsptool library organize --apply

# per-game overview of the library (games, versions, DLC counts, sizes)
nsptool library list

# find redundant files; dry run by default, deletes only with --apply
nsptool library dedupe                       # exact duplicates
nsptool library dedupe --prune-old-versions  # + superseded update/DLC versions
nsptool library dedupe --prefer nsz          # + nsp/nsz doubles, keeping nsz
nsptool library dedupe --prefer nsp          # + nsp/nsz doubles, keeping nsp
nsptool library dedupe --apply               # actually delete

# NSP <-> NSZ (verified by default)
nsptool compress "Game [0100...][v0] [US].nsp" --rm-source
nsptool decompress "Game [0100...][v0] [US].nsz" -o ./out

library add/library organize never overwrite: files whose titleid+version already exist in the library are reported as duplicate, and name collisions as conflict, both left untouched. --fast trusts filenames and skips decryption.

Dev

uv sync
uv run pytest tests/
uv run ruff check src/ tests/
uv run ty check src/

CI (.github/workflows/ci.yml) runs the same three checks on every push.

License

MIT. Depends on nsz (MIT). This tool manages backups of games you own, dumped with your own console keys; it contains no keys and no copyrighted content.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nsptool-0.1.5.tar.gz (21.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nsptool-0.1.5-py3-none-any.whl (19.9 kB view details)

Uploaded Python 3

File details

Details for the file nsptool-0.1.5.tar.gz.

File metadata

  • Download URL: nsptool-0.1.5.tar.gz
  • Upload date:
  • Size: 21.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for nsptool-0.1.5.tar.gz
Algorithm Hash digest
SHA256 a032e3ae02659c78b832974ad394e9d4c62dece6775e0fb66ee67e0bc56009db
MD5 72ffa66d89a41fa59d5bf20adceb2243
BLAKE2b-256 91a0d1dbdc4f4f9661689e6c240804ed2a5d0ad1acd433c63b7bf08ee213c445

See more details on using hashes here.

File details

Details for the file nsptool-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: nsptool-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 19.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.29 {"installer":{"name":"uv","version":"0.11.29","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for nsptool-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d0fddd2a1f237867d2f17d9af8e7f3a5e74742eb26e4558b4fbca098241fd385
MD5 0c6f6cdfb8ef2d978b30af0000462179
BLAKE2b-256 8c435ef4904228c4b4d7cb2d576c4f75324bf9144fc65566243db4a4c2bd9d30

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page