hakowork/rojo
3
0
Fork 0
mirror of https://github.com/rojo-rbx/rojo.git synced 2026-10-20 17:41:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated contributing.md

Browse source 
added tracy documentation for new users
This commit is contained in:
ademerdogan2008 2026-06-26 12:27:44 -05:00
parent 16633e3c65
commit 6dd3c610f0
1 changed files with 48 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

48
CONTRIBUTING.md
View file

@ -62,6 +62,54 @@ Sometimes there's something that Rojo doesn't do that it probably should.
Please file issues and we'll try to help figure out what the best way forward is.
## Profiling with Tracy
Rojo can be built with [Tracy](https://github.com/wolfpld/tracy) support to help find performance problems. Snapshot, patch, and build code paths are instrumented with the [`profiling`](https://crates.io/crates/profiling) crate.
### Installing Tracy
1. Download the Tracy profiler UI from the [Tracy releases page](https://github.com/wolfpld/tracy/releases), or build it from source. Each release includes a `tracy.pdf` manual with build instructions.
2. Use a Tracy version that matches Rojo's `tracy-client` dependency. Check the `tracy-client-sys` version in [`Cargo.lock`](Cargo.lock) and find the corresponding Tracy release in the [tracy-client version table](https://crates.io/crates/tracy-client#version-support-table).
### Building Rojo with Tracy support
```bash
cargo build --features profile-with-tracy
```
For meaningful performance data, prefer a release build:
```bash
cargo build --release --features profile-with-tracy
```
### Capturing a trace
1. Start the Tracy profiler UI.
2. Run Rojo with the feature enabled, for example:
```bash
cargo run --release --features profile-with-tracy -- serve
```
3. In Tracy, connect to the running `rojo` process.
4. Perform the actions you want to profile (syncing, building, etc.) and inspect the timeline in Tracy.
Short-lived commands like `build` may exit before Tracy can connect. Set `TRACY_NO_EXIT=1` to keep the process alive until you connect:
```bash
TRACY_NO_EXIT=1 cargo run --release --features profile-with-tracy -- build
```
### Adding instrumentation
Use these `profiling` macros in Rust code:
* `#[profiling::function]` on a function traces the entire function body.
* `profiling::scope!("name")` traces a block within a function.
These macros compile to no-ops unless the `profile-with-tracy` feature is enabled.
## Local Development Gotchas
If your build fails with an error about a missing path under `plugin/Packages`, such as `plugin/Packages/Roact`, you need to update your Git submodules.