NSZ 5.0.0

NSZ v5.0.0 is the first official NSZ release for 2 years and 8 months (958 days). So much changed and improved in the meantime. Thanks to now using PyCryptodome's AES implementation NSZ got much faster and less resource intensive. In addition to a lot of new features and improvements there where some major bugs fixed that in rare cases could cause corrupted output during block decompression and XCZ decompression - the NSZ/XCZ file itself is unaffected and will properly decompress using NSZ v5.0.0. Sorry that it took so much time for there to be another release - expect more frequent releases in the future.

What's Changed

• Check for None when calling ExtractTitleIDAndVersion in GameList by @Avasam in #168
• fix breaking pipeline with VerificationErrors by @einsweniger in #170
• add master_key_11 key hash by @wzsx150 in #177
• Update Keys.py by @dnsBlah in #185
• Use raw strings for regexp by @drizzt in #184
• fix read size in BlockDecompressorReader and add IndependentNczDecompressorConcise by @scturtle in #191
• Disable "press enter" prompt when not a terminal by @andrewrabert in #192
• Ticketless support + Ticketless multicontent support + Automation Script files by @ElektroStudios in #196
• Avoid adding padding to already padded PFS0 header by @connesc in #197
• Update Keys.py by @dnsBlah in #199
• Restore No-intro compliance for --fix-padding by @connesc in #201
• Machine readable output and hint for fixing progress reporting by @Clearmist in #202
• Allow NSP header to align to 16 bytes by @ZeppLu in #209
• fix ncz block decompression when BlockSize is a multiple of decompressedSize by @ITotalJustice in #211
• Library improvements by @a1ex4 in #212
• fix typo on undupe that cause issue when using priority lists by @Xefir in #213
• Fix Title usage by @drizzt in #215
• Fix Xcz decompressing partition overwritting by @Furoryan in #217
• feat(keys): support XDG config directory lookup by @mateconpizza in #226
• feat: add Docker containerization with multi-architecture support by @jparrill in #216
• Add --keys option for custom keys file location by @luketanti in #221
• Support both .nsp and .nsz file extensions for Fs.Nsp by @seiya-git in #230
• Bug fix + master key update by @luketanti in #227
• Add for_nutPrint argument to parse method for flexible help by @seiya-git in #231
• Optimize aes128.py by using PyCryptodome's AES implementation by @seiya-git in #232
• More build options and bug fixes by @Clearmist in #234
• Crash fixes, toolchain fixes, and code cleanup (oh my!) by @Brycey92 in #235
• Improvements to use nsz as a library by @a1ex4 in #236
• Add more tests to Azure pipeline by @Brycey92 in #238
• Improved DPI scaling and fixed many DPI scaling issues and added DPI scaling settings by @nicoboss

New Contributors

• @Avasam made their first contribution in #168
• @einsweniger made their first contribution in #170
• @wzsx150 made their first contribution in #177
• @dnsBlah made their first contribution in #185
• @scturtle made their first contribution in #191
• @andrewrabert made their first contribution in #192
• @ElektroStudios made their first contribution in #196
• @connesc made their first contribution in #197
• @Clearmist made their first contribution in #202
• @ZeppLu made their first contribution in #209
• @ITotalJustice made their first contribution in #211
• @a1ex4 made their first contribution in #212
• @Xefir made their first contribution in #213
• @Furoryan made their first contribution in #217
• @mateconpizza made their first contribution in #226
• @jparrill made their first contribution in #216
• @luketanti made their first contribution in #221
• @Brycey92 made their first contribution in #235

Full Changelog: 4.6.1...5.0.0

NSZ 4.6.1

Fixes MPLUS1p-Medium.ttf not found issue of NSZ 4.6 GUI

Older NSZ versions could corrupt the global Kivy configurations as reported in #154. This was fixed in NSZ 4.6. Some users where unable to start NSZ 4.6 GUI due to having corrupted Kivy configurations. This release automatically repairs the Kivy configuration. It does so by resetting the default_font property if corrupted. This fixes #164

This is a day 1 fix for NSZ 4.6. Please read at the NSZ 4.6 release notes instead to see what changed if you upgrade from an older version.

NSZ 4.6.0

Major new features

• --verify now uses file-level sha256 NSP hash validation. --verify now guarantees that the sha256 hash of the original file and the decompressed file will match and so the file is bit-identical recreated.
• Major XCI/XCZ rewrite to support multiple XCI partitions: Specify --keep to keep all partitions including their content. By default, the content of all but the secure partition is removed but the empty partition itself are kept for Yuzu Emulator compatibility.

Bugfixes

• Added missing null terminator at the end of the string table. This fixes #151
• Fixed issue with PFS0 header overlapping the first file when the --remove-padding option is used
• Fixed some logic responsible to handle too short PFS0 header sizes
• Fixed PFS0 header padding so it follows the PFS0 specification. This fixes #150
• We don't want to touch the default Kivy font but instead use LabelBase to set DEFAULT_FONT for this specific application. This fixes #154
• Added the ability to read full xci dumps thanks to @alucryd
• Added master_key_10 key hash thanks to @seiya-git
• Better support deleting source files. This fixes #141

Command line argument changes

• Renamed --remove-padding to --fix-padding. This was done as this option now makes NSP padding match the No-Intro standard.
• Renamed --keep-delta to --keep as it's no longer just used to keep NDV0 files but also to keep all XCI partitions
• --verify and --remove-padding are incompatible with each other's. For compatibility reasons --quick-verify will be automatically used if this situation occurs to match the command line argument behavior prior to NSZ v4.6.0.

NSZ 4.5.0

• Implemented bit-identical FileEntryTable padding recreation
  • The size of FileEntryTable including any non-standard zero padding at the end is kept
  • The FileEntryTable size is kept even if NDV0 files got removed as they are by default if --keep-delta isn't specified.
    • The padding at the end of FileEntryTable will increase in this case
  • Use --remove-padding if you don't want to keep the FileEntryTable size and instead make it the lowest possible size according to the no-
    intro standard. Keep in mind that if your input is already no-intro compliant this option is not needed.
  • This fixes rare cases of non-standard NSP files not being able to be bit identically recreated due to the removal of non-standard FileEntryTable zero padding as reported by @nitro322

NSZ 4.4.0

• Android CLI support
  • To make NSZ Android compatible all uses of shared memory and locks had to be replaced with Android compatible alternatives
  • How to install NSZ on Android
    • Install "Pydroid 3" and the "Pydroid repository plugin" from the Play Store
    • Open "Pydroid 3" and navigate to "Pip"
    • Enter "nsz" and unselect "use prebuild" then press install
    • Navigate to "Terminal" to use the "nsz" command
    • The first time it will tell you where to copy your prod.keys which you should do using the "cp" command
    • Use any command line arguments you want like "nsz -D file.nsz" to decompress your game
• Fixed #134 (OverflowError: can't convert negative int to unsigned)
  • This was fixed inside #135 (Removal of stringTable padding)
  • NSP/NSZ files with a missing stringTable padding are now handled properly
  • This fixes some rare edge cases where bit-identical PFS0 recreation silently failed
• Updated all libraries inside the portable Windows version

NSZ 4.3.0

Hotfix 07.07.2023: If you downloaded nsz_v4.3.0_win64_portable.zip in the first 24 hours after the release please redownload. This fixes #133 (nsz 4.3.0 nsz_v4.3.0_win64_portable won't open).

• Bit-identical PFS0 recreation to comply with the no-intro standard
  • The hash of the original NSP before compression and the hash of the NSP resulting from decompressing the NSZ will match as they are bit-identical.
  • Use the newly introduced --remove-padding option to make existing NSP/NSZ files nxdumptool/no-intro compliant.
  • Use the newly introduced --keep-delta option to keep all useless delta fragments (NDV0) during compression so the NSP (PFS0) can be recreated bit-identical during decompression.
  • PFS0 hash verification is now part of the --verify process. --verify now requires --keep-delta when used during compression or it will detect removed NDV0 fragments as errors. Use --quick-verify to skip the PFS0 hash verification. --quick-verify only verifies NCA hashes and so does not require --keep-delta when used during compression. For compatibility reasons --quick-verify will be automatically used instead when specifying --verify without --keep-delta to match the command line argument and verification behavior of previous NSZ versions.
  • This fixes #98, fixes #101 and fixes #116
• Added console output warning about missing and invalid keys
• Added support for pyinstaller as discussed in #119 (pyinstaller builds for macOS)
• Added crc32 hash of master_key_0f. Thanks to @drizzt for adding it!

NSZ 4.2.1

• Implemented support for zStandard long distance mode inside the GUI.
  => This fixes an issue that causes NSZ to crash when trying to compress using the GUI
• Close GUI window once the NSZ action got started. Not doing so was really bad design.

NSZ 4.2.0

• Resolved title-intaller compatibility with python-zstandard versions later than 0.15.2. NSZ files compressed with modern zstd versions are confirmed to work on the latest Tinfoil, DBI, AtmoXL and TinWoo. Some abandoned title-installer who havn't updated will still be broken. See #120 (zstandard versions newer than 0.15.2 break compatibility with all title installers except DBI) for more information.
• Fixed a mistake in the FileExistingChecks code caused by specifying the wrong target file extension when calling CreateTargetDict. This fixes #123 (XCZ Source File Deleted before decompressing on the same output folder as original)
• Fixed NSP and resulting NSZ will be deleted using --rm-source when solid compression fails. This fixes #124 (NSP and resulting NSZ will be deleted using --rm-source when solid compression fails)
• Added crc32 hash of master_key_0e. Thanks to @16BitWonder for adding it!
• Implemented option to enable zStandard long distance mode for even better compression as requested in #117 (Add support for the zStandard long distance mode)
• Followed the python-zstandard author's feedback regarding flushing to fix all flushing related imperfections
• Fixed "'Counter' object has no attribute 'write'" error when using --create. This fixes #118 (--create is broken)
• Implemented directory expansion support for --create and improved documentation. This closes #119 (The syntax for --create is stupid and the documentation bad)
• Clarified the plaintext rule of the NSZ file format block compression extension as discussed in #120

NSZ 4.1.0

After almost 2 years there finally is a new stable release of NSZ! Sorry that it took so long. I will do stable releases more often in the future.

This version doesn't enforce the use of zstandard v0.15.2 - Please update your title-installer to the latest version to ensure it is compatible. Tinfoil, DBI, AtmoXL and TinWoo are confirmed to work. Some abandoned title-installers will still be broken. For more information see #120

Changelog

Hotfix 09.09.2022: If you downloaded nsz_v4.1.0_win64_portable.zip before this date please redownload.

• Fixed #84 [GUI] broken input file Selection (Drag & Drop still works). This also fixes #102
• Fixed undupe not deleting any files, added undupe support for NSX (NSP files without titlekeys) and fixed not whitelisting the first occurrence but undupe-whitelist any other occurrence not deleting the first occurrence
• Implemented --undupe-rename
• Adopted this tool to the standard by also skipping the content meta xml and improved the skipping message to follow the print standard
• Fixed Verify not throwing an exemption when verification fails
• Implemented --alwaysParseCnmt
• Handle NSZ verification errors by deleting the corrupted NSZ
• When verifying, show "Verifying" instead of "Compressing" in progressbars
• Implemented --undupe-hardlink. Booth --undupe-hardlink and --undupe-rename now uses the output folder as output location.
• Fixed #87: nsz doesn’t respect -o flag when decompressing
• Add CRC-hash for new master keys 0b, 0c and 0d.
• open file only for reading with 'info' command
• set executable bit
• Kivy finally fixed its Linux issues so we can make installing nsz as easy as never before
• Read masterKeyRevision from either of two positions to resolve some edge cases with strange games
• Updated dependencies in setup.py to match requirements.txt/requirements-gui.txt
• There apparently are v0 DLCs so let's remove the safety check that prevents v0 titles to be deleted if there is an update of that exact titleId. The original purpose of this safety check was to protect base titles in case there is a titleID naming issue but is very unlikely to ever be needed. This fixes #105
• Updated packages inside setup.py to match the new setup.py standard

NSZ 4.0.1

Replaced PyInstaller with WinPython for the portable Windows release.

• I spent a lot of time deleting every piece of the python standard library not required to run nsz in order to save storage and speed up extraction time by having less files to extract.
• This was done because PyInstaller triggered false positive detections on Windows Defender as reported in #82
• Tested on Windows 7, Windows 10 and Windows Server 2019

This version ONLY affects the portable Windows release. The PIP release wasn't updated as only the deployment of the Portable windows build is affected by this change.