Skip to content
Nanook edited this page Sep 24, 2026 · 2 revisions

NKit

NKit is a multiplatform disc image processor for game preservation — convert, extract, scan, verify, fix, and deduplicate disc images across 14 gaming systems, reading directly from archives with no temp files.

NKDS (NKit DataStore) extends NKit with a content-addressed block store: deduplicate your entire collection to ~80% space savings, then mount it as a virtual drive so emulators see regular ISOs with no extraction needed.

Both ship as native AOT binaries — no .NET runtime required. Download the latest release and run directly.

Source code: github.com/Nanook/NKit — contributions and bug reports welcome.


Where to Start

I'm new — where do I start? → Getting Started

I want to convert, scan, verify or extract disc images → NKit Features · Processing Tasks · CLI Reference

I want to store my collection and mount it as a virtual drive → NKDS Overview · NKDS CLI · OGMR — per-game sets

I want to understand the storage format and data safety → NKDS Storage Model · NKDS Data Safety · NKDS Binary Format · NkFs Format

I want to embed NKit/NKDS in my own project → Architecture · Developer Guide

I want to build from source or contribute → Getting Started · Contributing

I want to see what's changed or what's planned → Current Status · Roadmap


NKit — Disc Image Processor

Page Description
NKit Features System support, formats, archive handling
NKit Processing Tasks What each task does and which systems support it
NKit CLI Full parameter reference, config setup, examples
NKit CLI Cheat Sheet Quick copy-paste examples
NKit Verify How verification methods work and when each fires
NKit Scan Format The .nkit.yaml scan file — structure, container independence, verification use
NKit File Masks Wildcard, archive, and regex mask syntax
NKit File Scanning How NKit discovers and groups input files

NKDS — NKit DataStore

Page Description
NKDS User Guide Complete user guide — CLI commands, UI application, quick start, examples
NKDS Core concepts, deduplication, VFS, storage modes
NKDS CLI Full command reference and quick start
NKDS CLI Cheat Sheet Quick examples for all nkds commands
NKDS OGMR One Game Many ROMs — per-game embedded sets
NKDS Storage Model How writes, crash safety, and compaction work
NKDS Data Safety What is safe, what compaction does, what changed in v3
NKDS Binary Format NKitDataStore on-disk binary format — shards, index, block map
NKDS NkFs Format NkFs compact binary filesystem format used inside NKDS images

Reference

Page Description
Architecture Design principles and how NKit + NKDS fit together
Developer Guide Embedding the libraries, contributing, testing
Getting Started Install, first run, quick start examples
Contributing Build from source, run tests, submit a PR
Current Status Recent changes, known issues, upcoming work
Roadmap Planned features
Credits Acknowledgements
Links Discord, YouTube, Ko-fi, GitHub, related projects

Clone this wiki locally