sourcepak 0.3.0

A library for reading and writing Source engine package files.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

//! sourcepak provides support for working with VPK (Valve Pak) files.
//! It allows you to read the directories of VPK files, as well as read their contents into memory or to disk.
//!
//! # Supported formats
//! | Format      | Support     | Game(s)                                                      |
//! | ----------- | ----------- | ------------------------------------------------------------ |
//! | VPK v1      | 🟢   | Alien Swarm, Dota 2, L4D, L4D2, Portal 2, SFM                |
//! | VPK v2      | 🟡 * | CS:GO, CS:S, DoD:S, HL:S, HL2, HL2:DM, Portal, TF2, Source 2 |
//! | Respawn VPK | 🟢   | Titanfall                                                    |
//!
//! * sourcepak doesn't currently support reading archive contents or writing directory files for VPK v2.
//!
//! # Features
//! - `revpk`: Add support for Respawn VPK files.
//! - `mem-map`: Use memory mapping to read VPK files. This can be faster and use less memory, but is not supported on all platforms.
//!
//! **Note:** Enabling the `revpk` feature requires additional dependencies (`lzham-alpha-sys`).
//!
//! **Note:** Enabling the `mem-map` feature requires additional dependencies (`filebuffer`).

#![cfg_attr(docsrs, feature(doc_auto_cfg))]

pub mod common;
pub mod pak;

#[cfg(test)]
mod tests;