DebugConsole

Live external console for viewing logs, logs are colored by levels and log files are automatically saved.

DebugConsole 🎮

When the game starts, an independent console window will automatically pop up to display all log output in real time.

---

✨ Features

• **Real-time log window**: The Windows console will automatically pop up when the game starts, and the log will be displayed in real-time scrolling.
• **Full Log Capture**: Capture all output from the game Logger system and Godot engine.
• **Color classification levels**: Error red, Warn yellow, Info white, Debug gray, engine output cyan.
• **Log file persistence**: Automatically save the logs of the current session and the previous session, and can also view them after a crash.
• **Say goodbye to file flipping**: No more pain of manually opening log files!

---

📦 Installation Guide

• Copy **DebugConsole.dll** and **DebugConsole.json** to the **mods** folder in the game directory:

```

Slay the Spire 2/

└── mods/

├── DebugConsole.dll

└── DebugConsole.json

```

• Start the game and the console window will pop up automatically.

---

📁 Log file

Logs are saved in the logs folder of the game user data directory:

```

%AppData%/SlayTheSpire2/logs/

├── DebugConsole.log # Current running log

└── DebugConsole-prev.log # Last run log

```

---

⚙️ Technical implementation

• Create an external console window via Win32 AllocConsole.
• Subscribe to the game global Log.LogCallback event to capture Logger logs.
• Intercept process stdout through pipes to capture Godot engine output and automatically deduplicate it.
• **Windows platforms only**.

---

🙏 Acknowledgments

This project is created based on the Alchyr/ModTemplate-StS2 template.