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
SimCity 4 uses a different bit layout for its compression. I may eventually add a feature flag for "sc4 mode" but there isn't really a programmatic way to identify it and I would prefer not to complicate the API.
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.
rust
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.