aoe2-probe 0.2.5

A rust library for editing aoe2scenario files from AoE2 DE.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

[![CircleCI](https://img.shields.io/circleci/build/github/ptazithos/aoe2-probe/main)](https://dl.circleci.com/status-badge/redirect/gh/ptazithos/aoe2-probe/tree/main)
[![Crates.io](https://img.shields.io/crates/v/aoe2-probe.svg)](https://crates.io/crates/aoe2-probe)
[![GPL-3.0 licensed](https://img.shields.io/badge/license-GPLv3-brightgreen.svg)](./LICENSE)
## What is aoe2-probe?
This is a rust library for editing aoe2scenario files from AoE2 DE.

## WARNING
* aoe2-probe is currently in the very early stage. APIs may change dramatically in following updates. Please don't use this project in serious development.
* Due to the zlib implementation difference,  the exported file cannot be as same as the imported file, while the content of files is constant(Don't worry, AoE2 DE still understand it).Backing up the original is always recommended.

## Design Goals
* Full ability to access every byte in aoe2scenario files.
* Editing every bit with a reliable correctness check. todo!()
* Provides constant API compatibility across game versions. todo!()

## Getting Started
Under the directory **./examples/**, you can find several simple showcases.

**Import and export files:**
```rust
use aoe2_probe::scenario::Scenario;

//Reading scenario content from the .aoe2scenario file
let scenario = Scenario::from_file("./resources/chapter_1.aoe2scenario");
//saving content to a new .aoe2scenario file
scenario.to_file("./resources/temp.aoe2scenario");
```

**Update attributes:**
```rust
use aoe2_probe::scenario::Scenario;

//versio's structure definition can be found in the folder /src/prebuilt/ver1_46/versio.rs
let mut scenario = Scenario::from_file("./resources/chapter_1.aoe2scenario");

let author = scenario.versio.get_by_path_mut("/file_header/creator_name");
//Update the creator name.
author.try_mut_str32().set_content("Arian");
```

**customize a structure:**
```rust
//Define a socre record
let mut root = LinkedHashMap::new();
root.push_back("score", Token::Int16(100));
root.push_back("name", Token::Str32(DynString::with_capacity(12, "anonymous")));

//serialize
root.to_le_vec();

//deserialize
root.from_le_vec();
```

Run exampes with the following command:
```shell
cargo run --example read_write
```
Every member of **versio** and itself implements fmt::Debug trait. Print them if you want to know more.
```rust
let scenario = Scenario::from_file("./resources/chapter_1.aoe2scenario");
println!("{:?}", &scenario.versio())
```
## Supports
|Version|Support|
|----|----|
|ver.1.46|Support|

Currently, only version 1.46 and newer will be firstly supported.

## Libraries Used
* [miniz_oxide](https://github.com/Frommi/miniz_oxide): Pure rust Rust replacement for the miniz deflate/zlib encoder/decoder using no unsafe code.
* [log](https://github.com/rust-lang/log): A lightweight logging facade.
* [env_logger](https://github.com/env-logger-rs/env_logger/): Implements a logger that can be configured via environment variables.

## Acknowledgment
This library is inpired by [AoE2ScenarioParser](https://github.com/KSneijders/AoE2ScenarioParser) and [Trigger Craft](https://github.com/MegaDusknoir/AoE2TriggerCraft)