From WikiTemp, the GBAtemp wiki
(Overview)
(Credits)
(30 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
==WIP!!==
 
==WIP!!==
NKit documentation is WIP, once released this documentation will be fleshed out and cover as much as possible...
+
NKit documentation is WIP. It will be added to as people ask questions and raise issues...
  
 
==Overview==
 
==Overview==
NKit is a ''Nintendo ToolKit'' that can Recover and Preserve Wii and GameCube Disc Images.
+
NKit is a ''Nintendo ToolKit'' that can Recover and Preserve Wii and GameCube disc images
  
 
'''Recovery''' is the ability to rebuild source images to match the known good images verified by Redump
 
'''Recovery''' is the ability to rebuild source images to match the known good images verified by Redump
  
 
'''Preserve''' is the ability to shrink any image and convert it back to the source iso
 
'''Preserve''' is the ability to shrink any image and convert it back to the source iso
 +
 +
NKit can convert to ISO and NKit format. The NKit format is designed to shrink an image to it's smallest while ensuring it can be restored back to the original source data. NKit images are also playable by Dolphin
  
 
==Key Uses==
 
==Key Uses==
* Unscrub Wii/GC images from scene/scrubbed/wbfs(file)/iso.dec/iso/gcz
+
* Unscrub/Rebuild Wii/GC images from scrubbed/header+region hacked/wbfs(file)/iso.dec/iso/gcz to match Redump good images
* Convert GC images to nkit format (small, playable, reversable)
+
* Convert Wii/GC images to NKit format (small, playable, reversible) - with optional gcz compression
 
* Preserve and shrink Scrubbed and Custom images
 
* Preserve and shrink Scrubbed and Custom images
 
* Preserve Wii images with controlled removal of update partition
 
* Preserve Wii images with controlled removal of update partition
  
 
===Recovery===
 
===Recovery===
* Recover scrubbed, scene images to match Redump verified images
+
* Recover scrubbed, header/region hacked images to match Redump verified images
===NKit Preservation Format===
+
===Preservation - NKit Format===
 +
* Convert Redump, Hacks, Scrubbed images to NKit format and back to the original iso data
 +
 
 
==Features==
 
==Features==
* Wii RVT-R Support
+
 
 +
* Recovery and Preservation of GameCube and Wii images
 +
* NKit Format (smallest format and Dolphin compatible, GC is hardware compatible)
 +
* GC NKit format aligns audio and tgc files to 32k for playability
 +
* Wii NKit format removes hashes and encryption (Dolphin Compatible)
 +
* Reusable library for use in other projects
 +
* Test Mode
 +
* Summary log of all conversions
 +
* Rename images that match Dat file entries to a configurable mask
 +
* Supports 100% of Redump images (Unlicensed, All Regions, Multi Disc etc)
 +
* Scrubbed and Hacked preservation support
 +
 
 +
===Formats===
 +
* GCZ support
 +
* ISO.DEC read support
 +
* WBFS read support
 +
* ISO support
 +
* RVT-R Wii ISO read support
 +
* NKit Format support (smallest format and Dolphin compatible)
 
* Read the above images from Rar/Zip/7zip etc
 
* Read the above images from Rar/Zip/7zip etc
* GC nkit format CRC matches source image CRC
+
 
* GC nkit format can be gcz un/compressed by the included apps
+
===Recovery Abilities===
* GC nkit format aligns audio and tgc files to 32k for playability
+
* Rename restored images to match Redump dat crc
+
* Rename restored images to match a secondary Redump compatible dat crc
+
 
* Insert missing Wii Update (inc rare extra data), Channel and VC partitions
 
* Insert missing Wii Update (inc rare extra data), Channel and VC partitions
 
* Replace Brickblocked Update partitions
 
* Replace Brickblocked Update partitions
 
* Auto fixes modified disc headers (where the Data header remains intact)
 
* Auto fixes modified disc headers (where the Data header remains intact)
 
* Fixes rare corrupt Wii partition table (caused by WBM)
 
* Fixes rare corrupt Wii partition table (caused by WBM)
* Fixes rare Wii 0 byte file scrubbing (caused by WIT)
+
* Fixes scrubbed trailing file 0's
 
* Fixes truncated Wii images (where the Data partition is intact)
 
* Fixes truncated Wii images (where the Data partition is intact)
* Fixes slightly overdumped images too (descrambled)
+
* Fixes slightly overdumped images (from descramble tools)
 
* Fixes Wii Data partitions moved before 0xF800000 to save space
 
* Fixes Wii Data partitions moved before 0xF800000 to save space
 
* Fixes compacted GC images
 
* Fixes compacted GC images
Line 41: Line 60:
 
* Fixes modified Wii region and ratings
 
* Fixes modified Wii region and ratings
 
* Support for GC images with junk not generated with the image ID
 
* Support for GC images with junk not generated with the image ID
* All regions supported
+
 
* Optimised for performance
+
* GC NKit format is compatible with hardware and Dolphin
+
* Wii NKit format removes hashes and encryption (Dolphin Compatible)
+
* Reusable library for use in other projects
+
 
==Requirements==
 
==Requirements==
 
* Windows | Linux | Mac (Untested)
 
* Windows | Linux | Mac (Untested)
 +
* .Net or Mono 4.6.1 (Will be ported to dotnet core 3.0 soon)
 +
 
==Download==
 
==Download==
 +
Coming Soon...
 +
 +
==Documentation==
 +
* [[NKit/UserGuide|User Guide]] - Please read :-)
 +
* [[NKit/FAQ|FAQ]] - Coming soon...
 +
* [[NKit/Glossary|Glossary]]
 +
 +
====Technical====
 +
* [[NKit/Discs|Discs]] : GameCube and Wii disc details
 +
* [[NKit/DiscFileSystem|File Systems]] : Info about the GameCube/Wii filesystems and gaps
 +
* [[NKit/NKitFormat|The NKit Format]] : Detailed information about the NKit Format
 +
 
==History==
 
==History==
 
====Version 1.0====
 
====Version 1.0====
 
==FAQ==
 
[[NKit/FAQ|FAQ]]
 
  
 
[[Category:Wii Utilities]]
 
[[Category:Wii Utilities]]
 
[[Category:Wii]]
 
[[Category:Wii]]
 +
 +
==Credits==
 +
 +
* Johnsanc - Testing, ideas and motivation
 +
* JosJuice - Disc format and Dolphin knowledge
 +
* GerbilSoft - Disc format knowledge (+ RVT-R) ([https://github.com/GerbilSoft/rvthtool rvthtool] / [https://github.com/GerbilSoft/rom-properties rom-properties])
 +
* Osupka - UltimateUnscrubber code
 +
* LedZeppelin68 - Nasos (ISO.DEC) code
 +
* Wiimm - WIT (WBFS) code
 +
* ToeKnee - Testing
 +
* Dack - Wii Scrubber code
 +
* Scifi76 - Wii Scrubber dll (fst.bin) code
 +
* All the game preservationists out there - hope this saves you some space...

Revision as of 13:30, 14 September 2019

WIP!!

NKit documentation is WIP. It will be added to as people ask questions and raise issues...

Overview

NKit is a Nintendo ToolKit that can Recover and Preserve Wii and GameCube disc images

Recovery is the ability to rebuild source images to match the known good images verified by Redump

Preserve is the ability to shrink any image and convert it back to the source iso

NKit can convert to ISO and NKit format. The NKit format is designed to shrink an image to it's smallest while ensuring it can be restored back to the original source data. NKit images are also playable by Dolphin

Key Uses

  • Unscrub/Rebuild Wii/GC images from scrubbed/header+region hacked/wbfs(file)/iso.dec/iso/gcz to match Redump good images
  • Convert Wii/GC images to NKit format (small, playable, reversible) - with optional gcz compression
  • Preserve and shrink Scrubbed and Custom images
  • Preserve Wii images with controlled removal of update partition

Recovery

  • Recover scrubbed, header/region hacked images to match Redump verified images

Preservation - NKit Format

  • Convert Redump, Hacks, Scrubbed images to NKit format and back to the original iso data

Features

  • Recovery and Preservation of GameCube and Wii images
  • NKit Format (smallest format and Dolphin compatible, GC is hardware compatible)
  • GC NKit format aligns audio and tgc files to 32k for playability
  • Wii NKit format removes hashes and encryption (Dolphin Compatible)
  • Reusable library for use in other projects
  • Test Mode
  • Summary log of all conversions
  • Rename images that match Dat file entries to a configurable mask
  • Supports 100% of Redump images (Unlicensed, All Regions, Multi Disc etc)
  • Scrubbed and Hacked preservation support

Formats

  • GCZ support
  • ISO.DEC read support
  • WBFS read support
  • ISO support
  • RVT-R Wii ISO read support
  • NKit Format support (smallest format and Dolphin compatible)
  • Read the above images from Rar/Zip/7zip etc

Recovery Abilities

  • Insert missing Wii Update (inc rare extra data), Channel and VC partitions
  • Replace Brickblocked Update partitions
  • Auto fixes modified disc headers (where the Data header remains intact)
  • Fixes rare corrupt Wii partition table (caused by WBM)
  • Fixes scrubbed trailing file 0's
  • Fixes truncated Wii images (where the Data partition is intact)
  • Fixes slightly overdumped images (from descramble tools)
  • Fixes Wii Data partitions moved before 0xF800000 to save space
  • Fixes compacted GC images
  • Fixes moved and reordered GC files
  • Fixes modified GC headers (inc. title, region hacks)
  • Fixes mod chip modified GC apploaders
  • Fixes GC images with non conformant junk
  • Fixes modified Wii region and ratings
  • Support for GC images with junk not generated with the image ID

Requirements

  • Windows | Linux | Mac (Untested)
  • .Net or Mono 4.6.1 (Will be ported to dotnet core 3.0 soon)

Download

Coming Soon...

Documentation

Technical

  • Discs : GameCube and Wii disc details
  • File Systems : Info about the GameCube/Wii filesystems and gaps
  • The NKit Format : Detailed information about the NKit Format

History

Version 1.0

Credits

  • Johnsanc - Testing, ideas and motivation
  • JosJuice - Disc format and Dolphin knowledge
  • GerbilSoft - Disc format knowledge (+ RVT-R) (rvthtool / rom-properties)
  • Osupka - UltimateUnscrubber code
  • LedZeppelin68 - Nasos (ISO.DEC) code
  • Wiimm - WIT (WBFS) code
  • ToeKnee - Testing
  • Dack - Wii Scrubber code
  • Scifi76 - Wii Scrubber dll (fst.bin) code
  • All the game preservationists out there - hope this saves you some space...