https://github.com/openpeeps/zxc-nim
Bindings to the ZXC compression library, a LZ77-based compressor optimized for high decompression speed
https://github.com/openpeeps/zxc-nim
archive compression compressor data decompression game-assets lossless lossless-compression lz77 nim nim-bindings nim-package nim-wrapper openpeeps zxc
Last synced: 3 days ago
JSON representation
Bindings to the ZXC compression library, a LZ77-based compressor optimized for high decompression speed
- Host: GitHub
- URL: https://github.com/openpeeps/zxc-nim
- Owner: openpeeps
- License: bsd-3-clause
- Created: 2026-04-20T05:29:58.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2026-04-21T12:12:14.000Z (about 2 months ago)
- Last Synced: 2026-04-21T14:12:28.002Z (about 2 months ago)
- Topics: archive, compression, compressor, data, decompression, game-assets, lossless, lossless-compression, lz77, nim, nim-bindings, nim-package, nim-wrapper, openpeeps, zxc
- Language: Nim
- Homepage:
- Size: 75.2 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Bindings to the ZXC compression library
A LZ77-based compressor optimized for high decompression speed
nimble install zxc
## 😍 Key Features
- Write-Once, Read-Many compression
- Optimized for **Game Assets**, **Firmware** & **App Bundles**
- High decompression speed
- **Stream API** for compressing/decompressing large data
- Multi-threaded Streaming API for even faster performance
- Optional **Checksum Validation**
- Level-based compression (Fastest, Fast, Default, Balanced and Compact)
- Reusable contexts for high-frequency call sites
- **Seekable archives** (Optional seek table for O(1) random access)
## Installation
Use your favorite package manager to install the ZXC library, or [build it from source](https://github.com/hellobertrand/zxc#option-5-building-from-source).
## Examples
Compressing and decompressing strings with mutable buffers
```nim
let original = "The quick brown fox jumps over the lazy dog 🦊"
var compressed: CompZscBytes # seq[byte]
compressBytes(original, compressed, ZXC_LEVEL_DEFAULT, false)
var decompressed: DecompZscBytes # seq[byte]
decompressBytes(compressed, decompressed, false)
assert decompressed.bytesToString == original
```
Use ZXC's streaming API for large data or when you want to enjoy multi-threaded performance
```nim
let testFile = "test_zxc_input.txt"
let compressedFile = "test_zxc_input.txt.zxc"
let decompressedFile = "test_zxc_input_out.txt"
let content = "ZXC file streaming test!\nLine 2.\nLine 3."
compressFile(testFile, compressedFile, level = ZXC_LEVEL_DEFAULT, checksumEnabled = true)
decompressFile(compressedFile, decompressedFile, checksumEnabled = true)
assert readFile(decompressedFile) == content
```
Check more examples in the [tests directory](https://github.com/openpeeps/zxc-nim/blob/main/tests/test1.nim)
_todo: example with reusable contexts and seekable archives_
### ❤ Contributions & Support
- 🐛 Found a bug? [Create a new Issue](https://github.com/openpeeps/zxc-nim/issues)
- 👋 Wanna help? [Fork it!](https://github.com/openpeeps/zxc-nim/fork)
- 😎 [Get €20 in cloud credits from Hetzner](https://hetzner.cloud/?ref=Hm0mYGM9NxZ4)
### 🎩 License
BSD-3-Clause license. [Made by Humans from OpenPeeps](https://github.com/openpeeps).
Copyright OpenPeeps & Contributors — All rights reserved.
