bevy/docs
liamaharon 0294fa89db
Mitigate Tracy dep version woes (#20109)
# Objective

Turns out, Tracy dep (in)compatibilities can be a headache. Here was my
experience following the [Profiling Tracy
documentation](1525dff7ad/docs/profiling.md (tracy-profiler)):

I ran into this error when I attempted to connect to my bevy client:

<img width="473" height="154" alt="Screenshot 2025-07-13 at 14 39 27"
src="https://github.com/user-attachments/assets/97634b37-253c-40ab-86ca-6eba02985638"
/>

Attempting to find where the version incompatibility stemmed, I found
these tracy dep versions and a link to the compatibility table in the
source:

1525dff7ad/crates/bevy_log/Cargo.toml (L32-L35)

This led me to believe I needed Tracy `0.11.1`, to match the
`tracy-client` version `0.18.0`.

This was confusing because `0.11.1` is the version I already had
installed (by running `brew install tracy`), and latest Tracy version
currently available on `brew`.

It turned out that Cargo was eagerly pulling `tracy-client` `0.18.2`
instead of `0.18.0`, making the Tracy version I needed actually
`0.12.2`. At the time of writing, `0.12.2` is not published on `brew`.

## Solution

I've pinned the Tracy deps, and mentioned in the comment which Tracy
version Bevy is compatible with.

I've also added some notes to [Profiling Tracy
documentation](1525dff7ad/docs/profiling.md (tracy-profiler))
to explain
- How to determine which Tracy version to install
- That MacOS users may need to compile from source if the required Tracy
version is not available on `brew`.

## Testing

- Did you test these changes? If so, how?
I ran Tracy locally.

- Are there any parts that need more testing?
I don't think so.

- How can other people (reviewers) test your changes? Is there anything
specific they need to know?
Follow instructions to run Tracy

- If relevant, what platforms did you test these changes on, and are
there any important ones you can't test?
Tested MacOS. I think change should be OS agnostic.
2025-07-14 20:58:30 +00:00
..
cargo_features.md bevy_ui_render crate (#18703) 2025-07-03 23:36:35 +00:00
debugging.md Replace the wgpu_trace feature with a field in bevy_render::settings::WgpuSettings (#14842) 2024-08-25 14:16:11 +00:00
linters.md ✏️ Fix typos across bevy (#16702) 2024-12-08 01:18:39 +00:00
linux_dependencies.md Update add flake.nix example (#19321) 2025-06-08 02:15:19 +00:00
profiling.md Mitigate Tracy dep version woes (#20109) 2025-07-14 20:58:30 +00:00