search

bevyengine / bevy

A refreshingly simple data-driven game engine built in Rust
https://bevyengine.org
Apache License 2.0
36.24k stars 3.58k forks source link

Docs for installing `tracy` on non-Windows platforms are lacking #8366

Open alice-i-cecile opened 1 year ago

alice-i-cecile commented 1 year ago

How can Bevy's documentation be improved?

I just got this set up on PopOs (Linux, Ubuntu). I documented the steps I took and my confusion in this thread.

Key steps:

  1. Clone the tracy repo, and checkout the correct tag.
  2. Install pkg-config, glfw, freetype, capstone, dbus. Names may vary.
  3. cd into the capture/build/unix folder and run make release LEGACY=1 (legacy flag is for wayland support).
  4. Do the same for profiler/build/unix.
  5. Open the profiler folder in your CLI, then call ./Tracy-release.
  6. Follow existing instructions to actually use the GUI with Bevy.
tim-blackbird commented 1 year ago

Tracy might be available in the package manager depending on the distro

alice-i-cecile commented 1 year ago

Good call: not currently available for me on PopOS however.

SUPERCILEX commented 10 months ago

sudo apt install pkg-config libglfw3-dev libfreetype-dev libcapstone-dev libdbus-1-dev libxkbcommon-dev for those needing deps on pop-os.

dimvoly commented 4 months ago

Might use this thread to have a whinge about the tracy install process.

I'm on Ubuntu 20.04, and per the linked discord thread, I did generally need the "-dev" versions of the packages. The libcapstone (the fork, NOT the capstone-engine) had to be git clone'd and then compiled from source.

Once all that was ready, the tracy code would finally compile.

What was a bit underwhelming was that once I did get the Tracy client to work, on clicking "Statistics" I get a segfault. So I can't really use this. I can see the graphs in the first window but can't get statistics to work for me. At this point I had spent enough time on this and gave up. Likely could be fixed with further digging.

I guess to summarize, while this looks like a very useful tool, but you'll be having a hard time compiling and running the thing. Presumably on windows it is easier with the pre-built binary of tracy.