A high-performance Rust implementation for quickly unpacking RE Engine game packages.
Structural analysis and algorithms are derived from project Ekey/REE.PAK.Tool. Thanks for your work!
The unpack tool needs file list to work (.list files), you can get full list files here: https://github.com/Ekey/REE.PAK.Tool/tree/main/Projects, and put them in assets/filelist folder.
Note
Some data sources used by this tool do not originate from this repository.
此仓库未来将会作为库使用，应用将会在对应的子仓库发布。 在这里下载v0.3.0以后的版本：https://github.com/eigeen/ree-pak-gui/releases
This repository will be used as a library in the future, and applications will be released in the corresponding sub-repositories. Download v0.3.0 later version here: https://github.com/eigeen/ree-pak-gui/releases
https://github.com/eigeen/ree-pak-gui/releases
Documentation: https://github.com/eigeen/ree-pak-gui
The GUI version provides a visual tree view that allows you to extract the specified files.
Note that the GUI version can only unpack files, the packaging function is on the roadmap.
Source: eigeen/ree-pak-gui.
Command line interface version.
Warning
It has been discontinued after v0.3.0 and is expected to be merged into the GUI version in v0.4.0.
Usage: ree-pak-cli.exe <COMMAND>
Commands:
unpack Unpack a PAK file
dump-info Dump PAK information
pack Pack files into a PAK file
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
Unpack a PAK file. The process is like unpacking a ZIP file, but with some additional features.
Unpack a PAK file
Usage: ree-pak-cli.exe unpack [OPTIONS] --project <PROJECT>
Options:
-p, --project <PROJECT>
Game project name or list file path, e.g. "MHRS_PC_Demo", "./MHRS_PC_Demo.list"
-i, --input <INPUT>
Input PAK file path
--input-list <INPUT_LIST>
Input PAK list file path (UTF-8 text, one path per line)
-o, --output <OUTPUT>
Output directory path
--backend <BACKEND>
PAK reading backend. `legacy` uses regular file I/O; `mmap` uses memory mapping
Possible values:
- mmap: Use `memmap2` memory mapping (default)
- legacy: Use regular file I/O (legacy mode)
[default: mmap]
-f, --filter <FILTER>
Regex patterns to filter files to unpack by file path
--ignore-error
Ignore errors during unpacking files
--override
Override existing files
--skip-unknown
Skip files with an unknown path while unpacking
--test
Test mode: extract in memory, do not write to disk
--strict-feature-flags
Treat unsupported pak feature flags as an error (default: warn and ignore)
Pack files and folders into a PAK file. The process is like packing a ZIP file, but with some additional features.
You should ensure that the input directory is well organized, the packer will locate the start of path and preserve the internal directory structure.
Usage: ree-pak-cli.exe pack [OPTIONS] --input <INPUT>
Options:
-i, --input <INPUT> Input directory path
-o, --output <OUTPUT> Output PAK file path
--override Override existing file
-h, --help Print help
For example, if you have the following directory structure and input directory is MyExcellentMod:
MyExcellentMod/natives/STM/streaming/Art/Model/Character/ch03/002/001/2/textures/ch03_002_0012_ALBD.tex.241106027
Then the packer will locate the natives/ and trim any path before it, resulting in a file path like:
natives/STM/streaming/Art/Model/Character/ch03/002/001/2/textures/ch03_002_0012_ALBD.tex.241106027
If natives/ not found, tool will issue a warning.
If you have only one input to pack, you can drag-and-drop the folder onto the executable file. The tool will generate an output pak file with default name and options.
Dump information of a PAK file. The output is a JSON file that contains the pak TOC, file entries and file paths.
In other words, the output contains all the data except the actual file contents, even including unknown fields.
Usage: ree-pak-cli.exe dump-info [OPTIONS] --project <PROJECT> --input <INPUT>
Options:
-p, --project <PROJECT> Game project name, e.g. "MHRS_PC_Demo"
-i, --input <INPUT> Input PAK file path
-o, --output <OUTPUT> Output file path
--override Override existing files
-h, --help Print help
Tested on my PC for reference.
Test file: MHRS Demo
| Tool | Version | Time | Notes |
|---|---|---|---|
| RETool | - | 249 s | - |
| REE.Unpacker | 20240921 | 84 s | - |
| REE.Unpacker (No Logging) | 20240921 | 76 s | - |
| MHRUnpack | v1.2 | 218 s (Single Thread) 136 s (Multi Thread) |
High CPU usage, but not very fast. Has GUI. |
| ree-pak-cli | v0.1.0 | 25 s | - |
| ree-pak-cli | v0.2.10 | 20 s | - |