add example notes to readme

This commit is contained in:
Robin Appelman 2023-12-21 01:07:39 +01:00
commit 0377223955

View file

@ -2,4 +2,20 @@
Rust parser for source engine model files (`.mdl`, `.vtx`, `.vvd`)
![Scout model rendered by the example program](./screenshots/scout.png)
![Scout model rendered by the example program](./screenshots/scout.png)
## Examples
All examples require the `.mdl`, `.vvd` and `.dx90.vtx` to be next to each other and TF2 to be installed to load the texture data from.
## Viewer
```bash
cargo run --release --example view <path-to-mdl>
```
## Convert to gltf
```bash
cargo run --release --example gltf <path-to-mdl> <path-for-output-gtb>
```