#refpack #dbpf #far #ea #qfs

refpack

A crate providing compression/decompression for the RefPack compression format, utilized by many early 2000s EA games

2 releases (1 stable)

Uses new Rust 2021

1.0.0 Jan 2, 2022
0.1.0 Nov 14, 2021

#129 in Compression

24 downloads per month

MPL-2.0 license

38KB
700 lines

refpack-rs

Rust Build and Test docs.rs Crates.io GitHub license fuck it Coverage Status

A rust crate for compressing and decompressing data in the RefPack format utilized by many EA games of the early 2000s

More details on the refpack format can be found at the niotso wiki. The short explanation is that RefPack is a compression scheme loosely based on LZ77 compression.

The Original Refpack Implementation was referenced to ensure proper compatibility

Usage

refpack-rs exposes two functions: compress and decompress, along with easy variants with easier but less flexible of usage.

compress and decompress take mutable references to a buffer to read and write from, that implements std::io::Read and std::io::Write, respectively.

decompress will read from the buffer until it encounters a stopcode (byte within (0xFC..=0xFF)), while compress will read in the provided length.

Example

let mut out_buf = Cursor::new(vec![]);
decompress(&mut source_reader, &mut out_buf)?;

The easy variants are compress_easy and decompress_easy, which take a &[u8] and return a Result<Vec<u8>, RefPackError>.

Internally they simply call compress and decompress with a Cursor to the input and output buffers, however they are more convenient to use in many cases.

Dependencies

~2MB
~46K SLoC