G2/lbee-utils
1
0
Fork 0
mirror of https://github.com/G2-Games/lbee-utils.git synced 2025-04-18 23:02:56 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
A small collection of utilities for exporting and importing assets from Little Busters! English Edition
124 commits 4 branches 8 tags 2.3 MiB
Rust 93.6%
Typst 6.4%
Find a file
G2-Games ff80c4fba5 Update action
2024-07-16 14:19:36 -05:00
.github/workflows Update action 2024-07-16 14:19:36 -05:00
cz Fixed CZ2 compression to be more accurate 2024-07-16 03:16:27 -05:00
luca_pak Fixed version, remove clap from cz and luca_pak 2024-07-11 23:22:38 -05:00
pak_explorer Updated licenses of binary packages 2024-07-13 13:52:01 -05:00
utils Fixed file creation issue in non-batch czutil replace 2024-07-16 03:17:32 -05:00
.gitignore Initial PAK reading implementation 2024-06-11 16:33:27 -05:00
Cargo.toml Renamed experimental to pak_explorer, moved CLI utils to utils 2024-07-11 23:17:40 -05:00
README.md Update README.md 2024-07-15 11:37:16 -05:00

README.md

lbee-utils

A small collection of utilities for exporting and importing assets from games made with LUCA System by Prototype Ltd.

Tested on the following games:

  • Little Busters! English Edition (2017)
  • LOOPERS (2023)
  • Harmonia Full HD Edition (2024)
  • Kanon (2024)
  • planetarian ~Snow Globe~ (Nintendo Switch) (2024)

Acknowledgments

The implementation of compresssion and decompression of CZ1, CZ2, CZ3, and CZ4 was derived from LuckSystem. The implementation for decompression of CZ1, CZ3, and CZ4 was originally derived from GARbro, but no longer is.

This project would not have been possible without the work of these previous projects!

Licensing

The libraries are licensed under the MIT License which allows for easy integration into existing projects. The applications and programs are licensed under the GPLv3. Please read the licences before deciding how to use this project in your own, thank you!

Features

These decoders and encoders are structured as libraries first and tools second. It's possible to use them as a base to build other applications.

CZ Images

Completely accurate CZ# file decoding and encoding. Read more about that here:

https://g2games.dev/blog/2024/06/28/the-cz-image-formats/

PAK Archives

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

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 <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

czutil

Utility to maniuplate CZ image files from the LUCA System game engine by Prototype Ltd

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

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