Cheat Sheet - Nanook/NKit GitHub Wiki
A collection of examples with required and optional parameters listed. Parameters can be specified in the config or via command line.
A collection of examples with required and optional parameters listed. Parameters can be specified in the config or via command line.
The following are params that can be used across almost all tasks, repeated here from the Usage page. They are relisted in the examples if there's something specific to the task and noteworthy.
The in param
The in parameter is required for all tasks. Here are some generic examples to save listing them in every example. For paths, / works for all operating systems. \ is windows only.
Note:Supported Images: iso / rvz / wud / wux / tmd / wbfs+wbf1 / ciso / iso.dec / wia / gcz / nkit.iso / nkit.gcz / cue+bin / gdi / dec.isoSupported Archives: zip / rar / 7z (including split and multi volume)
See the Input File Masks documentation for examples.
Params
| Name | Desciption |
|---|---|
| tmp | Temp path. Written files are output to this path. Upon completion they are moved to the out path. If blank, the path of the file being processed will be used |
| r | Recursive in path search y or n |
| arc | Archive in path search y or n. Search inside archives for images. Supports split archives and multiple images per archive |
| dat | zip/rar/7z/gzip arc mask and/or dat mask. The Latest modified file is used where there are multiple matches e.g. path/Dats/WiiDats *.zip/*.dat or path/directoryOfWiiDats/*.dat |
| outAsDatMatch | Rename output images to a matched dat entry |
| consoleLevel | none, info, detail, error, debug. Level of detail output to the console window. Currently only none and info are implemented properly. |
| logOutLevel | Level of detail logged to the logOut file. Set to none to turn it off |
| logOut | Path of the log file |
| results | Log a 1 line summary result of each image processed to resultsOut |
| resultsOut | Path of results file |
| parallelism | NKit processes blocks of data from the source image in 3 concurrent streams, Read, Processing and Write. This value sets how many blocks of data are within each. A value of 4 means 12 in total with 4 processing data while the other eight read and write. It affects performance, it's a balance of disk read and write speeds and processing power |
Note: Params set on the command line override those of the config. The command line can blank out a param with "" ('' for linux and `"`" for powershell)
Common Task Examples
Convert Wii/GameCube image to rvz
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | convert |
||
| in | *.iso |
Directory, file, mask. Can be iso / rvz / wbfs+wbf1 / ciso / iso.dec / wia / gcz / nkit.iso / nkit.gcz (also contained in supported archives) | |
| convert | rvzrvz:zstdrvz:nonervz:zstd:19:128k:16rvz:none:128k:16 |
This value is split by : and order dependent. Missing items are defaulted.rvz:zstd:level:BlockSize:Parallelismrvz:none:BlockSize:ParallelismLevel for rvz is 1 to 21. (19 is the default)BlockSize can be 32k / 64k / 128k (default) / 256k / 512k / 1m / 2mParallelism is the amount of concurrent processing threads |
|
| fixFiles | ✅ | path | Used if source is nkit.iso / nkit.gcz and update partitions are removed |
| out | ✅ | Directory - defaults to the in image path. Processed images are named as the input file with an rvz extension |
|
| v | ✅ | y, n,datLookup |
Verify will compare the nkit scan of the output file against the scan of the input file. Use datLookup to verify against a dat |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability.
nkit -task convert -in *.iso -convert rvz # most concise regardless of config settings
nkit -task convert -in *.iso -convert rvz -v y # verify the output expands to match source
nkit -task convert -in file.iso -convert rvz -cfg n # no config, output to the image file directory
nkit -task convert -in file.ciso -convert rvz:none -cfg n # rvz with no compression and no config
nkit -task convert -in file.wbf? -convert rvz -out converted # wbfs+wbf1 to rvz - output to converted directory
nkit -task convert -in * -convert rvz -dat wii.dat -outAsDatMatch y -cfg n # name as matched dat item without config
nkit -task convert -in file.nkit.gcz -fixFiles dir # convert image with removed update partition
rvzconvert *.iso # bundled cloned nkit app with custom yaml
Expand Wii/GameCube image from rvz / nkit.iso / nkit.gcz etc to iso
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | expand |
||
| in | *.rvz |
Directory, file, mask. Can be iso / rvz / wbfs+wbf1 / ciso / iso.dec / wia / gcz / nkit.iso / nkit.gcz (also contained in supported archives) | |
| fixFiles | ✅ | path | Used if source is nkit.iso / nkit.gcz and update partitions are removed |
| out | ✅ | Directory - defaults to the in image path. Processed images are named as the input file with an iso extension |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability.
nkit -task expand -in *.rvz # most concise regardless of config settings
nkit -task expand -in file.rvz -cfg n # most concise with no config
nkit -task expand -in file.wbf? -out expanded # wbfs to iso - output to expanded directory
nkit -task expand -in file.nkit.gcz -fixFiles dir # expand image with removed update partition
rvzconvert *.rvz # bundled cloned nkit app rvz gets expanded, other gets converted
Fix a Wii/GameCube image to match redump dat entry
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | fix |
||
| in | *.wbfs |
Directory, file, mask. Can be iso / rvz / wbfs+wbf1 / ciso / iso.dec / wia / gcz / nkit.iso / nkit.gcz (also contained in supported archives) | |
| fixInfo | fix_wii.yamlfix_gamecube.yaml$appPath$/fix_$system$.yaml |
||
| fixFiles | path | Path to nkit fix/recovery files created from good images. These files are not distributed with nkit | |
| out | ✅ | Directory - defaults to the in image path. Processed images are named as the input file with an rvz extension |
|
| v | ✅ | y, n,datLookup |
Verify will compare the resulting CRC with a dat to confirm a match (as datLookup does) |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability.
nkit -task fix -in *.wbfs # most concise regardless of config settings
nkit -task fix -in file.wbf? -out expanded # wbfs to iso - output to expanded directory
nkit -task fix -in file.nkit.gcz -fixFiles dir # expand image with removed update partition
nkit -task fix -in * -fixInfo fix_wii.yaml -fixFiles dir -cfg n # most concise with no config
nkit -task fix -in * -fixInfo $appPath$/fix_$system$.yaml -fixFiles dir -cfg n # using keywords to handle gc and wii
Convert WiiU image to wux
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | convert |
||
| in | *.wud |
Directory, file, mask. Only wud is supported (also contained in supported archives) | |
| convert | wux |
Specified format | |
| keys | WiiUKeys.zipdir |
Path to a zip of key files or directory of key files | |
| out | ✅ | Directory - defaults to the in image path. Processed images are named as the input file with a wux extension |
|
| v | ✅ | y, n,datLookup |
Verify will compare the nkit scan of the output file against the scan of the input file. Use datLookup to verify against a dat |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability.
nkit -task convert -in *.wud -convert wux -keys WiiUKeys.zip # most concise regardless of config settings
nkit -task convert -in *.wud -convert wux -keys WiiUKeys.zip -v y # verify the output expands to match source
nkit -task convert -in file.wud -convert wux -keys WiiUKeys.zip -cfg n # no config, output to the image file directory
nkit -task convert -in file.wud -convert wux -keys WiiUKeys.zip -out converted # output to converted directory
nkit -task convert -in * -convert wud -keys WiiUKeys.zip -dat wiiu.dat -outAsDatMatch y -cfg n # name as matched dat item without config
wuxconvert *.wud # bundled cloned nkit app with custom yaml
Expand WiiU image to wud
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | expand |
||
| in | *.wux |
Directory, file, mask. Must be wux (also contained in supported archives) | |
| keys | WiiUKeys.zipdir |
Path to a zip of key files or directory of key files | |
| out | ✅ | Directory - defaults to the in image path. Processed images are named as the input file with a wud extension |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability.
nkit -task expand -in *.wux -keys WiiUKeys.zip # most concise regardless of config settings
nkit -task expand -in file.wux -keys WiiUKeys.zip -cfg n # most concise with no config
nkit -task expand -in file.wux -keys WiiUKeys.zip -out expanded # output to expanded directory
rvzconvert *.wux # bundled cloned nkit app wux gets expanded, other gets converted
Convert WiiU image to app
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | convert |
||
| in | *.wud*.wux |
Directory, file, mask. Wud / wux / cdn (tmd*) are supported (also contained in supported archives) | |
| convert | app |
Specified format | |
| keys | WiiUKeys.zipdir |
Path to a zip of key files or directory of key files | |
| out | ✅ | Directory - defaults to the in image path. Processed images are output to a directory named as the input file. The directory will contain the title, h3 and app files |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability.
nkit -task convert -in *.wud -convert app -keys WiiUKeys.zip # most concise regardless of config settings
nkit -task convert -in *.wux -convert app -keys WiiUKeys.zip -v y # verify the output expands to match source
nkit -task convert -in file.wud -convert app -keys WiiUKeys.zip -cfg n # no config, output to the image file directory
nkit -task convert -in file.wud -convert app -keys WiiUKeys.zip -out converted # output to converted directory
nkit -task convert -in * -convert app -keys WiiUKeys.zip -dat wiiu.dat -outAsDatMatch y -cfg n # name as matched dat item without config
Convert WiiU CDN (tmd) to app
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | convert |
||
| in | tmdtmd.**.tmd |
Directory, tmd file, mask, Wud and wux are also supported - see above. (also contained in supported archives) | |
| convert | app |
Specified format | |
| out | ✅ | Directory - defaults to the in image path. Processed images are output to a directory named as the input directory or archive. The TitleID and Tmd version are added. The directory will contain the title, h3 and app files |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability. Converting to app will create a directory per tmd processed and name it with the titleID and tmd version.
nkit -task convert -in * -convert app # most concise regardless of config settings
nkit -task convert -in tmd* -convert app -v y # verify the output expands to match source
nkit -task convert -in * -convert app -cfg n # no config, output to the image file directory
nkit -task convert -in tmd* -convert app -out converted # output to converted directory
Decrypt PS3 iso to dec.iso
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | convert |
||
| in | *.iso*.cso*.zso |
Directory, file, mask. Only iso is supported (also contained in supported archives) | |
| convert | deciso |
Only deciso is supported | |
| keys | PS3Keys.zipdir |
Path to a zip of key files or directory of key files | |
| out | ✅ | Directory - defaults to the in image path. Processed images are named as the input file with a dec.iso extension |
|
| v | ✅ | y, n,datLookup |
Verify will compare the nkit scan of the output file against the scan of the input file. Use datLookup to verify against a dat |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability.
nkit -task convert -in *.iso -convert deciso -keys PS3Keys.zip # most concise regardless of config settings
nkit -task convert -in *.iso -convert deciso -keys PS3Keys.zip -v y # verify the output expands to match source
nkit -task convert -in file.iso -convert deciso -keys PS3Keys.zip -cfg n # no config, output to the image file directory
nkit -task convert -in file.iso -convert deciso -keys PS3Keys.zip -out decrypted # output to decrypted directory
nkit -task convert -in * -convert deciso -keys PS3Keys.zip -dat PS3.dat -outAsDatMatch y -cfg n # name as matched dat item without config
Extract files
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | extract |
||
| in | * |
All supported formats (also contained in supported archives) | |
| extract | mi:*m:*ri:.*r:.*f:* |
m: Match moder: Regex modef: Forensic modei: Case insensitiveSee the File Masks |
|
| keys | ✅ | path | Required for images that require keys |
| out | ✅ | Directory -defaults to the in image path. Processed images are named as the input file with an iso extension |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability.
nkit -task extract -in *.rvz -extract mi:* # all files from an rvz image
nkit -task extract -in *.rvz -extract mi:/DATA/sys/boot.bin # specific file
nkit -task extract -in *.rvz -extract mi:/DATA/sys/boot.bin|bi2.bin # multiple files in the same folder
nkit -task extract -in *.wbfs -extract mi:/DATA/* # all game partition files recursively from a Wii wbfs file
nkit -task extract -in *.wbfs -extract mi:/DATA/ # files in the root directory of the game partition (not recursive)
nkit -task extract -in *.rvz -extract ri:/[^/]+/sys/ # all system file in Wii images
nkit -task extract -in *.iso -keys PS3Keys.zip -extract ri:^(/PS3_DISC\.SFB|/PS3_GAME/PARAM\.SFO|/PS3_GAME/LICDIR/LIC\.DAT|/PS3_GAME/USRDIR/EBOOT\.BIN|/PS3_GAME/TROPDIR/.*)$ # all PS3 system files
nkit -task extract -in *.wux -keys WiiUKeys.zip -extract ri:GM.* # WiiU files in Game Partitions
nkit -task extract -in *.iso -extract mi:*.bin|*.sys # recusively extract all bin and sys files
Encrypt PS3 to iso
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | expand |
||
| in | *.dec.iso*.iso |
Directory, file, mask. Can be dec.iso or a decrypted iso (also contained in supported archives) | |
| keys | PS3Keys.zipdir |
Path to a zip of key files or directory of key files | |
| out | ✅ | Directory - defaults to the in image path. Processed images are named as the input file with a wud extension |
|
| v | ✅ | y, n,datLookup |
Verify will compare the nkit scan of the output file against the scan of the input file. Use datLookup to verify against a dat |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability.
nkit -task expand -in *.dec.iso -keys PS3Keys.zip # most concise regardless of config settings
nkit -task expand -in file.iso -keys PS3Keys.zip -cfg n # most concise with no config
nkit -task expand -in file.dec.iso -keys PS3Keys.zip -out encrypted # output to expanded directory
Build PS3 image using extracted files and an IRD
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | fix |
||
| in | PS3_DISC.SFB |
Directory, file, mask. Also supports archives | |
| fixInfo | fix/fix_ps3.yaml$appPath$/fix/fix_$system$.yaml |
||
| fixFiles | path | Path to nkit fix/recovery files created from good images. These files are not distributed with nkit | |
| out | ✅ | Directory - defaults to the in sfb path. Processed images are named as the input parent directory/archive name with an iso extension |
|
| v | ✅ | y, n,datLookup |
Verify will compare the resulting CRC with a dat to confirm a match (as datLookup does) |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability.
nkit -task fix -in path/*.sfb # most concise regardless of config settings
nkit -task fix -in path/*.zip -a y # search archives for sfb
nkit -task fix -in * -r y -fixInfo fix/fix_ps3.yaml -fixFiles fix/ps3 -cfg n # most concise with no config
nkit -task fix -in * -r y -fixInfo $appPath$/fix/fix_$system$.yaml -fixFiles dir -cfg n # generic, if supported for system
Create PS3 IRD file from redump image
| Name | Optional | Example | Desciption |
|---|---|---|---|
| task | fixExtract |
||
| in | *.iso*.cso*.zso |
Directory, file, mask. Only iso is supported (also contained in supported archives) | |
| fixInfo | fix/fix_ps3.yaml$appPath$/fix/fix_$system$.yaml |
||
| out | ✅ | Directory - defaults to the in sfb path. Processed images are named as the input file with the Title ID, Image CRC and ird extension |
|
| v | ✅ | y, n,datLookup |
Verify will compare the resulting CRC with a dat to confirm a match (as datLookup does) |
Command line
The -in params in the following examples can apply to any example. Extra spaces are added for readability.
nkit -task fixExtract -in *.iso # most concise regardless of config settings
nkit -task fixExtract -in *.iso -out fix/ps3 # add new IRDs to existing set
nkit -task fixExtract -in * -r y -fixInfo fix/fix_ps3.yaml -fixFiles fix/ps3 -cfg n # most concise with no config
nkit -task fixExtract -in * -r y -fixInfo $appPath$/fix/fix_$system$.yaml -fixFiles $system$ -cfg n # generic, if supported for system
Scan an image
...Coming soon
Advanced and Experimental Examples
...Coming soon