Skip to content

Commit

Permalink
Add pack unpack examples
Browse files Browse the repository at this point in the history
  • Loading branch information
trumank committed Oct 6, 2023
1 parent f802eab commit d8e82a2
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ Library and CLI tool for working with Unreal Engine .pak files.
- Unpacking is guarded against malicious pak that attempt to write to parent directories

## cli
```
```console
$ repak --help
Usage: repak [OPTIONS] <COMMAND>

Commands:
Expand All @@ -31,6 +32,30 @@ Options:
-V, --version Print version
```

### packing
```console
$ find mod
mod
mod/assets
mod/assets/AssetA.uasset
mod/assets/AssetA.uexp

$ repak pack -v mod
packing assets/AssetA.uasset
packing assets/AssetA.uexp
Packed 4 files to mod.pak

$ repak list mod.pak
assets/AssetA.uasset
assets/AssetA.uexp
```

### unpacking
```console
$ repak --aes-key 0x12345678 unpack MyEncryptedGame.pak
Unpacked 12345 files to MyEncryptedGame from MyEncryptedGame.pak
```

## compatibility

| UE Version | Version | Version Feature | Read | Write |
Expand Down
2 changes: 1 addition & 1 deletion repak_cli/tests/docs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ fn test_readme_help() {

let readme = std::fs::read_to_string(workspace_dir().join("README.md")).unwrap();

assert!(readme.contains(&format!("```\n{help}```")));
assert!(readme.contains(&format!("```console\n$ repak --help\n{help}```")));
}

0 comments on commit d8e82a2

Please sign in to comment.