#super #lib #smash #bros #brawl

brawllib_rs

Brawl character file parser, based on brawlbox/brawllib

22 releases (14 breaking)

✓ Uses Rust 2018 edition

0.15.0 Apr 14, 2019
0.13.0 Mar 28, 2019

#45 in Game development

Download history 12/week @ 2019-01-06 41/week @ 2019-01-13 21/week @ 2019-01-20 15/week @ 2019-01-27 58/week @ 2019-02-03 26/week @ 2019-02-10 17/week @ 2019-02-17 50/week @ 2019-02-24 30/week @ 2019-03-03 43/week @ 2019-03-10 48/week @ 2019-03-17 138/week @ 2019-03-24 63/week @ 2019-03-31 13/week @ 2019-04-07

185 downloads per month

MIT license

459KB
9K SLoC

brawllib_rs Build Status dependency status Crates.io

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

Doesn't support modifying files, only reading them.

Example

In this example we:

  • Create a BrawlMod from the 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);
}

Documentation

Refer to docs.rs for the full API.

Dependencies

~9MB
~191K SLoC