consolation - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #ai #llm #android #rust #deep-learning #nodejs #java #windows #kubernetes #awesome-list #security #openai

consolation

(★ 895)

In-game debug console for Unity.

File Explorer

Download Latest Version (.zip)

.editorconfig
CHANGELOG.md
CHANGELOG.md.meta
Consolation.asmdef
Consolation.asmdef.meta
Console.cs
Console.cs.meta
LICENSE.md
LICENSE.md.meta
package.json
package.json.meta
README.md
README.md.meta

# Installation Guide

1. Get the code

git clone https://github.com/mminer/consolation

Downloads the entire project code from GitHub to your computer.

cd consolation

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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

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
```

1. Open the Package Manager window in Unity (*Window > Package Manager*)
2. Click the "+" button in the top-left corner
3. Select "Install package from git URL..."
4. Enter the above Git URL
5. Click "Install"

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

Alternatively, add the following line to your `Packages/manifest.json` file:

```json
{
  "dependencies": {
    "com.matthewminer.consolation": "https://github.com/mminer/consolation.git",
    ...
  }
}
```

You can also clone the repository and point UPM to your local copy.

## Using

Attach the `Console` component to a game object. When playing your game, open
the console window with the back quote key <kbd>`</kbd>. 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.