From f75654fa182cbbdc65d8d04575d11862f4a1ebe7 Mon Sep 17 00:00:00 2001 From: G2 Date: Fri, 12 Jul 2024 00:36:25 -0500 Subject: [PATCH] Update README.md --- README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) diff --git a/README.md b/README.md index 16c2472..427f542 100644 --- a/README.md +++ b/README.md @@ -27,3 +27,56 @@ https://g2games.dev/blog/2024/06/28/the-cz-image-formats/ Partial implementation of PAK files, enough to extract data from most I've encountered, and replace data as long as decoding is successful. Any extra metadata can't be changed as of yet, however. + +## Programs + +### [lbee-utils](https://github.com/G2-Games/lbee-utils/releases/tag/utils-0.1.0) +Small command line tools for modifying CZ images and PAK archives. Usage for each +is as follows: + +#### pakutil +``` +Utility to maniuplate PAK archive files from the LUCA System game engine by Prototype Ltd + +Usage: pakutil + +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: + + +Options: + -h, --help Print help + -V, --version Print version +``` + +#### czutil +``` +Utility to maniuplate CZ image files from the LUCA System game engine by Prototype Ltd + +Usage: czutil + +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) +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. + +While this is a useful tool for just viewing and extracting the contents of +a PAK file, it is recommended to use the command line tools for doing +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)