Update README.md, added cargo install instructions

This commit is contained in:
G2 2024-07-17 11:35:21 -05:00 committed by GitHub
parent 810002c1fa
commit 9bb24a73f4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -42,46 +42,19 @@ metadata can't be changed as of yet, however.
## Programs
### [lbee-utils](https://github.com/G2-Games/lbee-utils/releases/tag/utils-0.1.1)
Small command line tools for modifying CZ images and PAK archives. Usage for each
is as follows:
Small command line tools for modifying CZ images and PAK archives.
To install with Cargo:
#### pakutil
```
Utility to maniuplate PAK archive files from the LUCA System game engine by Prototype Ltd
Usage: pakutil <PAK FILE> <COMMAND>
Commands:
extract Extracts the contents of a PAK file into a folder
replace Replace the entries in a PAK file
help Print this message or the help of the given subcommand(s)
Arguments:
<PAK FILE>
Options:
-h, --help Print help
-V, --version Print version
cargo install --git https://github.com/G2-Games/lbee-utils utils
```
#### czutil
```
Utility to maniuplate CZ image files from the LUCA System game engine by Prototype Ltd
Otherwise, download the binaries from the Releases page here.
Usage: czutil <COMMAND>
Commands:
decode Converts a CZ file to a PNG
replace Replace a CZ file's image data
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
```
------
### [PAK Explorer](https://github.com/G2-Games/lbee-utils/releases/tag/explorer-0.1.1)
### [PAK Explorer](https://github.com/G2-Games/lbee-utils/releases/tag/explorer-0.1.2)
This is a basic explorer application for PAK files which allows you to see
their contents, replace the contents, extract files, and save them again.
@ -91,3 +64,12 @@ anything important as they offer many more options and allow for batch
operations on many files at once.
![image](https://github.com/user-attachments/assets/0ae93c40-a951-45a7-b5ee-17b60aa96157)
To install with Cargo:
```
cargo install --git https://github.com/G2-Games/lbee-utils pak_explorer
```
Otherwise, download the binaries from the Releases page here.