#smash-bros #brawl #super #smash #lib #bros

brawllib_rs

Brawl character file parser, based on brawlbox/brawllib

38 releases (breaking)

Uses new Rust 2024

0.28.0 Mar 16, 2025
0.27.0 Dec 22, 2024
0.26.0 Jun 25, 2024
0.25.1 Dec 30, 2023
0.13.0 Mar 28, 2019

#167 in Game dev

Download history 3/week @ 2024-12-04 8/week @ 2024-12-11 91/week @ 2024-12-18 30/week @ 2024-12-25 4/week @ 2025-01-08 12/week @ 2025-02-05 4/week @ 2025-02-12 1/week @ 2025-02-19 14/week @ 2025-02-26 141/week @ 2025-03-12 16/week @ 2025-03-19

171 downloads per month

MIT license

550KB
12K SLoC

brawllib_rs

dependency status Crates.io Released API docs

A brawl file parser, based on brawlbox/brawllib, written in rust.

Doesn't support modifying files, only reading, processing and rendering them.

Example

In this example we:

  • Create a BrawlMod from a brawl mod sd card folder and a brawl dump folder.
  • Load Fighters from the brawl_mod. This is the raw data from the fighter folder, stored in a tree of structs.
  • Create a HighLevelFighter from an exported brawl fighter directory. This contains processed data from the Fighter struct, stored in a tree of structs.
use brawllib_rs::brawl_mod::BrawlMod;
use brawllib_rs::high_level_fighter::HighLevelFighter;
use std::path::PathBuf;

let brawl_path = PathBuf::from("path/to/a/brawl/dump/folder");
let mod_path = PathBuf::from("path/to/a/brawl/mod/sd/card/folder");
let brawl_mod = BrawlMod::new(&brawl_path, Some(&mod_path));

for fighter in brawl_mod.load_fighters(false).unwrap() {
    println!("Fighter name: {}", fighter.cased_name);
    println!("The name of the first model file name: {}", fighter.models[0].name);

    let hl_fighter = HighLevelFighter::new(&fighter);
    println!("Hurtboxes on the 4th frame of 'Run' action {:#?}", hl_fighter.subactions.iter().find(|x| x.name == "Run").unwrap().frames[4].hurt_boxes);
}

Dependencies

~26–61MB
~1M SLoC