Add logging (#492)

* Add logger implementation for mgba debugging

* Add logging details to contributors guide

* Clang-format

* update docs real quick

* Cleanup for PR

* Update for PR

* Fix bad rebase

* Fix docs
This commit is contained in:
Rickey
2026-05-21 20:07:34 -07:00
committed by GitHub
parent c2844a5d32
commit d7414157a5
5 changed files with 152 additions and 1 deletions
+17
View File
@@ -143,6 +143,23 @@ In the repo we use custom scripts located in the [`scripts`](https://github.com/
## Debugging
It's recommended to use [mGBA](https://mgba.io/) for ROM testing and debugging. As it provides a [`gdbserver`](https://en.wikipedia.org/wiki/Gdbserver) via the `-g` flag `mgba -g build/balatro-gba.gba`. You can connect via `gdb` or here is a [great guide for vscode](https://felixjones.co.uk/mgba_gdb/vscode.html).
### Logging
Specifically for mgba, logging can be enabled. To do this set `MGBA_LOGGING=1` when running `make`:
```sh
MGBA_LOGGING=1 make
```
🟡 **Note**: If you don't see any logs, try running `make clean` before rebuilding
Then, you can enable logging via the `-l` or `--log-level` option:
```sh
mgba -l 7 build/balatro-gba.gba
```
See [`mgba_logger.h`](include/mgba_logger.h) for details on log levels.
## **Build Instructions**
<details>