Files
SabreTools.Compression/README.MD
Matt Nadareski b2fe81dac8 README resync
2024-12-11 09:02:33 -05:00

35 lines
1.6 KiB
Markdown

# SabreTools.Compression
[![Build and Test](https://github.com/SabreTools/SabreTools.Compression/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/SabreTools/SabreTools.Compression/actions/workflows/build_and_test.yml)
This library comprises of various compression implementations that are used across multiple projects. Most of the implementations are be ports of existing C and C++ code.
Find the link to the Nuget package [here](https://www.nuget.org/packages/SabreTools.Compression).
## Releases
For the most recent stable build, download the latest release here: [Releases Page](https://github.com/SabreTools/SabreTools.Compression/releases)
For the latest WIP build here: [Rolling Release](https://github.com/SabreTools/SabreTools.Compression/releases/rolling)
## Supported Compressions
| Compression Name | Decompress | Compress | Notes |
| --- | --- | --- | --- |
| Blast | Yes | No | |
| BZip2 | Yes | Yes | Sourced from DotNetZip |
| Deflate | Yes | Yes | Sourced from DotNetZip |
| LZ | Yes | No | KWAJ, QBasic 4.5, and SZDD variants; KWAJ incomplete |
| LZX | No | No | |
| MSZIP | Yes | No | |
| Quantum | Yes* | No | Partial implementation based on standalone archives |
**Note:** If something is marked with a `*` it means that it need testing.
## External Libraries
| Library Name | Use |
| --- | ---|
| [DotNetZip](https://github.com/DinoChiesa/DotNetZip) | BZip2 and DEFLATE implementations; minor edits have been made |
| [ZLibPort](https://github.com/Nanook/zlib-C-To-CSharp-Port) | Adds zlib code for internal and external use; minor edits have been made |