AuroraLib.Compression.Nintendo 2.0.0

AuroraLib.Compression

AuroraLib.Compression is a high-performance, memory-efficient compression library providing a wide range of algorithms commonly used in video games and game engines. The library is written entirely in managed C# and supports multiple .NET versions without requiring external native dependencies.

The goal of AuroraLib.Compression is not to provide the fastest possible implementation of a single algorithm, but to offer a broad collection of compression formats while keeping the library lightweight, flexible, and easy to integrate.

Command line tool

Download Auracomp

Benchmarks

View Benchmarks

Supported Algorithms

AuroraLib.Compression

Core compression algorithms and widely used general-purpose formats.

AuroraLib.Compression.Nintendo

Compression formats used across Nintendo platforms such as GBA, DS, Wii, and more.

* Both big-endian and little-endian variants are supported.

AuroraLib.Compression.Sega

Compression formats found in Sega games and platforms.

* Both big-endian and little-endian variants are supported.

AuroraLib.Compression-Extended

Additional compression formats used by various game studios and engines.

* Both big-endian and little-endian variants are supported.

How To Use

Decompress a File Using a Specific Algorithm

    using FileStream source = new("input.dat", FileMode.Open, FileAccess.Read, FileShare.Read);
    using FileStream destination = new("output.dat", FileMode.Create, FileAccess.ReadWrite, FileShare.None);
    new LZSS().Decompress(source, destination);

Compress a File Using a Specific Algorithm

    using FileStream source = new("input.dat", FileMode.Open, FileAccess.Read, FileShare.Read);
    using FileStream destination = new("output.dat", FileMode.Create, FileAccess.ReadWrite, FileShare.None);
    new LZSS().Compress(source, destination, CompressionSettings.Balanced);

Check If a File Matches a Specific Compression Algorithm

    using FileStream source = new("input.dat", FileMode.Open, FileAccess.Read, FileShare.Read);
    bool canDecompressed = LZSS.IsMatchStatic(source);

Configure an Compression Encoder

    Yaz0 encoder = new Yaz0
    {
        FormatByteOrder = Endian.Big,  // Use big-endian byte order
    };
	
    CompressionSettings settings = new CompressionSettings(
        quality: 10,  // 0 (fastest, lowest compression) to 15 (slowest, best compression)
        maxWindowBits: 12, // Maximum LZ window size (for LZ-based algos) 
        strategy: CompresionStrategy.CompatibilityMode // Enables compatibility features for older or simpler decoders.
    );
	
	encoder.Compress(source, destination, settings);

Automatically Detect and Decompress Using a Recognized Algorithm

This approach is useful when you don't know in advance which compression algorithm was used on a file.

    FormatDictionary formats = new FormatDictionary(new Assembly[] 
    { 
        typeof(LZSS).Assembly,    // Base algorithms assembly
        typeof(Yaz0).Assembly     // Nintendo algorithms assembly
    });

    using FileStream source = new("input.dat", FileMode.Open, FileAccess.Read, FileShare.Read);
    ReadOnlySpan<char> fileName = Path.GetFileName("input.dat");

    // Identify the compression format
    if (formats.Identify(source, fileName, out IFormatInfo format) && format.Class != null)
    {
     	// Create an instance of the detected format
        var decoder = format.CreateInstance();
		
        if (decoder is ICompressionDecoder compressionDecoder)
        {
            using Stream destination = compressionDecoder.Decompress(source);
            // Use the decompressed stream as needed
        }
    }

Credits

• LZ4 reference for LZ4 algorithm.
• Haruhiko Okumura reference his original C implementation of the LZSS algorithm.
• Oberhumer reference for the LZO algorithm.
• Google reference for the snappy algorithm.
• Ariya reference for the FastLZ algorithm.
• ibsensoftware Creator of aPLib.
• Daniel-McCarthy reference for MIO0, YAZ0, YAY0 algorithm.
• Nickworonekin Puyo Tools reference for CNX2, LZ00, LZ01, LZ10, LZ11, PRS algorithms.
• Kuriimu reference for HUF20 algorithm.
• Niotso.wiki reference for RefPack algorithm.
• Sukharah reference for CLZ0 algorithm.
• Gamemasterplc reference for LZHudson algorithm.
• KirbyUK reference for LZShrek algorithm.
• Brolijah reference for ALLZ algorithm.thm.
• CUE reference for LZ40 algorithm.
• hack64 reference for SMSR00 algorithm.
• RareZip reference for RareZip algorithm.
• ShaneYCG reference for WFLZ algorithm.
• UYA_pyTools reference for HIG algorithm.