Crate aamp[][src]

Expand description

Nintendo parameter archive (AAMP) library in Rust

A simple to use library for reading, writing, and converting Nintendo parameter archive (AAMP) files in Rust. Supports only AAMP version 2, used in The Legend of Zelda: Breath of the Wild. Can convert from AAMP to readable, editable YAML and back.

use aamp::ParameterIO;
let mut file = std::fs::File::open("test/Enemy_Lizalfos_Electric.bchemical").unwrap();
// Read an AAMP ParameterIO from any reader that implements Seek + Read
let pio = ParameterIO::from_binary(&mut file).unwrap();
for list in pio.lists.iter() {
    // Do stuff with lists
}
for obj in pio.objects.iter() {
    // Do stuff with objects
}
// Dumps YAML representation to a String
let yaml_dump: String = pio.to_text().unwrap();

Modules

names
types

Structs

ParameterIO

Represents a single AAMP parameter IO document

ParameterList

Represents a single AAMP parameter list, containing a hash map of parameter objects and child parameter lists

ParameterObject

Represents a single AAMP parameter object, containing a map of parameters by hash

Enums

Parameter

Represents a single AAMP parameter