vmf-forge 0.4.0

A parser for Valve Map Format (VMF) files
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

<div align="center">
<img src="branding/logo.png" alt="Vmf-Forge Logo" width="35%">

[![Crates.io](https://img.shields.io/crates/v/vmf-forge.svg)](https://crates.io/crates/vmf-forge)
[![Docs.rs](https://docs.rs/vmf-forge/badge.svg)](https://docs.rs/vmf-forge)
![License](https://img.shields.io/github/license/IaVashik/vmf-forge)

### `vmf-forge` is a Rust library for parsing, manipulating, and serializing Valve Map Format (VMF) files used in Source Engine games. 
</div>

## Features

*   Parses VMF files into convenient Rust data structures.
*   Allows modification of VMF data.
*   Serializes the modified data back into a VMF file.

## Installation

Add `vmf-forge` to your `Cargo.toml`:

```toml
[dependencies]
vmf-forge = "0.4.0"
```

## Usage Example

```rust
use vmf_forge::prelude::*;
use std::fs::File;

fn main() -> Result<(), VmfError> {
    let mut file = File::open("your_map.vmf")?;
    let vmf_file = VmfFile::parse_file(&mut file)?;

    // Access and modify the VMF data
    println!("Map Version: {}", vmf_file.versioninfo.map_version);

    // Find info_player_start entity
    if let Some(player_start) = vmf_file.entities.find_by_classname("info_player_start").next() {
       println!("Found player start: {:?}", player_start);
   }

    // Add a new entity
    let mut new_entity = Entity::default();
    new_entity.key_values.insert("classname".to_string(), "prop_static".to_string());
    new_entity.key_values.insert("model".to_string(), "models/props_foliage/urban_tree001a.mdl".to_string());
    new_entity.key_values.insert("origin".to_string(), "0 0 0".to_string());
    vmf_file.entities.push(new_entity);

    // Save the modified VMF file
    vmf_file.save("modified_map.vmf")?;

    Ok(())
}
```

## Contributing

Contributions are welcome! Please feel free to open issues or submit pull requests.

## License

`vmf-forge` is distributed under the terms of either the [MIT license](LICENSE).