xavo95/repak
1
0
Fork 0
mirror of https://github.com/xavo95/repak.git synced 2025-01-18 10:54:38 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Unreal Engine .pak file library and CLI in rust
96 commits 1 branch 0 tags 8.1 MiB
Rust 98.6%
Shell 1.4%
Find a file
Truman Kilen 9974d035b1 v0.1.6
2023-05-28 23:21:19 -05:00
.github/workflows Rename unpak -> repak 2023-02-01 20:48:37 -06:00
repak Check for invalid entry offsets 2023-05-28 23:21:06 -05:00
repak_cli Obtain oodle DLL automatically 2023-04-13 02:01:19 -05:00
.gitignore Rename unpak -> repak 2023-02-01 20:48:37 -06:00
Cargo.toml v0.1.6 2023-05-28 23:21:19 -05:00
README.md Update README 2023-02-12 11:07:00 -06:00

README.md

repak

Library and CLI tool for working with Unreal Engine .pak files.

  • Supports reading and writing a wide range of versions
  • Easy to use API while providing low level control:
    • Only parses index initially and reads file data upon request
    • Can rewrite index in place to perform append or delete operations without rewriting entire pak

repak CLI

  • Sane handling of mount points: defaults to ../../../ but can be configured via flag
  • 2x faster unpacking over UnrealPak. As much as 30x faster has been observed (on Linux unpacked to ramdisk)
  • Unpacking is guarded against malicious pak that attempt to write to parent directories

compatibility

UE Version Version Version Feature Read Write
1 Initial ❔ ❔
4.0-4.2 2 NoTimestamps ✔️ ✔️
4.3-4.15 3 CompressionEncryption ✔️ ✔️
4.16-4.19 4 IndexEncryption ✔️ ✔️
4.20 5 RelativeChunkOffsets ✔️ ✔️
6 DeleteRecords ❔ ❔
4.21 7 EncryptionKeyGuid ✔️ ✔️
4.22 8A FNameBasedCompression ✔️ ✔️
4.23-4.24 8B FNameBasedCompression ✔️ ✔️
4.25 9 FrozenIndex ✔️ ✔️
10 PathHashIndex ❔ ❔
4.26-4.27 11 Fnv64BugFix ✔️ ✔️
Feature Read Write
Compression ✔️ ❌
Encrypted Index ✔️ ❌
Encrypted Data ✔️ ❌

Supports reading encrypted (both index and/or data) and compressed paks. Writing does not support compression or encryption yet.

notes

determinism

As far as I can tell, the index is not necessarily written deterministically by UnrealPak. repak uses BTreeMap in place of HashMap to deterministically write the index and happens to rewrite the test paks in the same order, but this more likely than not stops happening on larger pak files.

full directory index

UnrealPak includes a directory entry in the full directory index for all parent directories back to the pak root for a given file path regardless of whether those directories contain any files or just other directories. repak only includes directories that contain files. So far no functional differences have been observed as a result.

acknowledgements

  • unpak: original crate featuring read-only pak operations
  • rust-u4pak's README detailing the pak file layout
  • jieyouxu for serialization implementation of the significantly more complex V11 index