Adding `ggpk` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add ggpk

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

ggpk = "1.2.2"

The ggpk library will be automatically available globally. Read the ggpk library documentation.

Back to the crate overview.

Readme

Path of Exile GGPK reader

A CLI and library for reading GGPK files for the game Path of Exile created by Grinding Gear Games. The scope is limited only to extracting files contained inside the GGPK, futher reading of the files contained within will not be added.

Building

Instructions for setting up for rust development: https://www.rust-lang.org/learn/get-started

After your rustc and cargo is installed simply run the following:

$ cargo build --release

Usage

list all files

$ ggpk --path "C:/games/Path of Exile/"

filtered listing

$ ggpk --path "C:/games/Path of Exile/" --query .+/Data/.+.bundle.bin

Regex format used: https://docs.rs/regex/1.4.2/regex/

write files to disk

$ ggpk --path "C:/games/Path of Exile/" --output "C:/GGPK_Dump/"

Can be combined with the query parameter to write only some files.

write to stdout

Note: Won't work from Windows as terminal only allows valid utf-8 symbols to be written.

Requires specifying a query resulting in a single file matching. Useful for pipeing a single file to another process.

$ ggpk --path "/games/Path of Exile" -q .+/_.index.bin --binary

Adding ggpk library as a dependency

Adding `ggpk` library as a dependency