Fixed libasound2 installation

.github/workflows/build_pak_explorer.yml

@@ -0,0 +1,115 @@
+name: Publish PAK Explorer on release
+
+on:
+  push:
+    tags: [ 'explorer-*.*.*' ]
+
+env:
+    BINARIES: "--bin pak_explorer"
+
+permissions:
+  contents: write
+
+jobs:
+    build:
+        name: Build binaries for Windows and Linux
+        runs-on: ubuntu-latest
+        steps:
+        - name: '📄 Checkout'
+          uses: actions/checkout@v4
+
+        - name: '⚙️ Set up Rust environment'
+          uses: dtolnay/rust-toolchain@master
+          with:
+              toolchain: stable
+              targets: x86_64-pc-windows-gnu, i686-pc-windows-gnu, x86_64-unknown-linux-gnu, aarch64-unknown-linux-gnu
+
+        - name: '🔽 Cache Rust dependencies'
+          uses: actions/cache@v4
+          with:
+              path: target
+              key: ${{ runner.OS }}-build-${{ hashFiles('**/Cargo.lock') }}
+              restore-keys: |
+                  ${{ runner.OS }}-build-
+
+        - name: '🔄 Set up additional requirements'
+          run: |
+            sudo apt-get install -y gcc-mingw-w64
+            sudo apt-get install -y libasound2t64
+            pip install cargo-zigbuild
+
+        - name: '📦 Package Windows x86_64'
+          run: |
+              cd ${{github.workspace}}
+              cargo build --profile production --target x86_64-pc-windows-gnu $BINARIES
+              cp target/x86_64-pc-windows-gnu/production/pak_explorer.exe PAK-Explorer_Windows-x86_64.exe
+              gh release upload ${{ github.ref_name }} PAK-Explorer_Windows-x86_64.exe
+          env:
+              GITHUB_TOKEN: ${{ github.TOKEN }}
+          shell: bash
+
+        - name: '📦 Package Windows i686'
+          run: |
+              cd ${{github.workspace}}
+              cargo build --profile production --target i686-pc-windows-gnu $BINARIES
+              cp target/i686-pc-windows-gnu/production/pak_explorer.exe PAK-Explorer_Windows-x86.exe
+              gh release upload ${{ github.ref_name }} PAK-Explorer_Windows-x86.exe
+          env:
+              GITHUB_TOKEN: ${{ github.TOKEN }}
+          shell: bash
+
+        - name: '📦 Package Linux x86_64'
+          run: |
+              cd ${{github.workspace}}
+              cargo build --profile production --target x86_64-unknown-linux-gnu $BINARIES
+              cp target/x86_64-unknown-linux-gnu/production/pak_explorer PAK-Explorer_Linux-x86_64
+              gh release upload ${{ github.ref_name }} PAK-Explorer_Linux-x86_64
+          env:
+              GITHUB_TOKEN: ${{ github.TOKEN }}
+          shell: bash
+
+        - name: '📦 Package Linux aarch64'
+          run: |
+              cd ${{github.workspace}}
+              cargo zigbuild --profile production --target aarch64-unknown-linux-gnu $BINARIES
+              cp target/aarch64-unknown-linux-gnu/production/pak_explorer PAK-Explorer_Linux-Arm64
+              gh release upload ${{ github.ref_name }} PAK-Explorer_Linux-Arm64
+          env:
+              GITHUB_TOKEN: ${{ github.TOKEN }}
+          shell: bash
+
+    build-mac:
+        name: Build binaries for MacOS
+        runs-on: macos-14
+        steps:
+        - name: '📄 Checkout'
+          uses: actions/checkout@v4
+
+        - name: '⚙️ Set up Rust environment'
+          uses: dtolnay/rust-toolchain@master
+          with:
+              toolchain: stable
+              targets: x86_64-apple-darwin, aarch64-apple-darwin
+
+        - name: '🔽 Cache Rust dependencies'
+          uses: actions/cache@v4
+          with:
+              path: target
+              key: ${{ runner.OS }}-build-${{ hashFiles('**/Cargo.lock') }}
+              restore-keys: |
+                  ${{ runner.OS }}-build-
+
+        - name: '🔄 Set up additional requirements'
+          run: |
+            brew install zig
+            cargo install --locked cargo-zigbuild
+
+        - name: '📦 Package MacOS Universal2'
+          run: |
+              cd ${{github.workspace}}
+              cargo zigbuild --manifest-path "pak_explorer/Cargo.toml" --profile production --target universal2-apple-darwin $BINARIES
+              cp target/universal2-apple-darwin/production/pak_explorer PAK-Explorer_Mac-Universal
+              gh release upload ${{ github.ref_name }} PAK-Explorer_Mac-Universal
+          env:
+              GITHUB_TOKEN: ${{ github.TOKEN }}
+          shell: bash

.github/workflows/build_utils.yml

@@ -0,0 +1,114 @@
+name: Publish utilities on release
+
+on:
+  push:
+    tags: [ 'utils-*.*.*' ]
+
+env:
+    BINARIES: "--bin czutil --bin pakutil"
+
+permissions:
+  contents: write
+
+jobs:
+    build:
+        name: Build binaries for Windows and Linux
+        runs-on: ubuntu-latest
+        steps:
+        - name: '📄 Checkout'
+          uses: actions/checkout@v4
+
+        - name: '⚙️ Set up Rust environment'
+          uses: dtolnay/rust-toolchain@master
+          with:
+              toolchain: stable
+              targets: x86_64-pc-windows-gnu, i686-pc-windows-gnu, x86_64-unknown-linux-gnu, aarch64-unknown-linux-gnu
+
+        - name: '🔽 Cache Rust dependencies'
+          uses: actions/cache@v4
+          with:
+              path: target
+              key: ${{ runner.OS }}-build-${{ hashFiles('**/Cargo.lock') }}
+              restore-keys: |
+                  ${{ runner.OS }}-build-
+
+        - name: '🔄 Set up additional requirements'
+          run: |
+            sudo apt-get install -y gcc-mingw-w64
+            pip install cargo-zigbuild
+
+        - name: '📦 Package Windows x86_64'
+          run: |
+              cd ${{github.workspace}}
+              cargo build --profile production --target x86_64-pc-windows-gnu $BINARIES
+              zip -j lbee-utils_Windows-x86_64.zip target/x86_64-pc-windows-gnu/production/czutil.exe target/x86_64-pc-windows-gnu/production/pakutil.exe
+              gh release upload ${{ github.ref_name }} lbee-utils_Windows-x86_64.zip
+          env:
+              GITHUB_TOKEN: ${{ github.TOKEN }}
+          shell: bash
+
+        - name: '📦 Package Windows i686'
+          run: |
+              cd ${{github.workspace}}
+              cargo build --profile production --target i686-pc-windows-gnu $BINARIES
+              zip -j lbee-utils_Windows-x86.zip target/i686-pc-windows-gnu/production/czutil.exe target/i686-pc-windows-gnu/production/pakutil.exe
+              gh release upload ${{ github.ref_name }} lbee-utils_Windows-x86.zip
+          env:
+              GITHUB_TOKEN: ${{ github.TOKEN }}
+          shell: bash
+
+        - name: '📦 Package Linux x86_64'
+          run: |
+              cd ${{github.workspace}}
+              cargo build --profile production --target x86_64-unknown-linux-gnu $BINARIES
+              zip -j lbee-utils_Linux-x86_64.zip target/x86_64-unknown-linux-gnu/production/czutil target/x86_64-unknown-linux-gnu/production/pakutil
+              gh release upload ${{ github.ref_name }} lbee-utils_Linux-x86_64.zip
+          env:
+              GITHUB_TOKEN: ${{ github.TOKEN }}
+          shell: bash
+
+        - name: '📦 Package Linux aarch64'
+          run: |
+              cd ${{github.workspace}}
+              cargo zigbuild --profile production --target aarch64-unknown-linux-gnu $BINARIES
+              zip -j lbee-utils_Linux-Arm64.zip target/aarch64-unknown-linux-gnu/production/czutil target/aarch64-unknown-linux-gnu/production/pakutil
+              gh release upload ${{ github.ref_name }} lbee-utils_Linux-Arm64.zip
+          env:
+              GITHUB_TOKEN: ${{ github.TOKEN }}
+          shell: bash
+
+    build-mac:
+        name: Build binaries for MacOS
+        runs-on: macos-14
+        steps:
+        - name: '📄 Checkout'
+          uses: actions/checkout@v4
+
+        - name: '⚙️ Set up Rust environment'
+          uses: dtolnay/rust-toolchain@master
+          with:
+              toolchain: stable
+              targets: x86_64-apple-darwin, aarch64-apple-darwin
+
+        - name: '🔽 Cache Rust dependencies'
+          uses: actions/cache@v4
+          with:
+              path: target
+              key: ${{ runner.OS }}-build-${{ hashFiles('**/Cargo.lock') }}
+              restore-keys: |
+                  ${{ runner.OS }}-build-
+
+        - name: '🔄 Set up additional requirements'
+          run: |
+            brew install zig
+            cargo install --locked cargo-zigbuild
+
+        - name: '📦 Package MacOS Universal2'
+          run: |
+              cd ${{github.workspace}}
+              cargo zigbuild --manifest-path "utils/Cargo.toml" --profile production --target universal2-apple-darwin $BINARIES
+              zip -j lbee-utils_Mac-Universal.zip target/universal2-apple-darwin/production/czutil target/universal2-apple-darwin/production/pakutil
+              gh release upload ${{ github.ref_name }} lbee-utils_Mac-Universal.zip
+          env:
+              GITHUB_TOKEN: ${{ github.TOKEN }}
+          shell: bash

.gitignore

@@ -9,7 +9,8 @@ Cargo.lock
 # These are backup files generated by rustfmt
 **/*.rs.bk
 
-# Ignore text files
+# Ignore documentation and stuff
+*.pdf
 *.txt
 
 # Ignore testing files

Cargo.toml

@@ -3,7 +3,7 @@ resolver = "2"
 members = [
     "cz",
     "pak_explorer",
-    "luca_pak", "utils",
+    "luca_pak", "utils", "luca_script",
 ]
 
 [workspace.package]

README.md

@@ -1,4 +1,9 @@
-# lbee-utils
+<p align="center">
+    <img width="80%" src="https://github.com/user-attachments/assets/6807854b-aa4b-431d-933f-9e5b63ff5ed3">
+</p>
+
+
+# Lbee-Utils
 A small collection of utilities for exporting and importing assets from games
 made with LUCA System by [Prototype Ltd](https://www.prot.co.jp/).
 
@@ -6,15 +11,30 @@ 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)
+
+Please test on your own games and open an issue if something isn't working.
 
 ## Acknowledgments
-The implementation for decompression of CZ1, CZ3, and CZ4 was originally derived from
-[GARbro](https://github.com/morkt/GARbro/). The implementation of compresssion
-and decompression of CZ1, CZ2, CZ3, and CZ4 was derived from [LuckSystem](https://github.com/wetor/LuckSystem).
-This project would not have been possible without their amazing work.
+The implementation of compresssion and decompression of CZ1, CZ2, CZ3, and CZ4 
+was derived from [LuckSystem](https://github.com/wetor/LuckSystem). The 
+implementation for decompression of CZ1, CZ3, and CZ4 was originally derived from 
+[GARbro](https://github.com/morkt/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](https://choosealicense.com/licenses/mit/) which allows for easy
+integration into existing projects. The applications and programs are licensed
+under the [GPLv3](https://choosealicense.com/licenses/gpl-3.0/). 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.
+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:
@@ -22,4 +42,40 @@ 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.
+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.1)
+Small command line tools for modifying CZ images and PAK archives.
+
+To install with Cargo:
+```
+cargo install --git https://github.com/G2-Games/lbee-utils lbee-utils
+```
+
+Otherwise, download the binaries from the Releases page here.
+
+------
+
+### [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.
+
+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)
+
+
+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.

cz/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "cz"
 edition = "2021"
-version = "0.1.2"
+version = "0.1.3"
 description="""
 An encoder/decoder for CZ# image files used in the LUCA System engine by
 Prototype Ltd.
@@ -9,17 +9,11 @@ Prototype Ltd.
 license = "MIT"
 authors.workspace = true
 
-[features]
-png = ["dep:image"]
-
 [dependencies]
-byteorder = "1.5"
-thiserror = "1.0"
+byteorder-lite = "0.1"
+thiserror = "2.0"
 imagequant = "4.3"
 rgb = "0.8"
 
-# Only active on PNG feature
-image = { version = "0.25", optional = true }
-
 [lints]
 workspace = true

cz/src/color.rs

@@ -1,4 +1,3 @@
-use byteorder::ReadBytesExt;
 use imagequant::Attributes;
 use rgb::{ComponentSlice, RGBA8};
 use std::{
@@ -35,10 +34,7 @@ impl Palette {
 }
 
 /// Get a palette from the input stream, beginning where the palette starts.
-pub fn get_palette<T: Seek + ReadBytesExt + Read>(
-    input: &mut T,
-    num_colors: usize,
-) -> Result<Palette, CzError> {
+pub fn get_palette<T: Seek + Read>(input: &mut T, num_colors: usize) -> Result<Palette, CzError> {
     let mut colormap = Vec::with_capacity(num_colors);
     let mut rgba_buf = [0u8; 4];
 

cz/src/common.rs

@@ -2,7 +2,7 @@
 
 use std::io::{self, Read, Seek, Write};
 
-use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
+use byteorder_lite::{ReadBytesExt, WriteBytesExt, LE};
 use thiserror::Error;
 
 #[derive(Error, Debug)]
@@ -43,7 +43,7 @@ pub enum CzVersion {
 }
 
 impl TryFrom<u8> for CzVersion {
-    type Error = &'static str;
+    type Error = String;
 
     fn try_from(value: u8) -> Result<Self, Self::Error> {
         let value = match value {
@@ -53,7 +53,7 @@ impl TryFrom<u8> for CzVersion {
             3 => Self::CZ3,
             4 => Self::CZ4,
             5 => Self::CZ5,
-            _ => return Err("Value is not a valid CZ version"),
+            v => return Err(format!("{} is not a valid CZ version", v)),
         };
 
         Ok(value)
@@ -61,7 +61,7 @@ impl TryFrom<u8> for CzVersion {
 }
 
 impl TryFrom<char> for CzVersion {
-    type Error = &'static str;
+    type Error = String;
 
     fn try_from(value: char) -> Result<Self, Self::Error> {
         let value = match value {
@@ -71,7 +71,7 @@ impl TryFrom<char> for CzVersion {
             '3' => Self::CZ3,
             '4' => Self::CZ4,
             '5' => Self::CZ5,
-            _ => return Err("Value is not a valid CZ version"),
+            v => return Err(format!("{} is not a valid CZ version", v)),
         };
 
         Ok(value)
@@ -132,10 +132,10 @@ impl CommonHeader {
 
         let mut header = Self {
             version,
-            length: bytes.read_u32::<LittleEndian>()?,
-            width: bytes.read_u16::<LittleEndian>()?,
-            height: bytes.read_u16::<LittleEndian>()?,
-            depth: bytes.read_u16::<LittleEndian>()?,
+            length: bytes.read_u32::<LE>()?,
+            width: bytes.read_u16::<LE>()?,
+            height: bytes.read_u16::<LE>()?,
+            depth: bytes.read_u16::<LE>()?,
             unknown: bytes.read_u8()?,
         };
 
@@ -204,10 +204,10 @@ impl CommonHeader {
         let magic_bytes = [b'C', b'Z', b'0' + self.version as u8, b'\0'];
 
         output.write_all(&magic_bytes)?;
-        output.write_u32::<LittleEndian>(self.length() as u32)?;
-        output.write_u16::<LittleEndian>(self.width())?;
-        output.write_u16::<LittleEndian>(self.height())?;
-        output.write_u16::<LittleEndian>(self.depth())?;
+        output.write_u32::<LE>(self.length() as u32)?;
+        output.write_u16::<LE>(self.width())?;
+        output.write_u16::<LE>(self.height())?;
+        output.write_u16::<LE>(self.depth())?;
         output.write_u8(self.color_block())?;
 
         Ok(())
@@ -282,27 +282,27 @@ impl ExtendedHeader {
         self
     }
 
-    pub fn from_bytes<T: Seek + ReadBytesExt + Read>(
+    pub fn from_bytes<T: Seek + Read>(
         input: &mut T,
         common_header: &CommonHeader,
     ) -> Result<Self, CzError> {
         let mut unknown_1 = [0u8; 5];
         input.read_exact(&mut unknown_1)?;
 
-        let crop_width = input.read_u16::<LittleEndian>()?;
-        let crop_height = input.read_u16::<LittleEndian>()?;
+        let crop_width = input.read_u16::<LE>()?;
+        let crop_height = input.read_u16::<LE>()?;
 
-        let bounds_width = input.read_u16::<LittleEndian>()?;
-        let bounds_height = input.read_u16::<LittleEndian>()?;
+        let bounds_width = input.read_u16::<LE>()?;
+        let bounds_height = input.read_u16::<LE>()?;
 
         let mut offset_width = None;
         let mut offset_height = None;
         let mut unknown_2 = None;
         if common_header.length() > 28 {
-            offset_width = Some(input.read_u16::<LittleEndian>()?);
-            offset_height = Some(input.read_u16::<LittleEndian>()?);
+            offset_width = Some(input.read_u16::<LE>()?);
+            offset_height = Some(input.read_u16::<LE>()?);
 
-            unknown_2 = Some(input.read_u32::<LittleEndian>()?);
+            unknown_2 = Some(input.read_u32::<LE>()?);
         }
 
         Ok(Self {
@@ -321,17 +321,17 @@ impl ExtendedHeader {
         })
     }
 
-    pub fn write_into<T: WriteBytesExt + Write>(&self, output: &mut T) -> Result<(), io::Error> {
+    pub fn write_into<T: Write>(&self, output: &mut T) -> Result<(), io::Error> {
         output.write_all(&self.unknown_1)?;
-        output.write_u16::<LittleEndian>(self.crop_width)?;
-        output.write_u16::<LittleEndian>(self.crop_height)?;
-        output.write_u16::<LittleEndian>(self.bounds_width)?;
-        output.write_u16::<LittleEndian>(self.bounds_height)?;
+        output.write_u16::<LE>(self.crop_width)?;
+        output.write_u16::<LE>(self.crop_height)?;
+        output.write_u16::<LE>(self.bounds_width)?;
+        output.write_u16::<LE>(self.bounds_height)?;
 
         if self.offset_width.is_some() {
-            output.write_u16::<LittleEndian>(self.offset_width.unwrap())?;
-            output.write_u16::<LittleEndian>(self.offset_height.unwrap())?;
-            output.write_u32::<LittleEndian>(self.unknown_2.unwrap())?;
+            output.write_u16::<LE>(self.offset_width.unwrap())?;
+            output.write_u16::<LE>(self.offset_height.unwrap())?;
+            output.write_u32::<LE>(self.unknown_2.unwrap())?;
         }
 
         Ok(())

cz/src/compression.rs

@@ -1,4 +1,3 @@
-use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
 use std::{
     collections::HashMap,
     io::{Read, Seek, Write},
@@ -6,6 +5,7 @@ use std::{
 
 use crate::binio::BitIo;
 use crate::common::CzError;
+use byteorder_lite::{ReadBytesExt, WriteBytesExt, LE};
 
 /// The size of compressed data in each chunk
 #[derive(Debug, Clone, Copy)]
@@ -37,15 +37,12 @@ pub struct CompressionInfo {
 }
 
 impl CompressionInfo {
-    pub fn write_into<T: WriteBytesExt + Write>(
-        &self,
-        output: &mut T,
-    ) -> Result<(), std::io::Error> {
-        output.write_u32::<LittleEndian>(self.chunk_count as u32)?;
+    pub fn write_into<T: Write>(&self, output: &mut T) -> Result<(), std::io::Error> {
+        output.write_u32::<LE>(self.chunk_count as u32)?;
 
         for chunk in &self.chunks {
-            output.write_u32::<LittleEndian>(chunk.size_compressed as u32)?;
-            output.write_u32::<LittleEndian>(chunk.size_raw as u32)?;
+            output.write_u32::<LE>(chunk.size_compressed as u32)?;
+            output.write_u32::<LE>(chunk.size_raw as u32)?;
         }
 
         Ok(())
@@ -56,10 +53,8 @@ impl CompressionInfo {
 ///
 /// These are defined by a length value, followed by the number of data chunks
 /// that length value says split into compressed and original size u32 values
-pub fn get_chunk_info<T: Seek + ReadBytesExt + Read>(
-    bytes: &mut T,
-) -> Result<CompressionInfo, CzError> {
-    let parts_count = bytes.read_u32::<LittleEndian>()?;
+pub fn get_chunk_info<T: Seek + Read>(bytes: &mut T) -> Result<CompressionInfo, CzError> {
+    let parts_count = bytes.read_u32::<LE>()?;
 
     let mut part_sizes = vec![];
     let mut total_size = 0;
@@ -67,10 +62,10 @@ pub fn get_chunk_info<T: Seek + ReadBytesExt + Read>(
 
     // Loop over the compressed bytes
     for _ in 0..parts_count {
-        let compressed_size = bytes.read_u32::<LittleEndian>()?;
+        let compressed_size = bytes.read_u32::<LE>()?;
         total_size = i32::wrapping_add(total_size, compressed_size as i32);
 
-        let raw_size = bytes.read_u32::<LittleEndian>()?;
+        let raw_size = bytes.read_u32::<LE>()?;
         total_size_raw = u32::wrapping_add(total_size_raw, raw_size);
 
         part_sizes.push(ChunkInfo {
@@ -89,7 +84,7 @@ pub fn get_chunk_info<T: Seek + ReadBytesExt + Read>(
 }
 
 /// Decompress an LZW compressed stream like CZ1
-pub fn decompress<T: Seek + ReadBytesExt + Read>(
+pub fn decompress<T: Seek + Read>(
     input: &mut T,
     chunk_info: &CompressionInfo,
 ) -> Result<Vec<u8>, CzError> {
@@ -99,7 +94,7 @@ pub fn decompress<T: Seek + ReadBytesExt + Read>(
         let mut buffer = vec![0u16; block.size_compressed];
 
         for word in buffer.iter_mut() {
-            *word = input.read_u16::<LittleEndian>().unwrap();
+            *word = input.read_u16::<LE>().unwrap();
         }
 
         let raw_buf = decompress_lzw(&buffer, block.size_raw);
@@ -144,7 +139,7 @@ fn decompress_lzw(input_data: &[u16], size: usize) -> Vec<u8> {
 }
 
 /// Decompress an LZW compressed stream like CZ2
-pub fn decompress2<T: Seek + ReadBytesExt + Read>(
+pub fn decompress2<T: Seek + Read>(
     input: &mut T,
     chunk_info: &CompressionInfo,
 ) -> Result<Vec<u8>, CzError> {
@@ -163,8 +158,7 @@ pub fn decompress2<T: Seek + ReadBytesExt + Read>(
 }
 
 fn decompress_lzw2(input_data: &[u8], size: usize) -> Vec<u8> {
-    let mut data = input_data.to_vec();
-    data[0] = 0;
+    let data = input_data;
     let mut dictionary = HashMap::new();
     for i in 0..256 {
         dictionary.insert(i as u64, vec![i as u8]);
@@ -173,12 +167,15 @@ fn decompress_lzw2(input_data: &[u8], size: usize) -> Vec<u8> {
     let mut result = Vec::with_capacity(size);
 
     let data_size = input_data.len();
-    data.extend_from_slice(&[0, 0]);
-    let mut bit_io = BitIo::new(data);
+    let mut bit_io = BitIo::new(data.to_vec());
     let mut w = dictionary.get(&0).unwrap().clone();
 
     let mut element;
     loop {
+        if bit_io.byte_offset() >= data_size - 1 {
+            break;
+        }
+
         let flag = bit_io.read_bit(1);
         if flag == 0 {
             element = bit_io.read_bit(15);
@@ -186,10 +183,6 @@ fn decompress_lzw2(input_data: &[u8], size: usize) -> Vec<u8> {
             element = bit_io.read_bit(18);
         }
 
-        if bit_io.byte_offset() > data_size {
-            break;
-        }
-
         let mut entry;
         if let Some(x) = dictionary.get(&element) {
             // If the element was already in the dict, get it
@@ -198,7 +191,11 @@ fn decompress_lzw2(input_data: &[u8], size: usize) -> Vec<u8> {
             entry = w.clone();
             entry.push(w[0])
         } else {
-            panic!("Bad compressed element: {}", element)
+            panic!(
+                "Bad compressed element {} at offset {}",
+                element,
+                bit_io.byte_offset()
+            )
         }
 
         //println!("{}", element);
@@ -313,9 +310,7 @@ fn compress_lzw(data: &[u8], size: usize, last: Vec<u8>) -> (usize, Vec<u16>, Ve
     (count, compressed, last_element)
 }
 
-pub fn compress2(data: &[u8], size: usize) -> (Vec<u8>, CompressionInfo) {
-    let size = if size == 0 { 0x87BDF } else { size };
-
+pub fn compress2(data: &[u8]) -> (Vec<u8>, CompressionInfo) {
     let mut part_data;
 
     let mut offset = 0;
@@ -329,7 +324,7 @@ pub fn compress2(data: &[u8], size: usize) -> (Vec<u8>, CompressionInfo) {
     };
 
     loop {
-        (count, part_data, last) = compress_lzw2(&data[offset..], size, last);
+        (count, part_data, last) = compress_lzw2(&data[offset..], last);
         if count == 0 {
             break;
         }
@@ -347,20 +342,13 @@ pub fn compress2(data: &[u8], size: usize) -> (Vec<u8>, CompressionInfo) {
 
     if output_info.chunk_count == 0 {
         panic!("No chunks compressed!")
-    } else if output_info.chunk_count != 1 {
-        output_info.chunks[0].size_raw -= 1;
-        output_info.chunks[output_info.chunk_count - 1].size_raw += 1;
     }
 
     output_info.total_size_compressed = output_buf.len();
     (output_buf, output_info)
 }
 
-fn compress_lzw2(data: &[u8], size: usize, last: Vec<u8>) -> (usize, Vec<u8>, Vec<u8>) {
-    let mut data = data.to_vec();
-    if !data.is_empty() {
-        data[0] = 0;
-    }
+fn compress_lzw2(data: &[u8], last: Vec<u8>) -> (usize, Vec<u8>, Vec<u8>) {
     let mut count = 0;
     let mut dictionary = HashMap::new();
     for i in 0..=255 {
@@ -373,7 +361,7 @@ fn compress_lzw2(data: &[u8], size: usize, last: Vec<u8>) -> (usize, Vec<u8>, Ve
         element = last
     }
 
-    let mut bit_io = BitIo::new(vec![0u8; size + 2]);
+    let mut bit_io = BitIo::new(vec![0u8; 0xF0000]);
     let write_bit = |bit_io: &mut BitIo, code: u64| {
         if code > 0x7FFF {
             bit_io.write_bit(1, 1);
@@ -399,7 +387,7 @@ fn compress_lzw2(data: &[u8], size: usize, last: Vec<u8>) -> (usize, Vec<u8>, Ve
 
         count += 1;
 
-        if size > 0 && bit_io.byte_size() >= size {
+        if dictionary_count >= 0x3FFFE {
             count -= 1;
             break;
         }
@@ -412,11 +400,13 @@ fn compress_lzw2(data: &[u8], size: usize, last: Vec<u8>) -> (usize, Vec<u8>, Ve
                 write_bit(&mut bit_io, *dictionary.get(&vec![c]).unwrap());
             }
         }
+
         return (count, bit_io.bytes(), Vec::new());
-    } else if bit_io.byte_size() < size {
+    } else if bit_io.byte_size() < 0x87BDF {
         if !last_element.is_empty() {
             write_bit(&mut bit_io, *dictionary.get(&last_element).unwrap());
         }
+
         return (count, bit_io.bytes(), Vec::new());
     }
 

cz/src/dynamic.rs

@@ -1,4 +1,4 @@
-use byteorder::ReadBytesExt;
+use byteorder_lite::ReadBytesExt;
 use rgb::ComponentSlice;
 use std::{
     fs::File,
@@ -13,7 +13,7 @@ use crate::{
 
 /// A CZ# interface which can open and save any CZ file type.
 #[derive(Debug, Clone)]
-pub struct DynamicCz {
+pub struct CzFile {
     header_common: CommonHeader,
     header_extended: Option<ExtendedHeader>,
 
@@ -24,7 +24,7 @@ pub struct DynamicCz {
     bitmap: Vec<u8>,
 }
 
-impl DynamicCz {
+impl CzFile {
     /// Decode a CZ# file from anything that implements [`Read`] and [`Seek`]
     ///
     /// The input must begin with the
@@ -54,7 +54,7 @@ impl DynamicCz {
             CzVersion::CZ2 => cz2::decode(input)?,
             CzVersion::CZ3 => cz3::decode(input, &header_common)?,
             CzVersion::CZ4 => cz4::decode(input, &header_common)?,
-            CzVersion::CZ5 => unimplemented!(),
+            CzVersion::CZ5 => unimplemented!("CZ5 files are not implemented! Please contact the application developers about this file."),
         };
 
         let image_size = header_common.width() as usize * header_common.height() as usize;
@@ -192,43 +192,9 @@ impl DynamicCz {
         Ok(())
     }
 
-    /// Save the CZ# image as a lossless PNG file.
-    ///
-    /// Internally, the [`DynamicCz`] struct operates on 32-bit RGBA values,
-    /// which is the highest encountered in CZ# files, therefore saving them
-    /// as a PNG of the same or better quality is lossless.
-    #[cfg(feature = "png")]
-    pub fn save_as_png<P: ?Sized + AsRef<std::path::Path>>(
-        &self,
-        path: &P,
-    ) -> Result<(), image::error::EncodingError> {
-        let size = (self.header_common.width() as u32 * self.header_common.height() as u32) * 4;
-
-        let mut buf = vec![0; size as usize];
-        buf[..self.bitmap.len()].copy_from_slice(&self.bitmap);
-
-        let image = image::RgbaImage::from_raw(
-            self.header_common.width() as u32,
-            self.header_common.height() as u32,
-            buf.clone(),
-        )
-        .unwrap();
-
-        image
-            .save_with_format(path, image::ImageFormat::Png)
-            .unwrap();
-
-        Ok(())
-    }
-
     /// Create a CZ# image from RGBA bytes. The bytes *must* be RGBA, as that
     /// is the only format that is used internally.
-    pub fn from_raw(
-        version: CzVersion,
-        width: u16,
-        height: u16,
-        bitmap: Vec<u8>,
-    ) -> Self {
+    pub fn from_raw(version: CzVersion, width: u16, height: u16, bitmap: Vec<u8>) -> Self {
         let header_common = CommonHeader::new(version, width, height);
 
         Self {

cz/src/formats/cz0.rs

@@ -1,9 +1,8 @@
-use byteorder::{ReadBytesExt, WriteBytesExt};
 use std::io::{Read, Seek, Write};
 
 use crate::common::CzError;
 
-pub fn decode<T: Seek + ReadBytesExt + Read>(input: &mut T) -> Result<Vec<u8>, CzError> {
+pub fn decode<T: Seek + Read>(input: &mut T) -> Result<Vec<u8>, CzError> {
     // Get the rest of the file, which is the bitmap
     let mut bitmap = vec![];
     input.read_to_end(&mut bitmap)?;
@@ -11,7 +10,7 @@ pub fn decode<T: Seek + ReadBytesExt + Read>(input: &mut T) -> Result<Vec<u8>, C
     Ok(bitmap)
 }
 
-pub fn encode<T: WriteBytesExt + Write>(output: &mut T, bitmap: &[u8]) -> Result<(), CzError> {
+pub fn encode<T: Write>(output: &mut T, bitmap: &[u8]) -> Result<(), CzError> {
     output.write_all(bitmap)?;
 
     Ok(())

cz/src/formats/cz1.rs

@@ -1,10 +1,9 @@
-use byteorder::{ReadBytesExt, WriteBytesExt};
 use std::io::{Read, Seek, SeekFrom, Write};
 
 use crate::common::CzError;
 use crate::compression::{compress, decompress, get_chunk_info};
 
-pub fn decode<T: Seek + ReadBytesExt + Read>(bytes: &mut T) -> Result<Vec<u8>, CzError> {
+pub fn decode<T: Seek + Read>(bytes: &mut T) -> Result<Vec<u8>, CzError> {
     // Get information about the compressed chunks
     let block_info = get_chunk_info(bytes)?;
     bytes.seek(SeekFrom::Start(block_info.length as u64))?;
@@ -15,7 +14,7 @@ pub fn decode<T: Seek + ReadBytesExt + Read>(bytes: &mut T) -> Result<Vec<u8>, C
     Ok(bitmap)
 }
 
-pub fn encode<T: WriteBytesExt + Write>(output: &mut T, bitmap: &[u8]) -> Result<(), CzError> {
+pub fn encode<T: Write>(output: &mut T, bitmap: &[u8]) -> Result<(), CzError> {
     let (compressed_data, compressed_info) = compress(bitmap, 0xFEFD);
 
     compressed_info.write_into(output)?;

cz/src/formats/cz2.rs

@@ -1,12 +1,11 @@
-use byteorder::{ReadBytesExt, WriteBytesExt};
 use std::io::{Read, Seek, SeekFrom, Write};
 
 use crate::common::CzError;
 use crate::compression::{compress2, decompress2, get_chunk_info};
 
-pub fn decode<T: Seek + ReadBytesExt + Read>(bytes: &mut T) -> Result<Vec<u8>, CzError> {
+pub fn decode<T: Seek + Read>(bytes: &mut T) -> Result<Vec<u8>, CzError> {
     // Get information about the compressed chunks
-    let block_info = get_chunk_info(bytes).unwrap();
+    let block_info = get_chunk_info(bytes)?;
     bytes.seek(SeekFrom::Start(block_info.length as u64))?;
 
     // Get the bitmap
@@ -15,8 +14,8 @@ pub fn decode<T: Seek + ReadBytesExt + Read>(bytes: &mut T) -> Result<Vec<u8>, C
     Ok(bitmap)
 }
 
-pub fn encode<T: WriteBytesExt + Write>(output: &mut T, bitmap: &[u8]) -> Result<(), CzError> {
-    let (compressed_data, compressed_info) = compress2(bitmap, 0x87BDF);
+pub fn encode<T: Write>(output: &mut T, bitmap: &[u8]) -> Result<(), CzError> {
+    let (compressed_data, compressed_info) = compress2(bitmap);
 
     compressed_info.write_into(output)?;
 

cz/src/formats/cz3.rs

@@ -1,13 +1,9 @@
-use byteorder::{ReadBytesExt, WriteBytesExt};
 use std::io::{Read, Seek, SeekFrom, Write};
 
 use crate::common::{CommonHeader, CzError};
 use crate::compression::{compress, decompress, get_chunk_info};
 
-pub fn decode<T: Seek + ReadBytesExt + Read>(
-    bytes: &mut T,
-    header: &CommonHeader,
-) -> Result<Vec<u8>, CzError> {
+pub fn decode<T: Seek + Read>(bytes: &mut T, header: &CommonHeader) -> Result<Vec<u8>, CzError> {
     let block_info = get_chunk_info(bytes)?;
     bytes.seek(SeekFrom::Start(block_info.length as u64))?;
 
@@ -18,7 +14,7 @@ pub fn decode<T: Seek + ReadBytesExt + Read>(
     Ok(bitmap)
 }
 
-pub fn encode<T: WriteBytesExt + Write>(
+pub fn encode<T: Write>(
     output: &mut T,
     bitmap: &[u8],
     header: &CommonHeader,

cz/src/formats/cz4.rs

@@ -1,13 +1,9 @@
-use byteorder::{ReadBytesExt, WriteBytesExt};
 use std::io::{Read, Seek, SeekFrom, Write};
 
 use crate::common::{CommonHeader, CzError};
 use crate::compression::{compress, decompress, get_chunk_info};
 
-pub fn decode<T: Seek + ReadBytesExt + Read>(
-    bytes: &mut T,
-    header: &CommonHeader,
-) -> Result<Vec<u8>, CzError> {
+pub fn decode<T: Seek + Read>(bytes: &mut T, header: &CommonHeader) -> Result<Vec<u8>, CzError> {
     let block_info = get_chunk_info(bytes)?;
     bytes.seek(SeekFrom::Start(block_info.length as u64))?;
 
@@ -18,18 +14,14 @@ pub fn decode<T: Seek + ReadBytesExt + Read>(
     Ok(bitmap)
 }
 
-pub fn encode<T: WriteBytesExt + Write>(
+pub fn encode<T: Write>(
     output: &mut T,
     bitmap: &[u8],
     header: &CommonHeader,
 ) -> Result<(), CzError> {
-    let timer = std::time::Instant::now();
     let bitmap = diff_line(header, bitmap);
-    println!("diff_line took {:?}", timer.elapsed());
 
-    let timer = std::time::Instant::now();
     let (compressed_data, compressed_info) = compress(&bitmap, 0xFEFD);
-    println!("Compression took {:?}", timer.elapsed());
 
     compressed_info.write_into(output)?;
 

cz/src/lib.rs

@@ -17,14 +17,14 @@ use common::CzError;
 use std::{io::BufReader, path::Path};
 
 /// Open a CZ# file from a path
-pub fn open<P: ?Sized + AsRef<Path>>(path: &P) -> Result<DynamicCz, CzError> {
+pub fn open<P: ?Sized + AsRef<Path>>(path: &P) -> Result<CzFile, CzError> {
     let mut img_file = BufReader::new(std::fs::File::open(path)?);
 
-    DynamicCz::decode(&mut img_file)
+    CzFile::decode(&mut img_file)
 }
 
 #[doc(inline)]
-pub use dynamic::DynamicCz;
+pub use dynamic::CzFile;
 
 /*
 #[doc(inline)]

cz/tests/round_trip.rs

@@ -0,0 +1,86 @@
+use std::io::Cursor;
+
+use cz::{common::CzVersion, CzFile};
+
+const KODIM03: (u16, u16, &[u8]) = (128, 128, include_bytes!("test_images/kodim03.rgba"));
+const KODIM23: (u16, u16, &[u8]) = (225, 225, include_bytes!("test_images/kodim23.rgba"));
+const SQPTEXT: (u16, u16, &[u8]) = (2048, 810, include_bytes!("test_images/sqp_text.rgba"));
+const DPFLOGO: (u16, u16, &[u8]) = (1123, 639, include_bytes!("test_images/dpf_logo.rgba"));
+
+type TestImage = (u16, u16, &'static [u8]);
+const TEST_IMAGES: &[TestImage] = &[KODIM03, KODIM23, SQPTEXT, DPFLOGO];
+
+#[test]
+fn cz0_round_trip() {
+    for image in TEST_IMAGES {
+        let original_cz = CzFile::from_raw(CzVersion::CZ0, image.0, image.1, image.2.to_vec());
+
+        let mut cz_bytes = Vec::new();
+        original_cz.encode(&mut cz_bytes).unwrap();
+
+        let mut cz_bytes = Cursor::new(cz_bytes);
+        let decoded_cz = CzFile::decode(&mut cz_bytes).unwrap();
+
+        assert_eq!(original_cz.as_raw(), decoded_cz.as_raw());
+    }
+}
+
+#[test]
+fn cz1_round_trip() {
+    for image in TEST_IMAGES {
+        let original_cz = CzFile::from_raw(CzVersion::CZ1, image.0, image.1, image.2.to_vec());
+
+        let mut cz_bytes = Vec::new();
+        original_cz.encode(&mut cz_bytes).unwrap();
+
+        let mut cz_bytes = Cursor::new(cz_bytes);
+        let decoded_cz = CzFile::decode(&mut cz_bytes).unwrap();
+
+        assert_eq!(original_cz.as_raw(), decoded_cz.as_raw());
+    }
+}
+
+#[test]
+fn cz2_round_trip() {
+    for image in TEST_IMAGES {
+        let original_cz = CzFile::from_raw(CzVersion::CZ2, image.0, image.1, image.2.to_vec());
+
+        let mut cz_bytes = Vec::new();
+        original_cz.encode(&mut cz_bytes).unwrap();
+
+        let mut cz_bytes = Cursor::new(cz_bytes);
+        let decoded_cz = CzFile::decode(&mut cz_bytes).unwrap();
+
+        assert_eq!(original_cz.as_raw(), decoded_cz.as_raw());
+    }
+}
+
+#[test]
+fn cz3_round_trip() {
+    for image in TEST_IMAGES {
+        let original_cz = CzFile::from_raw(CzVersion::CZ3, image.0, image.1, image.2.to_vec());
+
+        let mut cz_bytes = Vec::new();
+        original_cz.encode(&mut cz_bytes).unwrap();
+
+        let mut cz_bytes = Cursor::new(cz_bytes);
+        let decoded_cz = CzFile::decode(&mut cz_bytes).unwrap();
+
+        assert_eq!(original_cz.as_raw(), decoded_cz.as_raw());
+    }
+}
+
+#[test]
+fn cz4_round_trip() {
+    for image in TEST_IMAGES {
+        let original_cz = CzFile::from_raw(CzVersion::CZ4, image.0, image.1, image.2.to_vec());
+
+        let mut cz_bytes = Vec::new();
+        original_cz.encode(&mut cz_bytes).unwrap();
+
+        let mut cz_bytes = Cursor::new(cz_bytes);
+        let decoded_cz = CzFile::decode(&mut cz_bytes).unwrap();
+
+        assert_eq!(original_cz.as_raw(), decoded_cz.as_raw());
+    }
+}

documents/DOCUMENTS.md

@@ -0,0 +1,2 @@
+# Typst Documents
+To compile typst documents (with the `.typ` extension), use the [Typst compiler](https://github.com/typst/typst).

documents/cz_format_spec.typ

@@ -0,0 +1,238 @@
+#let ver = version(0, 4, 0)
+#set document(
+    title: "The CZx Image Formats - " + str(ver),
+    author: "G2",
+)
+#set text(
+    font: "Roboto",
+    lang: "en",
+    size: 9pt,
+)
+#set page(
+    numbering: "1",
+    margin: 1.5cm,
+    paper: "a4",
+)
+#set par(leading: 0.7em)
+#set block(spacing: 1.7em)
+
+// Styling
+#show link: underline
+#show link: set text(blue)
+
+#text(size: 22pt, weight: "bold", font: "Roboto Slab")[The CZx Image Formats]
+#v(1.5em, weak: true)
+#text(size: 1.1em)[Specification #strong[Version #ver] — Sept. 11, 2024]
+
+#line(length: 100%, stroke: 1.5pt + gray)
+
+The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
+"SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this document are to be
+interpreted as described in IETF
+#link("https://datatracker.ietf.org/doc/html/rfc2119")[RFC2119].
+
+The CZx family of image formats (CZ0, CZ1, CZ2, CZ3, CZ4, and CZ5) are used in
+the LUCA System visual novel engine developed by
+#link("https://www.prot.co.jp/")[Prototype Ltd]\. These image formats can be
+used for storing lossless compressed and uncompressed pixel data over a wide
+range of bit depths and with accompanying metadata useful for a visual novel.
+All bytes in CZx files MUST be stored in little-endian format.
+
+#show heading: set text(1.2em)
+#show heading.where(level: 1): head => [
+    #set text(18pt, font: "Roboto Slab", weight: "bold")
+    #head
+    #v(0.3em)
+]
+#show heading.where(level: 2): set text(weight: 600)
+#show raw: it => [
+    #box(stroke: 1pt, width: 100%, inset: 5pt, radius: 3pt)[
+        #it
+    ]
+]
+
+= Header
+
+#columns(2)[
+
+== Block 1 — Basic Header
+All CZx files MUST begin with this header block. The header contains information
+about basic parameters of the image, such as the bitmap dimensions. The common
+part of the header is as follows:
+
+```rust
+CommonHeader {
+    magic: [char; 4],  // magic bytes, ex. “CZ0\0”
+    header_length: u8, // header length in bytes
+
+    width: u16,        // image width in pixels
+    height: u16,       // image height in pixels
+    bit_depth: u16,    // bit depth (BPP)
+    unknown: u8,       // unknown purpose, often 3
+}
+```
+
+This common header MAY be followed by an extended header, which contains
+metadata such as cropping parameters and positioning on the screen. This part of
+the header exists if the header_length value is greater than 15 bytes, with the
+exception of the CZ2 format. An example of the extended header is as follows:
+
+```rust
+ExtendedHeader {
+    unknown: [u8; 5],   // Set to 0
+
+    crop_width: u16,    // width of image crop
+    crop_height: u16,   // height of image crop
+
+    bounds_width: u16,  // width of crop bounds
+    bounds_height: u16, // height of crop bounds
+}
+```
+
+The extended header MAY be followed by image offset information, used for
+positioning the image. This information only exists if the header_length value
+is greater than 28 bytes. An example of the offset header is as follows:
+
+```rust
+OffsetHeader {
+    offset_width: u16,
+    offset_height: u16,
+
+    unknown: [u8; 4],
+}
+```
+
+== Block 2 — Indexed Color Information
+If the depth of the image is 8 bits per pixel, the header MUST be followed by a
+palette block containing the information required to properly decode an image
+which is encoded in indexed color.
+
+The palette is an ordered list of colors. The color in the first position MUST
+correspond to an index value of 0 in the image, the second corresponding to a
+value of 1, and so on. These colors are stored in 8 bit RGBA format.
+
+The length of the palette corresponds to the bit depth of the image. Therefore,
+the color list MUST be 256 colors long.
+
+```rust
+Color {
+    red: u8,
+    green: u8,
+    blue: u8,
+    alpha: u8,
+}
+
+ColorPalette {
+    colors: [Color; 256]
+}
+```
+
+== Block 3 — Compression Information <compression-info>
+All CZx formats except for CZ0 MUST have a block immediately following the color
+information which contains information about the size of chunks in the following
+compressed image data. The compression block starts with the number of
+compressed blocks, followed by a list of the sizes of the compressed data and
+original data.
+
+```rust
+ChunkInfo {
+	compressed_size: u32, // compressed size, bytes
+	original_size: u32,	 // original size, bytes
+}
+
+CompressionInfo {
+	chunk_number: u32,	 // the number of chunks
+	chunks: ChunkInfo,
+}
+```
+]
+
+#pagebreak()
+
+= File Types
+
+#columns(2)[
+
+== CZ0
+CZ0 files are uncompressed, storing raw RGBA pixel data in a linear bitmap.
+
+This format is most often used to store character sprites, UI elements, and
+various other game assets. Use of CZ0 has decreased in more recent LUCA System
+games.
+
+The encoding used in these files is a simple bitmap of RGBA pixels. Decoding CZ0
+is as simple as reading the header to determine the width and height of the
+image in pixels, and then reading the image data as 4 byte RGBA chunks, which
+correspond directly to pixels.
+
+== CZ1
+CZ1 files are compressed, storing raw RGBA pixel data using LZW compression.
+
+This format is used to store text bitmaps in older LUCA System games, along with
+UI elements and other small image assets in more recent games. It is most often
+encountered with 8 bit indexed color, but 32 bit RGBA is also relatively common.
+
+== CZ2
+CZ2 files are compressed, storing raw RGBA pixel data using LZW compression.
+This method of compression is different from CZ1.
+
+This format is primarily used for storing text bitmaps in newer LUCA System
+games. Its use outside of text bitmaps is limited.
+
+#colbreak()
+
+== CZ3
+CZ3 files are compressed, storing modified RGBA pixel data using LZW
+compression. This compression scheme is the same as CZ1.
+
+This format is primarily used for storing backgrounds, but is also used for
+sprites, character graphics, and general files. It appears to be the most
+general form of more highly compressed CZx files. The compression ratios
+achieved by CZ3 are similar to or slightly worse than a
+PNG file with a compression level of 5.
+
+== CZ4
+CZ4 files are compressed, storing modified RGBA pixel data using LZW
+compression. This compression scheme is the same as CZ1.
+
+This format only appears in newer LUCA System games, and is primarily used for
+storing sprites, character graphics, and backgrounds. It seems to have replaced
+the use of CZ3 files and CZ0 files in many places in the engine, but not
+entirely. The compression ratios achieved by CZ4 are similar to or slightly
+better than a PNG file with a compression level of 9.
+
+== CZ5
+Little is known about the CZ5 format, as it has not been encountered in any
+released games so far. The only information about it has come from decompiling
+recent games which use the LUCA System engine, where it is referenced as part of
+the decoder for CZx files.
+
+]
+
+#v(2em)
+#line(length: 100%, stroke: 1.5pt + gray)
+
+= Compression Methods
+The two types of compression used in CZx files are Type 1 (used in CZ1, CZ3, and
+CZ4 files) and Type 2 (used in CZ2 files). On top of these two types, CZ3 and
+CZ4 have extra modifications to the image data to make it possible to compress
+them further. Both of these methods are dictionary based compression algorithms.
+
+== Type 1 (CZ1-style)
+Type 1 compression is a dictionary based compression algorithm that has a
+fixed-length block size. The data MUST be read and written in blocks which are
+sized according to the compressed_size value in the compression information
+section of the header. When creating compressed data, the block size (which
+determines the compressed_size value) SHOULD be set to 0xFEFD, however, it MAY
+be set to a smaller value, and MUST NOT be set to a larger value, as this will
+break compatibility with existing decoders.
+
+To decode Type 1 compression,
+
+== Type 2 (CZ2-style)
+Type 2 compression is a dictionary based compression algorithm that has a
+variable-length block size. The data MUST be read in blocks which are sized
+according to the compressed_size value in the
+#link(<compression-info>)[compression information] section of the header. When
+creating compressed data, the block size is dynamic based on the number of
+entries that can fit in the 18-bit dictionary.

luca_pak/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "luca_pak"
 edition = "2021"
-version = "0.1.2"
+version = "0.1.3"
 description = """
 An encoder/decoder for PAK archive files used in the LUCA System engine by
 Prototype Ltd.
@@ -10,9 +10,9 @@ license = "MIT"
 authors.workspace = true
 
 [dependencies]
-byteorder = "1.5.0"
-log = "0.4.22"
-thiserror = "1.0.61"
+byteorder-lite = "0.1"
+log = "0.4"
+thiserror = "2.0"
 
 [lints]
 workspace = true

luca_pak/src/entry.rs

@@ -1,5 +1,8 @@
 use std::{
-    error::Error, fs::File, io::{BufWriter, Write}, path::Path
+    error::Error,
+    fs::File,
+    io::{BufWriter, Write},
+    path::Path,
 };
 
 /// A single file entry in a PAK file
@@ -55,15 +58,30 @@ impl Entry {
         self.length as usize
     }
 
+    pub fn is_empty(&self) -> bool {
+        self.len() == 0
+    }
+
     /// Get the raw byte data of an [`Entry`]
     pub fn as_bytes(&self) -> &Vec<u8> {
         &self.data
     }
 
+    /// Get the byte data of an entry, but fixed to be compatible with normal things
+    pub fn cloned_bytes_fixed(&self) -> Vec<u8> {
+        match self.file_type() {
+            EntryType::OGGPAK => {
+                dbg!(self.data[15]);
+                self.data[15..].to_vec()
+            },
+            _ => self.data.clone()
+        }
+    }
+
     pub fn display_name(&self) -> String {
         let mut name = self.name().clone().unwrap_or(self.id().to_string());
         let entry_type = self.file_type();
-        name.push_str(&entry_type.extension());
+        name.push_str(entry_type.extension());
 
         name
     }
@@ -81,15 +99,21 @@ impl Entry {
             }
         } else if self.data[0..3] == [b'M', b'V', b'T'] {
             EntryType::MVT
+        } else if self.data[0..4] == [b'R', b'I', b'F', b'F'] {
+            EntryType::WAV
+        } else if self.data[0..4] == [b'O', b'g', b'g', b'S'] {
+            EntryType::OGG
+        } else if self.data[0..6] == [b'O', b'G', b'G', b'P', b'A', b'K'] {
+            EntryType::OGGPAK
         } else {
             EntryType::Unknown
         }
     }
 }
 
-
 #[derive(Debug, Clone, Copy, PartialEq, Eq)]
 pub enum EntryType {
+    // CZ image files
     CZ0,
     CZ1,
     CZ2,
@@ -100,6 +124,14 @@ pub enum EntryType {
     /// An MVT video file
     MVT,
 
+    /// OGG Audio file
+    OGG,
+    /// OGGPAK Audio file
+    OGGPAK,
+
+    /// Wav Audio file
+    WAV,
+
     /// Who knows!
     Unknown,
 }
@@ -115,6 +147,9 @@ impl EntryType {
             Self::CZ4 => ".cz4",
             Self::CZ5 => ".cz5",
             Self::MVT => ".mvt",
+            Self::OGG => ".ogg",
+            Self::OGGPAK => ".oggpak",
+            Self::WAV => ".wav",
             Self::Unknown => "",
         }
     }

luca_pak/src/header.rs

@@ -1,5 +1,5 @@
+use byteorder_lite::WriteBytesExt;
 use std::io::{self, Write};
-use byteorder::WriteBytesExt;
 
 use crate::LE;
 

luca_pak/src/lib.rs

@@ -1,16 +1,16 @@
 pub mod entry;
 pub mod header;
 
-use byteorder::{LittleEndian, ReadBytesExt};
+use byteorder_lite::{ReadBytesExt, WriteBytesExt, LE};
 use header::Header;
 use log::{debug, info};
 use std::{
-    ffi::CString, fs::File, io::{self, BufRead, BufReader, BufWriter, Read, Seek, SeekFrom, Write}, path::{Path, PathBuf}
+    ffi::CString,
+    fs::File,
+    io::{self, BufRead, BufReader, BufWriter, Read, Seek, SeekFrom, Write},
+    path::{Path, PathBuf},
 };
 use thiserror::Error;
-use byteorder::WriteBytesExt;
-
-type LE = LittleEndian;
 
 use crate::{entry::Entry, header::PakFlags};
 
@@ -20,8 +20,11 @@ pub enum PakError {
     #[error("Could not read/write file")]
     IoError(#[from] io::Error),
 
-    #[error("Expected {} files, got {} in {}", 0, 1, 2)]
-    FileCountMismatch(usize, usize, &'static str),
+    #[error("Expected {0} files, got {1} in {2}")]
+    EntryCountMismatch(usize, usize, &'static str),
+
+    #[error("Number of entries in header ({0}) exceeds limit of {1}")]
+    EntryLimit(u32, usize),
 
     #[error("Malformed header information")]
     HeaderError,
@@ -35,9 +38,11 @@ pub enum PakError {
 pub struct Pak {
     subdirectory: Option<String>,
 
-    /// The path of the PAK file, can serve as an identifier or name as the
+    /// The path to the PAK file, can serve as an identifier or name as the
     /// header has no name for the file.
     path: PathBuf,
+
+    /// Header information
     header: Header,
 
     unknown_pre_data: Vec<u32>,
@@ -46,23 +51,38 @@ pub struct Pak {
     entries: Vec<Entry>,
 }
 
-struct FileLocation {
+struct EntryLocation {
     offset: u32,
     length: u32,
 }
 
+pub struct PakLimits {
+    pub entry_limit: usize,
+    pub size_limit: usize,
+}
+
+impl Default for PakLimits {
+    fn default() -> Self {
+        Self {
+            entry_limit: 100_000,          // 100,000 entries
+            size_limit: u32::MAX as usize, // 10 gb
+        }
+    }
+}
+
 impl Pak {
     /// Convenience method to open a PAK file from a path and decode it
     pub fn open<P: ?Sized + AsRef<Path>>(path: &P) -> Result<Self, PakError> {
         let mut file = File::open(path)?;
 
-        Pak::decode(&mut file, path.as_ref().to_path_buf())
+        Pak::decode(&mut file, path.as_ref().to_path_buf(), PakLimits::default())
     }
 
     /// Decode a PAK file from a byte stream.
     pub fn decode<T: Seek + Read>(
         input: &mut T,
         path: PathBuf,
+        limits: PakLimits,
     ) -> Result<Self, PakError> {
         info!("Reading pak from {:?}", path);
         let mut input = BufReader::new(input);
@@ -80,6 +100,10 @@ impl Pak {
             unknown4: input.read_u32::<LE>()?,
             flags: PakFlags(input.read_u32::<LE>()?),
         };
+
+        if header.entry_count >= limits.entry_limit as u32 {
+            return Err(PakError::EntryLimit(header.entry_count, limits.entry_limit));
+        }
         info!("{} entries detected", header.entry_count);
         debug!("Block size is {} bytes", header.block_size);
         debug!("Flag bits {:#032b}", header.flags().0);
@@ -87,6 +111,7 @@ impl Pak {
         let first_offset = header.data_offset() / header.block_size();
 
         // Read some unknown data before the data we want
+        // TODO: This *must* be done differently for real, figure it out!
         let mut unknown_pre_data = Vec::new();
         while input.stream_position()? < header.data_offset() as u64 {
             let unknown = input.read_u32::<LE>()?;
@@ -111,10 +136,7 @@ impl Pak {
         for _ in 0..header.entry_count() {
             let offset = input.read_u32::<LE>().unwrap();
             let length = input.read_u32::<LE>().unwrap();
-            offsets.push(FileLocation {
-                offset,
-                length,
-            });
+            offsets.push(EntryLocation { offset, length });
         }
 
         // Read all unknown_data1
@@ -152,7 +174,11 @@ impl Pak {
         // Read all entry data
         debug!("Creating entry list");
         let mut entries: Vec<Entry> = Vec::new();
-        for (i, offset_info) in offsets.iter().enumerate().take(header.entry_count() as usize) {
+        for (i, offset_info) in offsets
+            .iter()
+            .enumerate()
+            .take(header.entry_count() as usize)
+        {
             debug!("Seeking to block {}", offset_info.offset);
             // Seek to and read the entry data
             input
@@ -209,18 +235,16 @@ impl Pak {
     }
 
     /// Encode a PAK file into a byte stream.
-    pub fn encode<T: Write>(
-        &self,
-        mut output: &mut T
-    ) -> Result<(), PakError> {
+    pub fn encode<T: Write>(&self, mut output: &mut T) -> Result<(), PakError> {
         self.header.write_into(&mut output)?;
 
         // Write unknown data
         output.write_all(
-            &self.unknown_pre_data
+            &self
+                .unknown_pre_data
                 .iter()
                 .flat_map(|dw| dw.to_le_bytes())
-                .collect::<Vec<u8>>()
+                .collect::<Vec<u8>>(),
         )?;
 
         // Write offsets and lengths
@@ -239,15 +263,11 @@ impl Pak {
         // Write names if the flags indicate it should have them
         if self.header.flags().has_names() {
             if let Some(subdir) = &self.subdirectory {
-                output.write_all(
-                    CString::new(subdir.as_bytes()).unwrap().to_bytes_with_nul()
-                )?;
+                output.write_all(CString::new(subdir.as_bytes()).unwrap().to_bytes_with_nul())?;
             }
             for entry in self.entries() {
                 let name = entry.name.as_ref().unwrap();
-                output.write_all(
-                    CString::new(name.as_bytes()).unwrap().to_bytes_with_nul()
-                )?;
+                output.write_all(CString::new(name.as_bytes()).unwrap().to_bytes_with_nul())?;
             }
         }
 
@@ -257,8 +277,12 @@ impl Pak {
 
         for entry in self.entries() {
             //let block_size = entry.data.len().div_ceil(self.header().block_size as usize);
-            let mut remainder = 2048 - entry.data.len().rem_euclid(self.header().block_size as usize);
-            if remainder == 2048 {
+            let mut remainder = self.header().block_size as usize
+                - entry
+                    .data
+                    .len()
+                    .rem_euclid(self.header().block_size as usize);
+            if remainder == self.header().block_size as usize {
                 remainder = 0;
             }
             output.write_all(&entry.data)?;
@@ -278,11 +302,7 @@ impl Pak {
     ///
     /// This function updates the offsets of all entries to fit within the
     /// chunk size specified in the header.
-    pub fn replace(
-        &mut self,
-        index: usize,
-        replacement_bytes: &[u8],
-    ) -> Result<(), PakError> {
+    pub fn replace(&mut self, index: usize, replacement_bytes: &[u8]) -> Result<(), PakError> {
         let block_size = self.header().block_size();
 
         let replaced_entry;
@@ -290,7 +310,7 @@ impl Pak {
             replaced_entry = entry
         } else {
             log::error!("Entry {} not found!", index);
-            return Err(PakError::IndexError)
+            return Err(PakError::IndexError);
         };
 
         if let Some(name) = replaced_entry.name() {
@@ -304,8 +324,7 @@ impl Pak {
         replaced_entry.length = replaced_entry.data.len() as u32;
 
         // Get the offset of the next entry based on the current one
-        let mut next_offset =
-            replaced_entry.offset + replaced_entry.length.div_ceil(block_size);
+        let mut next_offset = replaced_entry.offset + replaced_entry.length.div_ceil(block_size);
 
         // Update the position of all subsequent entries
         let mut i = 0;
@@ -333,7 +352,7 @@ impl Pak {
         let index = if let Some(entry) = entry {
             entry.index
         } else {
-            return Err(PakError::IndexError)
+            return Err(PakError::IndexError);
         };
 
         self.replace(index, replacement_bytes)?;
@@ -341,16 +360,12 @@ impl Pak {
         Ok(())
     }
 
-    pub fn replace_by_id(
-        &mut self,
-        id: u32,
-        replacement_bytes: &[u8],
-    ) -> Result<(), PakError> {
+    pub fn replace_by_id(&mut self, id: u32, replacement_bytes: &[u8]) -> Result<(), PakError> {
         let entry = self.get_entry_by_id(id);
         let index = if let Some(entry) = entry {
             entry.index
         } else {
-            return Err(PakError::IndexError)
+            return Err(PakError::IndexError);
         };
 
         self.replace(index, replacement_bytes)?;
@@ -369,16 +384,13 @@ impl Pak {
 
     /// Get an individual entry from the PAK by its ID
     pub fn get_entry_by_id(&mut self, id: u32) -> Option<&mut Entry> {
-        self.entries
-            .get_mut((id - self.header.id_start) as usize)
+        self.entries.get_mut((id - self.header.id_start) as usize)
     }
 
     pub fn get_entry_by_name(&mut self, name: &str) -> Option<&mut Entry> {
         self.entries
             .iter_mut()
-            .find(|e|
-                e.name.as_ref().is_some_and(|n| n == name)
-            )
+            .find(|e| e.name.as_ref().is_some_and(|n| n == name))
     }
 
     /// Get a list of all entries from the PAK
@@ -390,8 +402,7 @@ impl Pak {
     pub fn contains_name(&self, name: &str) -> bool {
         self.entries
             .iter()
-            .any(|e| e.name.as_ref()
-            .is_some_and(|n| n == name))
+            .any(|e| e.name.as_ref().is_some_and(|n| n == name))
     }
 }
 

luca_script/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "luca_script"
+version = "0.1.0"
+edition = "2021"
+authors.workspace = true
+
+[dependencies]
+byteorder-lite = "0.1.0"
+encoding_rs = "0.8.35"
+serde = { version = "1.0.215", features = ["derive"] }
+serde_json = "1.0.133"
+
+[lints]
+workspace = true

luca_script/src/LBEE_opcodes

@@ -0,0 +1,107 @@
+EQU
+EQUN
+EQUV
+ADD
+SUB
+MUL
+DIV
+MOD
+AND
+OR
+RANDOM
+VARSTR
+SET
+FLAGCLR
+GOTO
+ONGOTO
+GOSUB
+IFY
+IFN
+RETURN
+JUMP
+FARCALL
+FARRETURN
+JUMPPOINT
+END
+VARSTR_SET
+TALKNAME_SET
+ARFLAGSET
+COLORBG_SET
+SPLINE_SET
+SHAKELIST_SET
+MESSAGE
+MESSAGE_CLEAR
+SELECT
+CLOSE_WINDOW
+LOG
+LOG_PAUSE
+LOG_END
+VOICE
+WAIT_COUNT
+WAIT_TIME
+FFSTOP
+INIT
+STOP
+IMAGELOAD
+IMAGEUPADTE
+ARC
+MOVE
+MOVE2
+ROT
+PEND
+FADE
+SCALE
+SHAKE
+SHAKELIST
+BASE
+MCMOVE
+MCARC
+MCROT
+MCSHAKE
+MCFADE
+WAIT
+DRAW
+WIPE
+FRAMEON
+FRAMEOFF
+FW
+SCISSOR
+DELAY
+RASTER
+TONE
+SCALECOSSIN
+BMODE
+SIZE
+SPLINE
+DISP
+MASK
+SG_QUAKE
+BGM
+BGM_WAITSTART
+BGM_WAITFADE
+SE
+SE_STOP
+SE_WAIT
+VOLUME
+MOVIE
+SETCGFLAG
+EX
+TROPHY
+SETBGMFLAG
+TASK
+BTFUNC
+BATTLE
+KOEP
+BT_ACCESSORY_SELECT
+UNDO_CLEAR
+PTFUNC
+PT
+GMFUNC
+GM
+DEL_CALLSTACK
+FULLQUAKE_ZOOM
+LBFUNC
+LBBG
+HAIKEI_SET
+SAYAVOICETEXT
+UNKNOWN

luca_script/src/main.rs

@@ -0,0 +1,582 @@
+mod utils;
+
+use std::{fs, io::{Cursor, Read, Write}, sync::LazyLock};
+
+use byteorder_lite::{WriteBytesExt, ReadBytesExt, LE};
+use serde::{Deserialize, Serialize};
+use utils::Encoding;
+
+static OPCODES: LazyLock<Vec<String>> = LazyLock::new(|| fs::read_to_string("LBEE_opcodes")
+    .unwrap()
+    .split("\n")
+    .map(|s| s.to_owned())
+    .collect()
+);
+
+fn main() {
+    let mut script_file = fs::File::open("SEEN0513").unwrap();
+    let script_len = script_file.metadata().unwrap().len();
+    let script = decode_script(&mut script_file, script_len);
+
+    /*
+    for c in script.opcodes {
+        print!("{:>5}", c.position);
+        print!("{:>12}: ", c.string);
+        if let Some(o) = c.opcode_specifics {
+            print!("{}", serde_json::ser::to_string(&o).unwrap());
+        } else if let Some(r) = c.fixed_param {
+            print!("{:?}", r);
+        }
+        println!();
+    }
+    */
+
+    //println!("{}", serde_json::ser::to_string_pretty(&script).unwrap());
+
+    let mut rewrite_script = fs::File::create("SEEN0513-rewritten").unwrap();
+    write_script(&mut rewrite_script, script).unwrap();
+    println!("Wrote out successfully");
+}
+
+fn decode_script<S: Read>(script_stream: &mut S, length: u64) -> Script {
+    let mut opcodes = Vec::new();
+    let mut offset = 0;
+    let mut i = 0;
+    let mut pos = 0;
+    while offset < length as usize {
+        // Read all base info
+        let length = script_stream.read_u16::<LE>().unwrap() as usize;
+        let number = script_stream.read_u8().unwrap();
+        let flag = script_stream.read_u8().unwrap();
+        let string = OPCODES[number as usize].clone();
+
+        offset += 4;
+
+        let raw_len = length - 4;
+        let mut raw_bytes = vec![0u8; raw_len];
+        script_stream.read_exact(&mut raw_bytes).unwrap();
+        offset += raw_len;
+
+        // Read extra align byte if alignment needed
+        if length % 2 != 0 {
+            offset += 1;
+            Some(script_stream.read_u8().unwrap())
+        } else {
+            None
+        };
+
+        let mut fixed_param = Vec::new();
+        let param_bytes = match flag {
+            0 => raw_bytes.clone(),
+            f if f < 2 => {
+                fixed_param = vec![
+                    u16::from_le_bytes(raw_bytes[..2].try_into().unwrap()),
+                ];
+                raw_bytes[2..].to_vec()
+            }
+            _ => {
+                fixed_param = vec![
+                    u16::from_le_bytes(raw_bytes[..2].try_into().unwrap()),
+                    u16::from_le_bytes(raw_bytes[2..4].try_into().unwrap()),
+                ];
+                raw_bytes[4..].to_vec()
+            }
+        };
+
+        opcodes.push(Opcode {
+            index: i,
+            position: pos,
+            length,
+            opcode_number: number,
+            string: string.clone(),
+            flag,
+            fixed_param,
+            opcode_specifics: SpecificOpcode::decode(&string, &param_bytes),
+            param_bytes,
+        });
+
+        // Break if END opcode reached
+        if &string == "END" {
+            break;
+        }
+
+        pos += (length + 1) & !1;
+        i += 1;
+    }
+
+    Script {
+        code_count: opcodes.len(),
+        opcodes,
+    }
+}
+
+fn write_script<W: Write>(script_output: &mut W, script: Script) -> Result<(), ()> {
+    let mut position = 0;
+    for opcode in script.opcodes {
+        let mut total = 0;
+        script_output.write_u16::<LE>(opcode.length as u16).unwrap();
+        script_output.write_u8(OPCODES.iter().position(|l| *l == opcode.string).unwrap() as u8).unwrap();
+        script_output.write_u8(opcode.flag).unwrap();
+        total += 4;
+
+        for p in opcode.fixed_param {
+            script_output.write_u16::<LE>(p).unwrap();
+            total += 2;
+        }
+
+        script_output.write_all(&opcode.param_bytes).unwrap();
+        total += opcode.param_bytes.len();
+        if (position + total) % 2 != 0 {
+            script_output.write_u8(0).unwrap();
+            total += 1;
+        }
+        position += total;
+    }
+
+    Ok(())
+}
+
+#[derive(Debug, Clone)]
+#[derive(Serialize, Deserialize)]
+struct Script {
+    opcodes: Vec<Opcode>,
+    code_count: usize,
+}
+
+#[derive(Debug, Clone)]
+#[derive(Serialize, Deserialize)]
+struct Opcode {
+    index: usize,
+    position: usize,
+    length: usize,
+    opcode_number: u8,
+    string: String,
+
+    flag: u8,
+    fixed_param: Vec<u16>,
+    param_bytes: Vec<u8>,
+    opcode_specifics: Option<SpecificOpcode>,
+}
+
+#[derive(Debug, Clone, PartialEq, Eq)]
+#[derive(Serialize, Deserialize)]
+enum SpecificOpcode {
+    Message {
+        voice_id: u16,
+        messages: Vec<String>,
+        end: Vec<u8>,
+    },
+    Add {
+        var1: u16,
+        expr: String,
+    },
+    EquN {
+        var1: u16,
+        value: Option<u16>, //?
+    },
+    Select {
+        var_id: u16,
+        var0: u16,
+        var1: u16,
+        var2: u16,
+        messages: Vec<String>,
+        var3: u16,
+        var4: u16,
+        var5: u16,
+    },
+    _Battle,
+    Task {
+        task_type: u16,
+        var1: Option<u16>,
+        var2: Option<u16>,
+        var3: Option<u16>,
+        var4: Option<u16>,
+        message_1: Option<Vec<String>>,
+        message_2: Option<Vec<String>>,
+        raw_args: Option<Vec<u8>>,
+    },
+    SayAVoiceText {
+        voice_id: u16,
+        messages: Vec<String>,
+    },
+    VarStrSet {
+        varstr_id: u16,
+        varstr_str: String,
+    },
+    GoTo {
+        jump_pos: u32,
+    },
+    GoSub {
+        arg1: u16,
+        jump_pos: u32,
+        end: Vec<u8>,
+    },
+    Jump {
+        filename: String,
+        jump_pos: Option<u32>,
+    },
+    FarCall {
+        index: u16,
+        filename: String,
+        jump_pos: u32,
+        end: Vec<u8>,
+    },
+    IfN {
+        condition: String,
+        jump_pos: u32,
+    },
+    IfY {
+        condition: String,
+        jump_pos: u32,
+    },
+    Random {
+        var1: u16,
+        rnd_from: String,
+        rnd_to: String,
+    },
+    ImageLoad {
+        mode: u16,
+        image_id: u16,
+        var1: Option<u16>,
+        pos_x: Option<u16>,
+        pos_y: Option<u16>,
+        end: Vec<u8>,
+    },
+    Bgm {
+        bgm_id: u32,
+        arg2: Option<u16>,
+    },
+    Unknown(Vec<u8>),
+}
+
+impl SpecificOpcode {
+    pub fn decode(opcode_str: &str, param_bytes: &[u8]) -> Option<Self> {
+        if param_bytes.is_empty() {
+            return None
+        }
+
+        let mut cursor_param = Cursor::new(param_bytes);
+
+        Some(match opcode_str {
+            "MESSAGE" => Self::decode_message(&mut cursor_param),
+            "SAYAVOICETEXT" => Self::decode_sayavoicetext(&mut cursor_param),
+            "SELECT" => Self::decode_select(&mut cursor_param),
+            "TASK" => Self::decode_task(&mut cursor_param),
+
+            "ADD" => Self::decode_add(&mut cursor_param),
+            "EQUN" => Self::decode_equn(&mut cursor_param),
+
+            "RANDOM" => Self::decode_random(&mut cursor_param),
+            "IFY" => Self::decode_ifn_ify(&mut cursor_param, false),
+            "IFN" => Self::decode_ifn_ify(&mut cursor_param, true),
+            "JUMP" => Self::decode_jump(&mut cursor_param),
+            "GOTO" => Self::decode_goto(&mut cursor_param),
+            "GOSUB" => Self::decode_gosub(&mut cursor_param),
+            "FARCALL" => Self::decode_farcall(&mut cursor_param),
+            "VARSTR_SET" => Self::decode_varstr_set(&mut cursor_param),
+
+            "IMAGELOAD" => Self::decode_imageload(&mut cursor_param),
+            "BGM" => Self::decode_bgm(&mut cursor_param),
+            _ => Self::Unknown(param_bytes.to_vec())
+        })
+    }
+
+    fn decode_message<R: Read>(param_bytes: &mut R) -> Self {
+        let voice_id = param_bytes.read_u16::<LE>().unwrap();
+
+        // TODO: This will need to change per-game based on the number of
+        // languages and their encodings
+        let mut messages = Vec::new();
+        for _ in 0..2 {
+            let string = utils::decode_string_v1(param_bytes, Encoding::UTF16).unwrap();
+            messages.push(string);
+        }
+
+        let mut end = Vec::new();
+        param_bytes.read_to_end(&mut end).unwrap();
+
+        Self::Message {
+            voice_id,
+            messages,
+            end,
+        }
+    }
+
+    fn decode_add<R: Read>(param_bytes: &mut R) -> Self {
+        let var1 = param_bytes.read_u16::<LE>().unwrap();
+        let expr = utils::decode_string_v1(param_bytes, Encoding::ShiftJIS).unwrap();
+
+        Self::Add { var1, expr }
+    }
+
+    fn decode_equn<R: Read>(param_bytes: &mut R) -> Self {
+        let var1 = param_bytes.read_u16::<LE>().unwrap();
+        let value = param_bytes.read_u16::<LE>().ok();
+
+        Self::EquN { var1, value }
+    }
+
+    fn decode_select<R: Read>(param_bytes: &mut R) -> Self {
+        let var_id = param_bytes.read_u16::<LE>().unwrap();
+        let var0 = param_bytes.read_u16::<LE>().unwrap();
+        let var1 = param_bytes.read_u16::<LE>().unwrap();
+        let var2 = param_bytes.read_u16::<LE>().unwrap();
+
+        // TODO: This will need to change per-game based on the number of
+        // languages and their encodings
+        let mut messages = Vec::new();
+        for _ in 0..2 {
+            let string = utils::decode_string_v1(param_bytes, Encoding::UTF16).unwrap();
+            messages.push(string);
+        }
+
+        let var3 = param_bytes.read_u16::<LE>().unwrap();
+        let var4 = param_bytes.read_u16::<LE>().unwrap();
+        let var5 = param_bytes.read_u16::<LE>().unwrap();
+
+        Self::Select {
+            var_id,
+            var0,
+            var1,
+            var2,
+            messages,
+            var3,
+            var4,
+            var5
+        }
+    }
+
+    fn decode_random<R: Read>(param_bytes: &mut R) -> Self {
+        let var1 = param_bytes.read_u16::<LE>().unwrap();
+        let rnd_from = utils::decode_string_v1(param_bytes, Encoding::ShiftJIS).unwrap();
+        let rnd_to = utils::decode_string_v1(param_bytes, Encoding::ShiftJIS).unwrap();
+
+        Self::Random { var1, rnd_from, rnd_to }
+    }
+
+    fn decode_ifn_ify<R: Read>(param_bytes: &mut R, ifn: bool) -> Self {
+        let condition = utils::decode_string_v1(param_bytes, Encoding::ShiftJIS).unwrap();
+        let jump_pos = param_bytes.read_u32::<LE>().unwrap();
+
+        if ifn {
+            Self::IfN { condition, jump_pos }
+        } else {
+            Self::IfY { condition, jump_pos }
+        }
+    }
+
+    fn decode_jump<R: Read>(param_bytes: &mut R) -> Self {
+        let filename = utils::decode_string_v1(param_bytes, Encoding::ShiftJIS).unwrap();
+
+        let jump_pos = param_bytes.read_u32::<LE>().ok();
+
+        Self::Jump { filename, jump_pos }
+    }
+
+    fn decode_imageload<R: Read>(param_bytes: &mut R) -> Self {
+        let mode = param_bytes.read_u16::<LE>().unwrap();
+        let image_id = param_bytes.read_u16::<LE>().unwrap();
+
+        // These will only be read if there is anything to be read
+        let var1 = param_bytes.read_u16::<LE>().ok();
+        let pos_x = param_bytes.read_u16::<LE>().ok();
+        let pos_y = param_bytes.read_u16::<LE>().ok();
+
+        let mut end = Vec::new();
+        param_bytes.read_to_end(&mut end).unwrap();
+
+        Self::ImageLoad {
+            mode,
+            image_id,
+            var1,
+            pos_x,
+            pos_y,
+            end,
+        }
+    }
+
+    fn decode_goto<R: Read>(param_bytes: &mut R) -> Self {
+        let jump_pos = param_bytes.read_u32::<LE>().unwrap();
+
+        Self::GoTo { jump_pos }
+    }
+
+    fn decode_gosub<R: Read>(param_bytes: &mut R) -> Self {
+        let arg1 = param_bytes.read_u16::<LE>().unwrap();
+        let jump_pos = param_bytes.read_u32::<LE>().unwrap();
+
+        let mut end = Vec::new();
+        param_bytes.read_to_end(&mut end).unwrap();
+
+        Self::GoSub {
+            arg1,
+            jump_pos,
+            end,
+        }
+    }
+
+    fn decode_varstr_set<R: Read>(param_bytes: &mut R) -> Self {
+        let varstr_id = param_bytes.read_u16::<LE>().unwrap();
+        let varstr_str = utils::decode_string_v1(param_bytes, Encoding::ShiftJIS).unwrap();
+
+        Self::VarStrSet { varstr_id, varstr_str }
+    }
+
+    fn decode_farcall<R: Read>(param_bytes: &mut R) -> Self {
+        let index = param_bytes.read_u16::<LE>().unwrap();
+        let filename = utils::decode_string_v1(param_bytes, Encoding::ShiftJIS).unwrap();
+        let jump_pos = param_bytes.read_u32::<LE>().unwrap();
+
+        let mut end = Vec::new();
+        param_bytes.read_to_end(&mut end).unwrap();
+
+        Self::FarCall {
+            index,
+            filename,
+            jump_pos,
+            end,
+        }
+    }
+
+    fn decode_sayavoicetext<R: Read>(param_bytes: &mut R) -> Self {
+        let voice_id = param_bytes.read_u16::<LE>().unwrap();
+
+        // TODO: This will need to change per-game based on the number of
+        // languages and their encodings
+        let mut messages = Vec::new();
+        for _ in 0..2 {
+            let string = utils::decode_string_v1(param_bytes, Encoding::UTF16).unwrap();
+            messages.push(string);
+        }
+
+        Self::SayAVoiceText {
+            voice_id,
+            messages,
+        }
+    }
+
+    fn decode_bgm<R: Read>(param_bytes: &mut R) -> Self {
+        // TODO: invesigate the accuracy of this
+        let bgm_id = param_bytes.read_u32::<LE>().unwrap();
+
+        let arg2 = param_bytes.read_u16::<LE>().ok();
+
+        Self::Bgm {
+            bgm_id,
+            arg2,
+        }
+    }
+
+    fn decode_task<R: Read>(param_bytes: &mut R) -> Self {
+        let task_type = param_bytes.read_u16::<LE>().unwrap();
+
+        let mut var1 = None;
+        let mut var2 = None;
+        let mut var3 = None;
+        let mut var4 = None;
+        let mut message_1 = None;
+        let mut message_2 = None;
+        let raw_args: Option<Vec<u8>> = None;
+
+        if false {
+            return Self::Task { task_type, var1, var2, var3, var4, message_1, message_2, raw_args };
+        }
+
+        match task_type {
+            4 => {
+                let var1 = param_bytes.read_u16::<LE>().ok();
+
+                if false {
+                    return Self::Task { task_type, var1, var2, var3, var4, message_1, message_2, raw_args };
+                }
+
+                if [0, 4, 5].contains(&var1.unwrap()) {
+                    var2 = param_bytes.read_u16::<LE>().ok();
+
+                    let mut messages = Vec::new();
+                    for _ in 0..2 {
+                        let string = utils::decode_string_v1(param_bytes, Encoding::UTF16).unwrap();
+                        messages.push(string);
+                    }
+                    message_1 = Some(messages);
+                } else if var1.unwrap() == 1 {
+                    var2 = param_bytes.read_u16::<LE>().ok();
+                    var3 = param_bytes.read_u16::<LE>().ok();
+                    var4 = param_bytes.read_u16::<LE>().ok();
+
+                    // Get first set of messages
+                    let mut messages = Vec::new();
+                    for _ in 0..2 {
+                        let string = utils::decode_string_v1(param_bytes, Encoding::UTF16).unwrap();
+                        messages.push(string);
+                    }
+                    message_1 = Some(messages);
+
+                    // Get second set of messages
+                    let mut messages = Vec::new();
+                    for _ in 0..2 {
+                        let string = utils::decode_string_v1(param_bytes, Encoding::UTF16).unwrap();
+                        messages.push(string);
+                    }
+                    message_2 = Some(messages);
+                } else if var1.unwrap() == 6 {
+                    var2 = param_bytes.read_u16::<LE>().ok();
+                    var3 = param_bytes.read_u16::<LE>().ok();
+
+                    let mut messages = Vec::new();
+                    for _ in 0..2 {
+                        let string = utils::decode_string_v1(param_bytes, Encoding::UTF16).unwrap();
+                        messages.push(string);
+                    }
+                    message_1 = Some(messages);
+                } else {
+                    return Self::Task { task_type, var1, var2, var3, var4, message_1, message_2, raw_args };
+                }
+            }
+            54 => {
+                let string = utils::decode_string_v1(param_bytes, Encoding::UTF16).unwrap();
+                message_1 = Some(vec![string]);
+            }
+            69 => {
+                var1 = param_bytes.read_u16::<LE>().ok();
+
+                // Get first set of messages
+                let mut messages = Vec::new();
+                for _ in 0..2 {
+                    let string = utils::decode_string_v1(param_bytes, Encoding::UTF16).unwrap();
+                    messages.push(string);
+                }
+                message_1 = Some(messages);
+
+                // Get second set of messages
+                let mut messages = Vec::new();
+                for _ in 0..2 {
+                    let string = utils::decode_string_v1(param_bytes, Encoding::UTF16).unwrap();
+                    messages.push(string);
+                }
+                message_2 = Some(messages);
+            }
+            _ => return Self::Task {
+                task_type,
+                var1,
+                var2,
+                var3,
+                var4,
+                message_1,
+                message_2,
+                raw_args,
+            }
+        }
+
+        Self::Task {
+            task_type,
+            var1,
+            var2,
+            var3,
+            var4,
+            message_1,
+            message_2,
+            raw_args,
+        }
+    }
+}

luca_script/src/utils.rs

@@ -0,0 +1,70 @@
+use std::{error::Error, io::{Read, Write}};
+
+use encoding_rs::*;
+use byteorder_lite::{LE, ReadBytesExt};
+
+pub enum Encoding {
+    #[allow(dead_code)]
+    UTF8,
+    UTF16,
+    ShiftJIS,
+}
+
+#[allow(dead_code)]
+impl Encoding {
+    pub fn width(&self) -> usize {
+        match self {
+            Self::UTF8 | Self::ShiftJIS => 1,
+            Self::UTF16 => 2,
+        }
+    }
+}
+
+pub fn decode_string_v1<R: Read>(
+    input: &mut R,
+    format: Encoding,
+) -> Result<String, Box<dyn Error>> {
+
+    // Find the end of the string
+    let mut string_buf = Vec::new();
+    match format {
+        Encoding::UTF8 | Encoding::ShiftJIS => {
+            let mut string_byte = input.read_u8()?;
+            while string_byte != 0 {
+                string_buf.push(string_byte);
+                string_byte = input.read_u8()?;
+            }
+        },
+        Encoding::UTF16 => {
+            let mut string_u16 = input.read_u16::<LE>()?;
+            while string_u16 != 0 {
+                string_buf.write_all(&string_u16.to_le_bytes()).unwrap();
+                string_u16 = input.read_u16::<LE>()?;
+            }
+        },
+    }
+
+    // Get the actual string data using the proper decoder
+    let string = match format {
+        Encoding::UTF8 => String::from_utf8(string_buf)?,
+        Encoding::UTF16 => {
+            String::from_utf16(
+                &string_buf.chunks_exact(2)
+                    .map(|e| u16::from_le_bytes(e.try_into().unwrap()))
+                    .collect::<Vec<u16>>()
+            )?
+        }
+        Encoding::ShiftJIS => SHIFT_JIS.decode(&string_buf).0.to_string(),
+    };
+
+    Ok(string)
+}
+
+#[allow(dead_code)]
+pub fn encode_string_v1(string: String, format: Encoding) -> Vec<u8> {
+    match format {
+        Encoding::UTF8 => string.as_bytes().to_vec(),
+        Encoding::UTF16 => string.encode_utf16().flat_map(|b| b.to_le_bytes()).collect(),
+        Encoding::ShiftJIS => SHIFT_JIS.encode(&string).0.to_vec(),
+    }
+}

pak_explorer/Cargo.toml

@@ -1,20 +1,25 @@
 [package]
 name = "pak_explorer"
-edition = "2021"
-version = "0.1.1"
+edition = "2024"
+version = "0.1.3"
 description = """
 A simple GUI for exploring and making modifications to LUCA System PAK files.
 """
-license = "AGPL-3.0"
+license = "GPL-3.0-or-later"
 authors.workspace = true
 publish = false
 
 [dependencies]
-cz = { path = "../cz/", features = ["png"] }
-eframe = { version = "0.28.1", default-features = false, features = ["wayland", "x11", "accesskit", "default_fonts", "wgpu"] }
-egui_extras = "0.28.1"
+colog = "1.3"
+cz = { path = "../cz/" }
+eframe = { version = "0.29", default-features = false, features = ["wayland", "x11", "accesskit", "default_fonts", "wgpu"] }
+egui_extras = "0.29"
+image = { version = "0.25", default-features = false, features = ["png"] }
+kira = "0.10"
+log = "0.4"
 luca_pak = { path = "../luca_pak/" }
-rfd = "0.14.1"
+rfd = "0.15"
+symphonia = "0.5.4"
 
 [lints]
 workspace = true

pak_explorer/LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

pak_explorer/src/main.rs

@@ -1,24 +1,40 @@
 #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] // hide console window on Windows in release
 
-use std::fs;
-
-use eframe::egui::{self, ColorImage, Image, TextureFilter, TextureHandle, TextureOptions};
+use eframe::egui::{
+    self, ColorImage, Image, ProgressBar, TextureFilter, TextureHandle, TextureOptions, ThemePreference
+};
+use kira::{sound::static_sound::{StaticSoundData, StaticSoundHandle}, AudioManager, AudioManagerSettings, DefaultBackend, Tween};
+use log::error;
 use luca_pak::{entry::EntryType, Pak};
+use std::{fs, io::Cursor, time::Duration};
 
 fn main() -> eframe::Result {
+    colog::default_builder()
+        .filter(None, log::LevelFilter::Warn)
+        .init();
+
     let options = eframe::NativeOptions {
         viewport: egui::ViewportBuilder::default().with_inner_size([1024.0, 800.0]),
-        follow_system_theme: true,
         ..Default::default()
     };
+
+    let manager = AudioManager::<DefaultBackend>::new(AudioManagerSettings::default()).unwrap();
+
     eframe::run_native(
         "LUCA PAK Explorer",
         options,
-        Box::new(|cc| {
-            // This gives us image support:
-            egui_extras::install_image_loaders(&cc.egui_ctx);
-
-            Ok(Box::<PakExplorer>::default())
+        Box::new(|ctx| {
+            let ppp = ctx.egui_ctx.pixels_per_point() * 1.5;
+            ctx.egui_ctx.set_pixels_per_point(ppp);
+            Ok(Box::new(PakExplorer {
+                open_file: None,
+                selected_entry: None,
+                image_texture: None,
+                hex_string: None,
+                audio_player: manager,
+                audio_handle: None,
+                audio_duration: None,
+            }))
         }),
     )
 }
@@ -28,40 +44,45 @@ struct PakExplorer {
     selected_entry: Option<luca_pak::entry::Entry>,
     image_texture: Option<egui::TextureHandle>,
     hex_string: Option<Vec<String>>,
-}
-
-impl Default for PakExplorer {
-    fn default() -> Self {
-        Self {
-            open_file: None,
-            selected_entry: None,
-            image_texture: None,
-            hex_string: None,
-        }
-    }
+    audio_player: AudioManager,
+    audio_handle: Option<StaticSoundHandle>,
+    audio_duration: Option<Duration>,
 }
 
 impl eframe::App for PakExplorer {
     fn update(&mut self, ctx: &egui::Context, _frame: &mut eframe::Frame) {
         egui::CentralPanel::default().show(ctx, |ui| {
-            ctx.set_pixels_per_point(1.5);
             ui.heading("PAK File Explorer");
+            ctx.options_mut(|o| o.theme_preference = ThemePreference::System);
 
             ui.horizontal(|ui| {
-                if ui.button("Open file…").clicked() {
+                if ui.button("Open file").clicked() {
                     if let Some(path) = rfd::FileDialog::new().pick_file() {
-                        let pak = Pak::open(&path).unwrap();
-                        self.open_file = Some(pak);
+                        let pak = match Pak::open(&path) {
+                            Ok(pak) => Some(pak),
+                            Err(e) => {
+                                error!("Unable to read selected file as PAK: {}", e);
+                                None
+                            }
+                        };
+                        self.open_file = pak;
                         self.selected_entry = None;
                         self.image_texture = None;
                         self.hex_string = None;
+
+                        if let Some(a) = self.audio_handle.as_mut() {
+                            a.stop(Tween::default());
+                        }
+
+                        self.audio_handle = None;
+                        self.audio_duration = None;
                     }
                 }
                 if let Some(pak) = &self.open_file {
-                    if ui.button("Save PAK…").clicked() {
+                    if ui.button("Save PAK").clicked() {
                         if let Some(path) = rfd::FileDialog::new()
-                                .set_file_name(pak.path().file_name().unwrap().to_string_lossy())
-                                .save_file()
+                            .set_file_name(pak.path().file_name().unwrap().to_string_lossy())
+                            .save_file()
                         {
                             pak.save(&path).unwrap();
                         }
@@ -72,7 +93,10 @@ impl eframe::App for PakExplorer {
             ui.separator();
 
             if let Some(pak) = &self.open_file {
-                ui.label(format!("Opened {}", pak.path().file_name().unwrap().to_string_lossy()));
+                ui.label(format!(
+                    "Opened {}",
+                    pak.path().file_name().unwrap().to_string_lossy()
+                ));
                 ui.label(format!("Contains {} Entries", pak.entries().len()));
 
                 let selection = if let Some(entry) = &self.selected_entry {
@@ -81,31 +105,44 @@ impl eframe::App for PakExplorer {
                     "None".to_string()
                 };
 
-                egui::ComboBox::from_id_source("my-combobox")
-                    .selected_text(selection)
-                    .truncate()
-                    .show_ui(ui, |ui|
-                {
-                    ui.selectable_value(&mut self.selected_entry, None, "");
-                    for entry in pak.entries() {
-                        if ui.selectable_value(
-                            &mut self.selected_entry,
-                            Some(entry.clone()),
-                            entry.display_name(),
-                        ).clicked() {
-                            self.image_texture = None;
-                        };
+                ui.horizontal(|ui| {
+                    egui::ComboBox::from_id_salt("my-combobox")
+                        .selected_text(selection.clone())
+                        .truncate()
+                        .show_ui(ui, |ui| {
+                            ui.selectable_value(&mut self.selected_entry, None, "");
+                            for entry in pak.entries() {
+                                if ui
+                                    .selectable_value(
+                                        &mut self.selected_entry,
+                                        Some(entry.clone()),
+                                        format!("{} - {}", entry.display_name(), entry.id()),
+                                    )
+                                    .clicked()
+                                {
+                                    self.image_texture = None;
+
+                                    if let Some(a) = self.audio_handle.as_mut() {
+                                        a.stop(Tween::default());
+                                    }
+
+                                    self.audio_handle = None;
+                                    self.audio_duration = None;
+                                };
+                            }
+                        });
+
+                    if let Some(entry) = &self.selected_entry {
+                        ui.label(format!("Index {}, ID {}", entry.index(), entry.id()));
                     }
                 });
             } else {
-                ui.centered_and_justified(|ui|
-                    ui.label("No File Opened")
-                );
+                ui.centered_and_justified(|ui| ui.label("No File Opened"));
             }
 
             if let Some(entry) = &self.selected_entry {
                 ui.horizontal(|ui| {
-                    if ui.button("Save entry…").clicked() {
+                    if ui.button("Save entry").clicked() {
                         if let Some(path) = rfd::FileDialog::new()
                             .set_file_name(entry.display_name())
                             .save_file()
@@ -115,7 +152,7 @@ impl eframe::App for PakExplorer {
                     }
 
                     if let Some(pak) = &mut self.open_file.as_mut() {
-                        if ui.button("Replace entry…").clicked() {
+                        if ui.button("Replace entry").clicked() {
                             if let Some(path) = rfd::FileDialog::new().pick_file() {
                                 let file_bytes = fs::read(path).unwrap();
                                 pak.replace(entry.index(), &file_bytes).unwrap();
@@ -124,56 +161,110 @@ impl eframe::App for PakExplorer {
                     }
                 });
                 match entry.file_type() {
-                    EntryType::CZ0 | EntryType::CZ1
-                        | EntryType::CZ2 | EntryType::CZ3
-                        | EntryType::CZ4 | EntryType::CZ5 =>
-                    {
-                        if ui.button("Save as PNG…").clicked() {
+                    EntryType::CZ0
+                    | EntryType::CZ1
+                    | EntryType::CZ2
+                    | EntryType::CZ3
+                    | EntryType::CZ4
+                    | EntryType::CZ5 => {
+                        if ui.button("Save as PNG").clicked() {
                             let mut display_name = entry.display_name();
                             display_name.push_str(".png");
                             if let Some(path) = rfd::FileDialog::new()
                                 .set_file_name(display_name)
                                 .save_file()
                             {
-                                let cz = cz::DynamicCz::decode(&mut std::io::Cursor::new(entry.as_bytes())).unwrap();
-                                cz.save_as_png(&path).unwrap();
+                                let cz =
+                                    cz::CzFile::decode(&mut std::io::Cursor::new(entry.as_bytes()))
+                                        .unwrap();
+                                image::save_buffer_with_format(
+                                    path,
+                                    cz.as_raw(),
+                                    cz.header().width() as u32,
+                                    cz.header().height() as u32,
+                                    image::ColorType::Rgba8,
+                                    image::ImageFormat::Png,
+                                )
+                                .unwrap();
                             }
                         }
 
                         ui.separator();
 
                         let texture: &TextureHandle = self.image_texture.get_or_insert_with(|| {
-                            let cz = cz::DynamicCz::decode(&mut std::io::Cursor::new(entry.as_bytes())).unwrap();
+                            let cz =
+                                cz::CzFile::decode(&mut std::io::Cursor::new(entry.as_bytes()))
+                                    .unwrap();
                             let image = ColorImage::from_rgba_unmultiplied(
                                 [cz.header().width() as usize, cz.header().height() as usize],
-                                cz.as_raw()
+                                cz.as_raw(),
                             );
-                            ui.ctx().load_texture("eventframe", image, TextureOptions {
-                                magnification: TextureFilter::Nearest,
-                                minification: TextureFilter::Linear,
-                                ..Default::default()
-                            })
+                            ui.ctx().load_texture(
+                                "eventframe",
+                                image,
+                                TextureOptions {
+                                    magnification: TextureFilter::Nearest,
+                                    minification: TextureFilter::Linear,
+                                    ..Default::default()
+                                },
+                            )
                         });
 
-                        ui.centered_and_justified(|ui|
+                        ui.centered_and_justified(|ui| {
                             ui.add(
                                 Image::from_texture(texture)
                                     .show_loading_spinner(true)
                                     .shrink_to_fit()
-                                    .rounding(2.0)
+                                    .rounding(2.0),
                             )
-                        );
+                        });
+                    }
+                    EntryType::OGG
+                    | EntryType::OGGPAK
+                    | EntryType::WAV => {
+                        ui.separator();
+
+                        ui.horizontal(|ui| {
+                            if ui.button("▶").clicked() && self.audio_handle.is_none() {
+                                let sound_data = StaticSoundData::from_cursor(
+                                    Cursor::new(entry.cloned_bytes_fixed())
+                                )
+                                .unwrap()
+                                .volume(-8.0);
+
+                                self.audio_duration = Some(sound_data.duration());
+                                self.audio_handle = Some(self.audio_player.play(sound_data.clone()).unwrap());
+                            }
+
+                            if ui.button("⏹").clicked() && self.audio_handle.is_some() {
+                                self.audio_handle.as_mut().unwrap().stop(Tween::default());
+                                self.audio_handle = None;
+                                self.audio_duration = None;
+                            }
+
+                            if let Some(a) = &self.audio_handle {
+                                let pos = a.position() as f32;
+
+                                ui.add(ProgressBar::new(
+                                    pos / self.audio_duration.as_ref().unwrap().as_secs_f32()
+                                ).rounding(1.0).text(format!("{:02.0}:{:02.0}", pos / 60.0, pos % 60.0)));
+
+                                if pos / self.audio_duration.as_ref().unwrap().as_secs_f32() > 0.99 {
+                                    self.audio_handle.as_mut().unwrap().stop(Tween::default());
+                                    self.audio_handle = None;
+                                    self.audio_duration = None;
+                                }
+                            }
+
+                            ctx.request_repaint_after(Duration::from_millis(50));
+                        });
                     }
                     _ => {
-                        ui.centered_and_justified(|ui|
-                            ui.label("No Preview Available")
-                        );
-                    },
+                        ui.centered_and_justified(|ui| ui.label("No Preview Available"));
+                    }
                 }
             } else if self.open_file.is_some() {
-                ui.centered_and_justified(|ui|
-                    ui.label("Select an Entry")
-                );
+                ui.centered_and_justified(|ui| ui.label("Select an Entry"));
             }
         });
     }

utils/Cargo.toml

@@ -1,8 +1,10 @@
 [package]
-name = "utils"
-version = "0.1.0"
+name = "lbee-utils"
+version = "0.2.1"
 edition = "2021"
+license = "GPL-3.0-or-later"
 authors.workspace = true
+build = "build.rs"
 
 [[bin]]
 name = "czutil"
@@ -11,11 +13,14 @@ name = "czutil"
 name = "pakutil"
 
 [dependencies]
-cz = { path = "../cz/", features = ["png"] }
+cz = { path = "../cz/" }
 luca_pak = { path = "../luca_pak/" }
-
 image = { version = "0.25", default-features = false, features = ["png"] }
-clap = { version = "4.5.9", features = ["derive"] }
+clap = { version = "4.5", features = ["derive", "error-context"] }
+owo-colors = "4.1"
+
+[build-dependencies]
+vergen-gix = { version = "1.0", features = ["build", "cargo", "rustc", "si"] }
 
 [lints]
 workspace = true

utils/LICENSE

@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.

utils/build.rs

@@ -0,0 +1,23 @@
+use vergen_gix::{BuildBuilder, CargoBuilder, Emitter, GixBuilder, RustcBuilder, SysinfoBuilder};
+
+fn main() {
+    let build = BuildBuilder::all_build().unwrap();
+    let cargo = CargoBuilder::all_cargo().unwrap();
+    let gitcl = GixBuilder::all_git().unwrap();
+    let rustc = RustcBuilder::all_rustc().unwrap();
+    let si = SysinfoBuilder::all_sysinfo().unwrap();
+
+    Emitter::default()
+        .add_instructions(&build)
+        .unwrap()
+        .add_instructions(&cargo)
+        .unwrap()
+        .add_instructions(&gitcl)
+        .unwrap()
+        .add_instructions(&rustc)
+        .unwrap()
+        .add_instructions(&si)
+        .unwrap()
+        .emit()
+        .unwrap();
+}

utils/src/bin/czutil.rs

@@ -1,19 +1,32 @@
 use clap::{error::ErrorKind, Error, Parser, Subcommand};
-use std::{fs, path::{Path, PathBuf}};
+use cz::{common::CzVersion, CzFile};
+use image::ColorType;
+use lbee_utils::version;
+use owo_colors::OwoColorize;
+use std::{
+    fs,
+    path::{Path, PathBuf},
+    process::exit,
+};
 
 /// Utility to maniuplate CZ image files from the LUCA System game engine by
 /// Prototype Ltd.
 #[derive(Parser)]
 #[command(name = "CZ Utility")]
-#[command(version, about, long_about = None)]
+#[command(author, version, about, long_about = None, disable_version_flag = true)]
+#[command(arg_required_else_help(true))]
 struct Cli {
+    /// Show program version information
+    #[arg(short('V'), long)]
+    version: bool,
+
     #[command(subcommand)]
-    command: Commands,
+    command: Option<Commands>,
 }
 
 #[derive(Subcommand)]
 enum Commands {
-    /// Converts a CZ file to a PNG
+    /// Decode a CZ file to a PNG
     Decode {
         /// Decode a whole folder, and output to another folder
         #[arg(short, long)]
@@ -28,7 +41,26 @@ enum Commands {
         output: Option<PathBuf>,
     },
 
-    /// Replace a CZ file's image data
+    /// Encode a PNG file to a CZ
+    Encode {
+        /// Input image to encode
+        #[arg(value_name = "INPUT")]
+        input: PathBuf,
+
+        /// Output CZ file location
+        #[arg(value_name = "OUTPUT")]
+        output: PathBuf,
+
+        /// Output CZ file version
+        #[arg(short, long, value_name = "CZ VERSION")]
+        version: Option<u8>,
+
+        /// Output CZ file bit depth
+        #[arg(short, long, value_name = "CZ BIT DEPTH")]
+        depth: Option<u16>,
+    },
+
+    /// Replace an existing CZ file's image data
     Replace {
         /// Replace a whole folder, and output to another folder,
         /// using a folder of replacements
@@ -60,36 +92,37 @@ enum Commands {
 fn main() {
     let cli = Cli::parse();
 
+    if cli.version {
+        println!("{}", version(env!("CARGO_BIN_NAME")));
+        exit(0);
+    }
+
+    let command = match cli.command {
+        Some(c) => c,
+        None => exit(0),
+    };
+
     // Check what subcommand was run
-    match &cli.command {
+    match &command {
         Commands::Decode {
             input,
             output,
             batch,
         } => {
             if !input.exists() {
-                Error::raw(
-                    ErrorKind::ValueValidation,
-                    "The input file/folder provided does not exist\n",
-                )
-                .exit()
+                pretty_error("The input file/folder provided does not exist");
+                exit(1);
             }
 
             if *batch {
                 if input.is_file() {
-                    Error::raw(
-                        ErrorKind::ValueValidation,
-                        "Batch input must be a directory\n",
-                    )
-                    .exit()
+                    pretty_error("Batch input must be a directory");
+                    exit(1);
                 }
 
                 if output.is_none() || output.as_ref().unwrap().is_file() {
-                    Error::raw(
-                        ErrorKind::ValueValidation,
-                        "Batch output must be a directory\n",
-                    )
-                    .exit()
+                    pretty_error("Batch output must be a directory");
+                    exit(1);
                 }
 
                 for entry in fs::read_dir(input).unwrap() {
@@ -107,29 +140,48 @@ fn main() {
                     let cz = match cz::open(&path) {
                         Ok(cz) => cz,
                         Err(_) => {
-                            Error::raw(
-                                ErrorKind::ValueValidation,
-                                format!(
-                                    "Could not open input as a CZ file: {}\n",
-                                    path.into_os_string().to_str().unwrap()
-                                ),
-                            )
-                            .print()
-                            .unwrap();
+                            pretty_error(&format!(
+                                "Could not open input as a CZ file: {}\n",
+                                path.into_os_string().to_str().unwrap()
+                            ));
                             continue;
                         }
                     };
 
-                    cz.save_as_png(&final_path).unwrap();
+                    image::save_buffer_with_format(
+                        final_path,
+                        cz.as_raw(),
+                        cz.header().width() as u32,
+                        cz.header().height() as u32,
+                        ColorType::Rgba8,
+                        image::ImageFormat::Png,
+                    )
+                    .unwrap();
                 }
             } else {
                 let cz = cz::open(input).unwrap();
 
                 if let Some(output) = output {
-                    cz.save_as_png(output).unwrap();
+                    image::save_buffer_with_format(
+                        output,
+                        cz.as_raw(),
+                        cz.header().width() as u32,
+                        cz.header().height() as u32,
+                        ColorType::Rgba8,
+                        image::ImageFormat::Png,
+                    )
+                    .unwrap();
                 } else {
                     let file_stem = PathBuf::from(input.file_name().unwrap());
-                    cz.save_as_png(&file_stem.with_extension("png")).unwrap();
+                    image::save_buffer_with_format(
+                        file_stem.with_extension("png"),
+                        cz.as_raw(),
+                        cz.header().width() as u32,
+                        cz.header().height() as u32,
+                        ColorType::Rgba8,
+                        image::ImageFormat::Png,
+                    )
+                    .unwrap();
                 }
             }
         }
@@ -142,45 +194,30 @@ fn main() {
             depth,
         } => {
             if !input.exists() {
-                Error::raw(
-                    ErrorKind::ValueValidation,
-                    "The original file provided does not exist\n",
-                )
-                .exit()
+                pretty_error("The input file does not exist");
+                exit(1);
             }
 
             if !replacement.exists() {
-                Error::raw(
-                    ErrorKind::ValueValidation,
-                    "The replacement file provided does not exist\n",
-                )
-                .exit()
+                pretty_error("The replacement file does not exist");
+                exit(1);
             }
 
             // If it's a batch replacement, we want directories to search
             if *batch {
                 if !input.is_dir() {
-                    Error::raw(
-                        ErrorKind::ValueValidation,
-                        "Batch input location must be a directory\n",
-                    )
-                    .exit()
+                    pretty_error("Batch input must be a directory");
+                    exit(1);
                 }
 
                 if !replacement.is_dir() {
-                    Error::raw(
-                        ErrorKind::ValueValidation,
-                        "Batch replacement location must be a directory\n",
-                    )
-                    .exit()
+                    pretty_error("Batch replacement must be a directory");
+                    exit(1);
                 }
 
                 if !output.is_dir() {
-                    Error::raw(
-                        ErrorKind::ValueValidation,
-                        "Batch output location must be a directory\n",
-                    )
-                    .exit()
+                    pretty_error("Batch output location must be a directory");
+                    exit(1);
                 }
 
                 // Replace all the files within the directory and print errors for them
@@ -212,25 +249,89 @@ fn main() {
                 }
             } else {
                 if !input.is_file() {
-                    Error::raw(ErrorKind::ValueValidation, "Input must be a file\n").exit()
+                    pretty_error("Input must be a file");
+                    exit(1);
                 }
 
                 if !replacement.is_file() {
-                    Error::raw(ErrorKind::ValueValidation, "Replacement must be a file\n").exit()
-                }
-
-                if !output.is_file() {
-                    Error::raw(
-                        ErrorKind::ValueValidation,
-                        "Replacement output must be a file\n",
-                    )
-                    .exit()
+                    pretty_error("Replacement must be a file");
+                    exit(1);
                 }
 
                 // Replace the input file with the new image
                 replace_cz(&input, &output, &replacement, version, depth).unwrap();
             }
         }
+        Commands::Encode {
+            input,
+            output,
+            version,
+            depth,
+        } => {
+            if !input.exists() {
+                pretty_error("The original file provided does not exist");
+                exit(1);
+            }
+
+            let version = if let Some(v) = version {
+                match CzVersion::try_from(*v) {
+                    Ok(v) => v,
+                    Err(_) => {
+                        pretty_error(&format!(
+                            "Invalid CZ version {}; must be 0, 1, 2, 3, or 4",
+                            v
+                        ));
+                        exit(1);
+                    }
+                }
+            } else if output
+                .extension()
+                .is_some_and(|e| e.to_ascii_lowercase().to_string_lossy().starts_with("cz"))
+            {
+                let ext_string = output.extension().unwrap().to_string_lossy();
+                let last_char = ext_string.chars().last().unwrap();
+                match CzVersion::try_from(last_char) {
+                    Ok(v) => v,
+                    Err(e) => {
+                        pretty_error(&format!("Invalid CZ type: {}", e));
+                        exit(1);
+                    }
+                }
+            } else {
+                pretty_error("CZ version not specified or not parseable from file path");
+                exit(1);
+            };
+
+            let image = match image::open(input) {
+                Ok(i) => i,
+                Err(e) => {
+                    pretty_error(&format!("Could not open input file: {e}"));
+                    exit(1);
+                }
+            };
+
+            let image_depth = image.color();
+
+            let mut cz = CzFile::from_raw(
+                version,
+                image.width() as u16,
+                image.height() as u16,
+                image.to_rgba8().into_vec(),
+            );
+            if let Some(d) = *depth {
+                if !(d == 8 || d == 24 || d == 32) {
+                    pretty_error(&format!(
+                        "The color depth provided is not valid. Choose from: {}",
+                        "8, 24, or 32".bright_magenta()
+                    ));
+                    exit(1);
+                }
+                cz.header_mut().set_depth(d);
+            } else {
+                cz.header_mut().set_depth(image_depth.bits_per_pixel());
+            }
+            cz.save_as_cz(output).expect("Saving CZ file failed");
+        }
     }
 }
 
@@ -252,7 +353,7 @@ fn replace_cz<P: ?Sized + AsRef<Path>>(
     }
 
     // Open the replacement image and convert it to RGBA8
-    let repl_img = image::open(&replacement_path)?.to_rgba8();
+    let repl_img = image::open(replacement_path)?.to_rgba8();
 
     // Open the original CZ file
     let mut cz = cz::open(&path)?;
@@ -276,3 +377,7 @@ fn replace_cz<P: ?Sized + AsRef<Path>>(
 
     Ok(())
 }
+
+fn pretty_error(message: &str) {
+    eprintln!("{}: {}", "Error".red().italic(), message);
+}

utils/src/bin/pakutil.rs

@@ -1,18 +1,27 @@
-use std::{fs, path::PathBuf};
-use clap::{error::{Error, ErrorKind}, Parser, Subcommand};
+use clap::{
+    error::{Error, ErrorKind},
+    Parser, Subcommand,
+};
+use lbee_utils::version;
 use luca_pak::Pak;
+use std::{fs, path::PathBuf, process::exit};
 
 /// Utility to maniuplate PAK archive files from the LUCA System game engine by
 /// Prototype Ltd.
 #[derive(Parser)]
 #[command(name = "PAK Utility")]
-#[command(version, about, long_about = None)]
+#[command(author, version, about, long_about = None, disable_version_flag = true)]
+#[command(arg_required_else_help(true))]
 struct Cli {
-    #[arg(value_name = "PAK FILE")]
-    input: PathBuf,
+    /// Show program version information
+    #[arg(short('V'), long)]
+    version: bool,
+
+    #[arg(value_name = "PAK FILE", required_unless_present("version"))]
+    input: Option<PathBuf>,
 
     #[command(subcommand)]
-    command: Commands,
+    command: Option<Commands>,
 }
 
 #[derive(Subcommand)]
@@ -56,12 +65,24 @@ enum Commands {
 fn main() {
     let cli = Cli::parse();
 
-    let mut pak = match Pak::open(&cli.input) {
+    if cli.version {
+        println!("{}", version(env!("CARGO_BIN_NAME")));
+        exit(0);
+    }
+
+    let mut pak = match Pak::open(&cli.input.unwrap()) {
         Ok(pak) => pak,
-        Err(err) => fmt_error(&format!("Could not open PAK file: {}", err)).exit()
+        Err(err) => fmt_error(&format!("Could not open PAK file: {}", err)).exit(),
     };
 
-    match cli.command {
+    let command = match cli.command {
+        Some(c) => c,
+        None => {
+            exit(0);
+        }
+    };
+
+    match command {
         Commands::Extract { output } => {
             if output.exists() && !output.is_dir() {
                 fmt_error("The output given was not a directory").exit()
@@ -71,11 +92,21 @@ fn main() {
 
             for entry in pak.entries() {
                 let mut outpath = output.clone();
-                outpath.push(entry.display_name());
+                if let Some(n) = entry.name() {
+                    outpath.push(n);
+                } else {
+                    outpath.push(entry.index().to_string())
+                }
                 entry.save(&outpath).unwrap();
             }
-        },
-        Commands::Replace { batch, name, id, replacement, output } => {
+        }
+        Commands::Replace {
+            batch,
+            name,
+            id,
+            replacement,
+            output,
+        } => {
             if id.is_some() && name.is_some() {
                 fmt_error("Cannot use ID and name together").exit()
             }
@@ -90,12 +121,8 @@ fn main() {
 
                 for entry in fs::read_dir(replacement).unwrap() {
                     let entry = entry.unwrap();
-                    let search_name: String = entry
-                            .path()
-                            .file_name()
-                            .unwrap()
-                            .to_string_lossy()
-                            .into();
+                    let search_name: String =
+                        entry.path().file_name().unwrap().to_string_lossy().into();
 
                     let parsed_id: Option<u32> = search_name.parse().ok();
 
@@ -104,9 +131,15 @@ fn main() {
 
                     // Try replacing by name, if that fails, replace by parsed ID
                     if pak.replace_by_name(search_name, &rep_data).is_err() {
-                        fmt_error("Could not replace entry in PAK: Could not find name").print().unwrap()
-                    } else if parsed_id.is_some() && pak.replace_by_id(parsed_id.unwrap(), &rep_data).is_err() {
-                        fmt_error("Could not replace entry in PAK: ID is invalid").print().unwrap()
+                        fmt_error("Could not replace entry in PAK: Could not find name")
+                            .print()
+                            .unwrap()
+                    } else if parsed_id.is_some()
+                        && pak.replace_by_id(parsed_id.unwrap(), &rep_data).is_err()
+                    {
+                        fmt_error("Could not replace entry in PAK: ID is invalid")
+                            .print()
+                            .unwrap()
                     }
                 }
             } else {
@@ -117,11 +150,7 @@ fn main() {
                 let search_name = if let Some(name) = name {
                     name
                 } else {
-                    replacement
-                        .file_name()
-                        .unwrap()
-                        .to_string_lossy()
-                        .into()
+                    replacement.file_name().unwrap().to_string_lossy().into()
                 };
 
                 let search_id = if id.is_some() {
@@ -152,8 +181,5 @@ fn main() {
 
 #[inline(always)]
 fn fmt_error(message: &str) -> Error {
-    Error::raw(
-        ErrorKind::ValueValidation,
-        format!("{}\n", message),
-    )
+    Error::raw(ErrorKind::ValueValidation, format!("{}\n", message))
 }

utils/src/lib.rs

@@ -0,0 +1,12 @@
+use owo_colors::OwoColorize;
+
+pub fn version(bin_name: &str) -> String {
+    format!(
+        "{}, {} v{} ({}, {})",
+        bin_name,
+        env!("CARGO_PKG_NAME").cyan(),
+        env!("CARGO_PKG_VERSION").blue(),
+        (&env!("VERGEN_GIT_SHA")[0..=6]).green(),
+        env!("VERGEN_GIT_COMMIT_DATE").green(),
+    )
+}