Repolode
yasirkula

yasirkula/UnityIngameDebugConsole

A uGUI-based in-game console for Unity that shows runtime logs and lets you run registered debug commands in builds.

Stars
2,746
Forks
267
Open issues
9
Last commit
last month

What is it?

This Unity asset displays debug messages such as logs, warnings, errors and exceptions at runtime in a build, and also shows assertions in the editor. It includes a command console where you type registered functions and their parameters to call them during gameplay, which helps when testing or debugging without rebuilding. On Android it can also forward logcat messages into the console.

The interface is built with uGUI and uses a recycled list view that calls Instantiate sparingly. While playing, the window can be resized or hidden, and a small draggable popup shows how many new logs arrived while it was closed. In the Unity editor, right-clicking a log entry opens the corresponding script line.

Commands can be registered with a ConsoleMethod attribute, strongly typed AddCommand calls, or weakly typed static and instance method registration. Custom parameter types can be added with a parser function, so the console can accept project-specific objects.

Key features

  • 01Shows logs, warnings, errors and exceptions at runtime in builds.
  • 02Executes registered functions from an in-game command input field.
  • 03Forwards Android logcat messages to the console.
  • 04Built with uGUI using a recycled list view for efficient rendering.
  • 05Supports custom command parameter types through parser functions.

Use cases

  • Debugging gameplay issues on test devices without connecting to the editor.
  • Triggering game functions like spawning objects during QA sessions.
  • Reading Android logcat output alongside game logs.

Topics

FAQ

What is UnityIngameDebugConsole?
A uGUI-based in-game console for Unity that shows runtime logs and lets you run registered debug commands in builds. This Unity asset displays debug messages such as logs, warnings, errors and exceptions at runtime in a build, and also shows assertions in the editor. It includes a command console where you type registered functions and their parameters to call them during gameplay, which helps when testing or debugging without rebuilding. On Android it can also forward logcat messages into the console.
Is UnityIngameDebugConsole free to use? What license does it have?
UnityIngameDebugConsole is open source under the MIT license. Check the license terms before using it in commercial products.
Is UnityIngameDebugConsole still maintained?
Updated within 6 months. The last commit to UnityIngameDebugConsole was on Sep 6, 2026.
What can I use UnityIngameDebugConsole for?
Debugging gameplay issues on test devices without connecting to the editor. Triggering game functions like spawning objects during QA sessions. Reading Android logcat output alongside game logs.
Where can I get UnityIngameDebugConsole?
The source code and installation instructions are on GitHub: https://github.com/yasirkula/UnityIngameDebugConsole

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects