#file-format #game-cube #universal #tool

app cubetool

Universal GameCube file format tool

13 unstable releases (3 breaking)

0.4.7 Jul 12, 2024
0.4.6 Jul 11, 2024
0.3.0 Jun 30, 2024
0.2.2 Jun 30, 2024
0.1.1 Jun 1, 2024

#687 in Parser implementations

MIT license

80KB
2K SLoC

cube

Crates.io Version

The universal GameCube file format tool.

Currently work in progress. This project is being developed in conjunction with P2GZ and will primarily support features needed for it at first, but aims to eventually support workflows for other games and hacks as well.

Installation

Cube can be used either as a Crate or as a CLI tool. Please use the help commands for usage instructions as the tool is not currently stable and available functionality and defaults will change without warning.

CLI

  1. Download and install Rust and Cargo (rustup is recommended)
  2. Run cargo install cubetool
  3. Use as cube extract file.szs etc.

Crate

cargo add cube_rs

Features / Roadmap

  • SZS (archives)
  • RARC (archives)
  • SARC (archives)
  • BTI (images)
    • Decoding
    • Encoding
  • Yaz0 (compression scheme, via yaz0)
  • BMG (text dictionaries)
  • BLO (menu screens)
  • BMS (music and sounds)
  • CND (Pikmin 2 specific(?) music config)
  • ISO (disc images, via gc-gcm)
    • Decoding
    • Encoding

Dependencies

~10–21MB
~286K SLoC