From 642331b2d0403b86da4b23e2963602aa059bbcf7 Mon Sep 17 00:00:00 2001 From: Eric Date: Sun, 4 May 2025 14:10:25 -0400 Subject: [PATCH] Create TRACY.md --- docs/TRACY.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/TRACY.md diff --git a/docs/TRACY.md b/docs/TRACY.md new file mode 100644 index 000000000..cac039897 --- /dev/null +++ b/docs/TRACY.md @@ -0,0 +1,12 @@ +# Tracy Performance Profiling + +In v0.5.1, Funkin' gained support for a powerful instrumentation-based profiler known as Tracy. This development tool allows you to see exactly what the game is doing at any given moment, how long each function is taking to call, and even how memory is allocated and deallocated. This is the most powerful tool in your toolbox for diagnosing and resolving performance issues. + +## How to Use Tracy + +1. Download [Tracy](https://github.com/wolfpld/tracy) +2. Build the game with the `FEATURE_DEBUG_TRACY` flag. For example, `lime build windows -debug -DFEATURE_DEBUG_TRACY` +3. Start Tracy, click Connect. Tracy will start waiting for Funkin' to start. +4. Start the game with Tracy enabled. + +![Image](https://github.com/user-attachments/assets/2a394ca7-bc21-4fe3-ae55-347768fb5b87)