Update README

2024-07-27 18:54:58 +08:00 · 2024-04-03 23:22:39 +08:00
parent 1e9e429b80
commit 10e7ec8e4e
2 changed files with 17 additions and 4 deletions
--- a/README.md
+++ b/README.md
@@ -1 +1,15 @@
-# BalatroMessager
+# BalatroMessager
+
+A simple tool for listening to [Steamodded](https://github.com/Steamopollys/Steamodded) logs.
+
+---
+
+This tool obtains all messages sent by the `sendDebugMessage` method by listening to and debugging output port `12345`.
+
+
+You can save the log by redirecting the output
+```bash
+BalatroMessager.exe > msg.log
+```
+
+or just double-click to run it.