N-archive/mikage-dev
1
0
Fork 0
mirror of https://github.com/mikage-emu/mikage-dev.git synced 2025-01-20 12:31:06 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add profiling info and update gitignore

Browse source
This commit is contained in:
Vinicius 2025-01-03 17:19:19 +00:00
parent c2e483deab
commit 3a65927adc
2 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
.gitignore vendored Normal file
View file

@ -0,0 +1,3 @@
build/*
aes_keys.txt
*.tracy

11
README.md
View file

@ -9,6 +9,8 @@ CMake and Conan 2 are required to build Mikage.
* `cmake .. -G Ninja --toolchain conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release` * `cmake .. -G Ninja --toolchain conan_toolchain.cmake -DCMAKE_BUILD_TYPE=Release`
* `ninja && sudo ninja install` * `ninja && sudo ninja install`
NOTE: On Linux, Vulkan libraries are also required and will NOT be built by Conan.
Some dependencies may be provided by system packages instead of building them Some dependencies may be provided by system packages instead of building them
via Conan. To enable this behavior, add the following to your Conan profile via Conan. To enable this behavior, add the following to your Conan profile
(`~/.conan2/profiles/default`): (`~/.conan2/profiles/default`):
@ -62,3 +64,12 @@ be necessary to do this. Debuggers other than gdb may work but are untested.
Processes running in the emulated kernel can be introspected through a simple Processes running in the emulated kernel can be introspected through a simple
debug console available via telnet on port 12347. debug console available via telnet on port 12347.
## Profiling
Mikage uses [Tracy](https://github.com/wolfpld/tracy) for profiling. To enable it,
pass `-o enable_profiler=True` to `conan install` and rebuild Mikage.
Get your Tracy server (often available from the system package manager) up and
running and start listening for clients. Then launch Mikage and your server will
start recording. Each emulator frame will be captured containing the Tracy Zones
that have been defined throughout Mikage's code.