source-kv 0.1.0

A Serde serialization and deserialization library for Valve's Key-Value format.
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

# source-kv

A straightforward `serde` implementation for parsing and serializing Valve's textual Key-Values formats (such as `.vmf`, `.vmt`, `gameinfo.txt`, etc.).
## Example

Add this to your `Cargo.toml`:

```toml
[dependencies]
source_kv = "0.1.0"
serde = { version = "1.0", features = ["derive"] }
````

### Parsing a basic Map Entity

```rust
use serde::Deserialize;

#[derive(Debug, Deserialize)]
struct MapData {
    #[serde(rename = "entity", default)]
    entities: Vec<Entity>,
}

#[derive(Debug, Deserialize)]
struct Entity {
    id: u32,
    classname: String,
    origin: Option<String>,
    #[serde(default)]
    connections: Vec<Connection>,
}

#[derive(Debug, Deserialize)]
struct Connection {
    target: String,
    action: String,
}

fn main() {
    let vmf_data = r#"
    entity
    {
        "id" "1337"
        "classname" "prop_physics"
        "origin" "0 0 64"
        
        "connections"
        {
            "target" "door_1"
            "action" "Open"
        }
    }
    "#;

    let parsed_entity: MapData = source_kv::from_str(vmf_data).unwrap();
    println!("{:#?}", parsed_entity.entities);
}
```

Repeated keys (very common in VMF) are supported using `Vec<T>` with `#[serde(rename = "...")]`.

More examples are available in the [`examples/`](examples/) directory.

## API

- `source_kv::from_str` — deserialize from `&str`
- `source_kv::to_string` — serialize to `String`

## License
MIT License.