Nintendo Optical Disc traversal and generation
Go to file
Luke Street bad0f06254 devkitA64 compilation fixes 2020-10-21 00:39:16 -04:00
driver Update fmtlib 2020-04-11 12:45:06 -10:00
include/nod devkitA64 compilation fixes 2020-10-21 00:39:16 -04:00
lib devkitA64 compilation fixes 2020-10-21 00:39:16 -04:00
logvisor@81fb4e4c2d Update logvisor 2020-10-21 00:38:29 -04:00
.gitignore Add .gitignore 2017-05-29 09:55:27 -10:00
.gitmodules Minor .gitmodules change 2019-05-22 16:04:33 -10:00
CMakeLists.txt Exclude CMake CXX standard from MSVC 2020-04-10 19:00:19 -10:00 Cmake config support 2019-01-27 21:35:03 -08:00
LICENSE Update LICENSE date 2016-03-06 17:12:22 -10:00 Massive libfmt refactor 2019-07-19 18:21:57 -10:00


NOD is a library and utility (nodtool) for traversing, dumping, and authoring GameCube and Wii optical disc images.


The primary motivation of NOD is to supply a uniform C++11 API for accessing data from image files directly. nod::DiscBase provides a common interface for traversing partitions and individual files. Files may be individually streamed, or the whole partition may be extracted to the user's filesystem. Raw ISO and WBFS images are supported read sources.

bool isWii; /* Set by reference next line */
std::unique_ptr<nod::DiscBase> disc = nod::OpenDiscFromImage(path, isWii);
if (!disc)
    return FAILURE;

/* Access first data-partition on Wii, or full GameCube disc */
nod::Partition* dataPart = disc->getDataPartition();
if (!dataPart)
    return FAILURE;

/* One-shot extraction to filesystem */
if (!dataPart->extractToDirectory(outDir, ctx))
    return FAILURE;

return SUCCESS;

Image authoring is always done from the user's filesystem and may be integrated into a content pipeline using the nod::DiscBuilderBase interface.

/* Sample logging lambda for progress feedback */
size_t lastIdx = -1;
auto progFunc = [&](size_t idx, const nod::SystemString& name, size_t bytes)
    if (idx != lastIdx)
        lastIdx = idx;
        /* NOD provides I/O wrappers using wchar_t on Windows;
         * _S() conditionally makes string-literals wide */
    if (bytes != -1)
        fmt::print(_S("\r{} {} B"), name, bytes);
        fmt::print(_S("\r{}"), name);

/* Making a GCN image */
nod::DiscBuilderGCN b(isoOutPath, progFunc);
ret = b.buildFromDirectory(fsRootDirPath);

/* Making a Wii image */
nod::DiscBuilderWii b(isoOutPath, dualLayer, progFunc);
ret = b.buildFromDirectory(fsRootDirPath);

Wii images are fakesigned using a commonly-applied signing bug.

Additionally, any *.dol files added to the disc are patched to bypass the #001 error caused by invalid signature checks. This allows games with multiple .dols to inter-boot without extensive loader-patching.


The library usage mentioned above is provided by a command-line tool called nodtool.

An extract/repack works like so:

>$ nodtool extract <image-in> [<dir-out>]
>$ cd <dir-out>

# Then one of:
>$ nodtool makegcn fsroot [<image-out>]
>$ nodtool makewii fsroot [<image-out>]