proto/README.md
TBK a81b10d7b2 Update README.md
Fix paths to proto-csgo, proto-dota2, and proto-tf2 and format shell commands as bash code block for easy copy paste.
2025-10-18 19:28:31 +02:00

33 lines
967 B
Markdown

# Protobufs for steam-vent
Sourced from https://github.com/SteamDatabase/Protobufs
## Updating generated code
```bash
cd build
cargo r -- ../steam/{protos,src/generated}
cargo r -- ../../proto-csgo/{protos,src/generated}
cargo r -- ../../proto-dota2/{protos,src/generated}
cargo r -- ../../proto-tf2/{protos,src/generated}
```
## Using custom protobufs
If you need to use protobufs that aren't packages by steam-vent, you can create
a new package for the protobufs using the following steps:
1. Create a new crate
2. Add `steam-vent-proto-common` as a dependency
3. Place the protobufs in `src/protos`
4. Create an empty `src/generated` folder
5. Either install `steam-vent-proto-build` trough `cargo-install` or clone this
repo and build it from the `build` directory.
6. Run `steam-vent-proto-build path/to/src/protos path/to/src/generated`
7. Create `src/lib.rs` with the following contents:
```rust
mod generated;
pub use generated::*;
```