AeonSake.NintendoTools 3.0.1

Nintendo Tools

General purpose extraction, parsing and deserialization tools for Nintendo file formats.

Installation

The library is available as NuGet package on nuget.org and this project's GitLab Package Registry.
Requires .NET Standard 2.1 or later.

Features

The library consists of readers and writers for various Nintendo file formats, compression algorithms, and hashing algorithms, along some other utility functions.

File Formats

Currently, following Nintendo file formats are supported:

[*] Not yet fully implemented.

All file readers and writers implement the IFileReader<T> and IFileWriter<T> interfaces. Some readers/writers also have additional configuration properties (such as the line-ending to use when encoding MSBT files).

var reader = new MsbtFileReader();
reader.CanRead(readStream); //returns true if the stream can be read with that reader
var msbtFile = reader.Read(readStream);

var writer = new MsbtFileWriter {Newline = NewlineType.LF};
writer.Write(msbtFile, writeStream);

Compression Algorithms

Currently, following compression algorithms are supported: LZ10, LZ11, LZ77, Yay0, Yaz0, ZLib, ZSTD. All compression algorithms implement the ICompressor and IDecompressor interfaces.

var decompressor = new Yaz0Decompressor();
decompressor.CanDecompress(readStream); //returns true if the stream can be decompressed with that algorithm
decompressor.Decompress(readStream, decompressedStream);

var compressor = new Yaz0Compressor();
compressor.Compress(decompressedStream, writeStream);

Hashing Algorithms

Currently, the following hashing algorithms are supported: CRC32, CRC32C, MMH3. All hashing algorithms implement the IHashAlgorithm interface.

var hashAlgorithm = new Crc32Hash();
var hash = hashAlgorithm.Compute(readStream);

Building from Source

Building this project requires .NET 5.0 SDK or newer, or .NET Core 3.0 or newer. Refer to the full list of supported frameworks to see more.
Some packages are loaded from external sources (nuget.org) and are required for compilation. Make sure to run nuget restore (or Restore NuGet packages from inside Visual Studio) before building.

Credits and Licenses

The following list contains all external tools and libraries. The project itself is licensed under GPL-3.0.

• AeonSake.BinaryTools (MIT)
• AuroraLib.Compression (MIT)
• Crc32.NET (MIT)
• ZstdSharp (MIT)
• Json.NET (MIT)