NKit/UserGuide - Revision history

Nanook: /* NKit Format */

2019-09-20T10:54:23Z

NKit Format

← Older revision		Revision as of 10:54, 20 September 2019
Line 71:		Line 71:
	\| GameCube \|\| nkit.gcz \|\| No \|\| Yes \|\| Yes \|\| GCZ is Dolphin's own block seekable compression format		\| GameCube \|\| nkit.gcz \|\| No \|\| Yes \|\| Yes \|\| GCZ is Dolphin's own block seekable compression format
	\|-		\|-
	\| Wii \|\| nkit.iso \|\| No ~~(Yes with Dev Kit?)~~ \|\| Yes \|\| Yes \|\| RVT-H format only playable in Dolphin ~~or a Dev Kit (Untested)~~		\| Wii \|\| nkit.iso \|\| No \|\| Yes \|\| Yes \|\| RVT-H format only playable in Dolphin
	\|-		\|-
	\| Wii \|\| nkit.gcz \|\| No \|\| Yes \|\| Yes \|\| RVT-H in GCZ playable in Dolphin only		\| Wii \|\| nkit.gcz \|\| No \|\| Yes \|\| Yes \|\| RVT-H in GCZ playable in Dolphin only

Nanook: /* Recovery Files */

2019-09-14T09:42:02Z

Recovery Files

← Older revision		Revision as of 09:42, 14 September 2019
Line 128:		Line 128:
	* '''GameCube''' other tools that modify these images scrub and move (sometimes reorder) the files in the filesystem. NKit recovery files are the appldr.bin (a handful are used across all images) and fst.bin (unique per image, NKit stores some header info in these files also).		* '''GameCube''' other tools that modify these images scrub and move (sometimes reorder) the files in the filesystem. NKit recovery files are the appldr.bin (a handful are used across all images) and fst.bin (unique per image, NKit stores some header info in these files also).
	* '''Wii''' - other tools remove unused blocks or scrub them by wiping unused blocks with 00 or FF bytes. It is common for Non-Data Partitions are also removed to save space. NKit recovery files consist of the channel and update partitions.		* '''Wii''' - other tools remove unused blocks or scrub them by wiping unused blocks with 00 or FF bytes. It is common for Non-Data Partitions are also removed to save space. NKit recovery files consist of the channel and update partitions.

			NKit can extract the recovery files from images. Running this on a set of random Wii images may extract Update partitions that can be used to recover other images that have had them removed. The update partitions are shared across images. There's only a handful of unique ones.

	=====Brute Force Recovery=====		=====Brute Force Recovery=====

Nanook: /* Brute Force Recovery */

2019-09-12T12:20:57Z

Brute Force Recovery

← Older revision		Revision as of 12:20, 12 September 2019
Line 132:		Line 132:
	In addition to the recovery files, NKit can attempt to force a match by checking various Header CRCs and Update Partition CRCs (for Wii only). Once a match is found the modifications can be applied to the output file and the CRC will match the Dat entry.		In addition to the recovery files, NKit can attempt to force a match by checking various Header CRCs and Update Partition CRCs (for Wii only). Once a match is found the modifications can be applied to the output file and the CRC will match the Dat entry.

	NKit does this by CRCing sections of files as it processes them. Upon completing a conversion other CRCs calculated combined to attempt to make a match. Header modifications include Region and for Wii swapping the Update partition CRC and using the Data Partition data-header for the disc header.		NKit does this by CRCing sections of files as it processes them. Upon completing a conversion other CRCs calculated combined to attempt to make a match. Header modifications include Region and for Wii - swapping the Update partition CRC and using the Data Partition data-header for the disc header.

	=====Summary Log=====		=====Summary Log=====

Nanook: /* Mask Renaming Output Files */

2019-09-12T12:18:57Z

Mask Renaming Output Files

← Older revision		Revision as of 12:18, 12 September 2019
Line 121:		Line 121:
	\| <code>%id8</code> \|\| Disc ID8 \|\| The Disc ID, MakerCode, Disc No. and Disc Revision (Disc No and Revision are as Hex bytes e.g. 0000)		\| <code>%id8</code> \|\| Disc ID8 \|\| The Disc ID, MakerCode, Disc No. and Disc Revision (Disc No and Revision are as Hex bytes e.g. 0000)
	\|}		\|}

			An example of a working mask is <code>%pth\GameCube\%nmm.%ext</code> you may choose to use something like <code>%pth\NewFolder\%nmm %id8 %crc.%ext</code>. This will add <code>[]</code> around the values.

	=====Recovery Files=====		=====Recovery Files=====

Nanook: /* Mask Renaming Output Files */

2019-09-12T12:15:03Z

Mask Renaming Output Files

← Older revision		Revision as of 12:15, 12 September 2019
Line 84:		Line 84:

	=====Mask Renaming Output Files=====		=====Mask Renaming Output Files=====
	~~Images output~~ that match Redump or Other Dat file entries can be renamed to a mask. The masks allow processed images to be moved in to separate folder for Redump Matched, Custom Matched or Match Fail.		Output images that match Redump or Other Dat file entries can be renamed to a mask. The masks allow processed images to be moved in to separate folder for Redump Matched, Custom Matched or Match Fail.

	There are various masks that can be used in the renaming:		There are various masks that can be used in the renaming:

Nanook: /* Examples: */

2019-09-12T12:13:05Z

Examples:

← Older revision		Revision as of 12:13, 12 September 2019
Line 23:		Line 23:
	All commandline apps have the same usage. A list of space separated files and masks. Paths can be relative or absolute. The apps will scan all inputs for files and collate them into a unique set. They are processed for multipart files (rars, split etc) then sorted and processed.		All commandline apps have the same usage. A list of space separated files and masks. Paths can be relative or absolute. The apps will scan all inputs for files and collate them into a unique set. They are processed for multipart files (rars, split etc) then sorted and processed.

	=====Examples:=====		=====Examples=====
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-

Nanook: /* Command Line Apps */

2019-09-12T12:12:52Z

Command Line Apps

← Older revision		Revision as of 12:12, 12 September 2019
Line 23:		Line 23:
	All commandline apps have the same usage. A list of space separated files and masks. Paths can be relative or absolute. The apps will scan all inputs for files and collate them into a unique set. They are processed for multipart files (rars, split etc) then sorted and processed.		All commandline apps have the same usage. A list of space separated files and masks. Paths can be relative or absolute. The apps will scan all inputs for files and collate them into a unique set. They are processed for multipart files (rars, split etc) then sorted and processed.

	Examples ~~(all standard command line)~~		=====Examples:=====
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-

Nanook: /* NKit Format */

2019-09-12T12:11:50Z

NKit Format

← Older revision		Revision as of 12:11, 12 September 2019
Line 59:		Line 59:
	ConvertToNKit and RecoverToNKit will output to the [[NKit/NKitFormat\|NKit Format]]. This format is the smallest GameCube and Wii image format. Both GameCube and Wii images are playable in Dolphin, but only GameCube is supported by hardware.		ConvertToNKit and RecoverToNKit will output to the [[NKit/NKitFormat\|NKit Format]]. This format is the smallest GameCube and Wii image format. Both GameCube and Wii images are playable in Dolphin, but only GameCube is supported by hardware.

	The NKit Format is a non-lossy ~~format for shrinking~~ and ~~restoring Wii and GameCube images. It~~ supports clean / Redump images as well as scrubbed and hacked images. Some corrupt and bad images are supported too, although these can error due to invalid fst.bin modifications.		The NKit Format is non-lossy and supports clean / Redump images as well as scrubbed and hacked images. Some corrupt and bad images are supported too, although these can error due to invalid fst.bin modifications.

	There are 2 NKit output formats, raw (iso) and compressed (gcz). Both were designed with 1:1 preservation, size and playability in mind. Hardware support for Wii was sacrificed for smaller image sizes. If hardware support is required then WBFS is currently the best available and recoverable to Redump where not hacked or corrupt.		There are 2 NKit output formats, raw (iso) and compressed (gcz). Both were designed with 1:1 preservation, size and playability in mind. Hardware support for Wii was sacrificed for smaller image sizes. If hardware support is required then WBFS is currently the best available and recoverable to Redump where not hacked or corrupt.

Nanook: /* GUI Apps */

2019-09-12T12:10:13Z

GUI Apps

← Older revision		Revision as of 12:10, 12 September 2019
Line 47:		Line 47:
	===GUI Apps===		===GUI Apps===
	* '''NKitExtractionApp.exe''' - extract recovery files or extract files from the image filesystems		* '''NKitExtractionApp.exe''' - extract recovery files or extract files from the image filesystems
	* '''NKitProcessingApp.exe''' - recover and convert files to iso / nkit [iso/gcz]. It has a drop down of ~~option~~ that performs the ~~tasks of~~ the first 4 ~~commandline~~ apps above		* '''NKitProcessingApp.exe''' - recover and convert files to iso / nkit [iso/gcz]. It has a drop down of Modes that performs the NKit conversions (covered by the first 4 command line apps above)

	The configuration options in the GUI apps override the equivalent settings in the NKit.dll.config file.		The configuration options in the GUI apps override the equivalent settings in the NKit.dll.config file.

Nanook: /* Command Line Apps */

2019-09-12T12:08:13Z

Command Line Apps

← Older revision		Revision as of 12:08, 12 September 2019
Line 16:		Line 16:
	===Command Line Apps===		===Command Line Apps===
	* '''ConvertToISO.exe''' - converts a source file to iso. This can be wbfs (scrubbing is preserved), iso.dec (junk is recreated) or NKit [iso/gcz] (source data is restored back to iso)		* '''ConvertToISO.exe''' - converts a source file to iso. This can be wbfs (scrubbing is preserved), iso.dec (junk is recreated) or NKit [iso/gcz] (source data is restored back to iso)
	* '''ConvertToNKit.exe''' - preserves the source image data as nkit [iso/gcz]. This can also be used to preserve scrubbed, hacked or bad dumps etc. For WBFS and iso.dec when restoring back to iso with ConvertToIso.exe the iso will contain all data that was in the original WBFS / iso.dec.		* '''ConvertToNKit.exe''' - preserves the source image data as nkit [iso/gcz]. This can also be used to preserve scrubbed, hacked or bad dumps etc. For WBFS and iso.dec when restoring back to iso with ConvertToIso.exe the iso will contain all data that was in the original WBFS / iso.dec (just as .iso)
	* '''RecoverToISO.exe''' - attempts to recover GameCube and Wii images to ~~.iso~~		* '''RecoverToISO.exe''' - attempts to recover GameCube and Wii images to ISO
	* '''RecoverToNKit.exe''' - attempts to recover GameCube and Wii images and convert to nkit.iso or nkit.gcz		* '''RecoverToNKit.exe''' - attempts to recover GameCube and Wii images and convert to nkit.iso or nkit.gcz
	* '''RecoveryExtract.exe''' - saves recovery files from images. CRC's in The NKit.dll.config are used to save extracted files in to a 'Redump' or 'Other' folder.		* '''RecoveryExtract.exe''' - saves recovery files from images. CRC's in The NKit.dll.config are used to save extracted files in to a 'Redump' or 'Other' folder.