diff options
| author | Valentin Popov <valentin@popov.link> | 2024-01-08 00:39:12 +0300 |
|---|---|---|
| committer | Valentin Popov <valentin@popov.link> | 2024-01-08 00:39:12 +0300 |
| commit | afe1aa538e43685002462d8c34e29521480ae245 (patch) | |
| tree | 4d4050c2759a133a078a465559ec4488ab686f68 | |
| parent | 1b6a04ca5504955c571d1c97504fb45ea0befee4 (diff) | |
| download | fparkan-afe1aa538e43685002462d8c34e29521480ae245.tar.xz fparkan-afe1aa538e43685002462d8c34e29521480ae245.zip | |
Added a README for the packer
Signed-off-by: Valentin Popov <valentin@popov.link>
| -rw-r--r-- | packer/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/packer/README.md b/packer/README.md index e69de29..9edb048 100644 --- a/packer/README.md +++ b/packer/README.md @@ -0,0 +1,27 @@ +# NRes Game Resource Packer + +At the moment, this is a demonstration of the NRes game resource packing algorithm in action. +It packs 100% of the NRes game resources for the game "Parkan: Iron Strategy". +The hash sums of the resulting files match the original game files. + +__Attention!__ +This is a test version of the utility. It overwrites the specified final file without asking. + +## Building + +To build the tools, you need to run the following command in the root directory: + +```bash +cargo build --release +``` + +## Running + +You can run the utility with the following command: + +```bash +./target/release/packer /path/to/unpack /path/to/file.ex +``` + +- `/path/to/unpack`: This is the directory with the resources unpacked by the [unpacker](../unpacker) utility. +- `/path/to/file.ex`: This is the final file that will be created. |