https://github.com/mminer/consolation

In-game debug console for Unity.
https://github.com/mminer/consolation

game-dev game-development gamedev unity unity3d

Last synced: 4 days ago
JSON representation

In-game debug console for Unity.

• Host: GitHub
• URL: https://github.com/mminer/consolation
• Owner: mminer
• License: mit
• Created: 2014-03-28T19:17:55.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-07-17T02:22:42.000Z (6 months ago)
• Last Synced: 2025-01-03T18:04:44.695Z (11 days ago)
• Topics: game-dev, game-development, gamedev, unity, unity3d
• Language: C#
• Homepage: http://matthewminer.com/2017/03/07/consolation-in-game-console-for-unity
• Size: 243 KB
• Stars: 868
• Watchers: 27
• Forks: 66
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-opensource-unity - consolation - In-game debug console for Unity. (Open Source Packages / Console)
• awesome-unity3d - consolation - In-game debug console for Unity. (Open Source Repositories / Console)
• awesome-unity-open-source-on-github - consolation - In-game debug console (UI Debug)

README

        
# Consolation

It's difficult to retrieve logs and warnings from Unity outside the editor.  To

make it easier, this console displays output from `Debug` in the game itself.

This is especially useful on mobile devices.

![Console in Unity game](https://matthewminer.com/images/consolation.png)

## Installing

### Copy Script

The `Console` component is entirely self-contained in *Console.cs*, so

installation is as simple as dragging this script into your project.

### Unity Package Manager

Alternatively, add the package to your project via

[UPM](https://docs.unity3d.com/Manual/upm-ui.html) using the Git URL

https://github.com/mminer/consolation.git. You can also clone the repository and

point UPM to your local copy.

![Adding package to UPM](https://matthewminer.com/images/consolation-upm.gif)

## Using

Attach the `Console` component to a game object. When playing your game, open

the console window with the back quote key `. This shortcut is

configurable in the inspector.

Alternatively, enable shake-to-open in the inspector to open the console on

mobile devices. The component provides an option to prevent accidental shakes by

requiring 3 or more fingers on the screen.

Several other settings like font size and the maximum log count are also

configurable in the inspector.

![Console component

inspector](https://matthewminer.com/images/consolation-inspector.png)

## Compatibility

Supports Unity 2017.x and above. It hasn't been tested on all the platforms that

Unity supports but it probably works on most.