ZPack is a simple, general-purpose archive file format with lossless data compression (similar to zip, rar, etc.). It is designed with performance in mind and uses fast compression algorithms such as zstd and lz4.

Documentation

The specifications for the ZPack file format can be found here

The API documentation can be generated using Doxygen. An online copy of it can be found here

Installing

Prebuilt Windows and Linux binaries are available on the Releases page.

Compiling

The CMake lists in the root directory can be used to build both the library and the command line utility.

A few options are available when configuring with CMake. Here are some common options:

ZPACK_BUILD_PROGRAMS: Build the ZPack command line utility. Default: ON
ZPACK_BUILD_TESTS: Build the ZPack unit tests. Default: OFF
ZPACK_DISABLE_ZSTD: Disable zstd support. Default: OFF
ZPACK_DISABLE_LZ4: Disable LZ4 support. Default: OFF

More options can be found in CMakeLists.txt

To use the library in your CMake project:

set(ZPACK_BUILD_PROGRAMS OFF) # optional
add_subdirectory(path/to/zpack)
 
target_include_directories(target PRIVATE path/to/zpack/lib)
target_link_libraries(target PRIVATE zpack)

License

ZPack is licensed under the [zlib License](LICENSE)