AuroraLib.Compression 1.1.0

AuroraLib.Compression

Provides support for a wide range of compression algorithms primarily used in video games, it offers fast decompression/compression and efficient memory usage. It is written entirely in managed C# and does not rely on external C++ libraries.

Nuget Package

Benchmarks

Supported Algorithms

* Big-endian and little-endian version are supported.

How To Use

Decompress a file with 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 with 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);

Check if the file can be decompressed with a specific algorithm.

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

Credits

• Nickworonekin Puyo Tools inspired the LZ Decode and Encode code and reference for CNX2, LZ00, LZ01, LZ10, LZ11, PRS algorithms.
• Haruhiko Okumura reference his original C implementation of the LZSS algorithm.
• Daniel-McCarthy reference for MIO0, YAZ0, YAY0 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.