# 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.

```rust
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();
```

## License Notice

This software contains some edited code from [`yaml-rust`](https://crates.io/crates/yaml-rust),
primarily the addition of support for tags on maps and sequences. The original MIT/Apache license
and code are available on the [GitHub repo](https://github.com/chyh1990/yaml-rust).
