mirror of
https://github.com/xavo95/repak.git
synced 2025-01-18 02:54:36 +00:00
Add pack unpack examples
This commit is contained in:
parent
f802eab828
commit
d8e82a2d27
2 changed files with 27 additions and 2 deletions
27
README.md
27
README.md
|
@ -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:
|
||||
|
@ -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 |
|
||||
|
|
|
@ -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}```")));
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue