https://github.com/yanicksenn/unity-console

Unity3d package allowing the toggling of console output and debugging of UnityEvents.
https://github.com/yanicksenn/unity-console

game-development open-source unity unity3d

Last synced: 2 months ago
JSON representation

Unity3d package allowing the toggling of console output and debugging of UnityEvents.

• Host: GitHub
• URL: https://github.com/yanicksenn/unity-console
• Owner: yanicksenn
• License: mit
• Created: 2022-02-17T07:55:17.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-03-19T21:29:27.000Z (over 4 years ago)
• Last Synced: 2025-07-02T10:51:06.940Z (about 1 year ago)
• Topics: game-development, open-source, unity, unity3d
• Language: C#
• Homepage:
• Size: 279 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Unity Console

Unity3d package allowing the toggling of console output and debugging of UnityEvents.

Feedback is welcome.

## Plug and Play

1. Open "Package Manager"

2. Choose "Add package from git URL..."

3. Use the HTTPS URL of this repository:

   `https://github.com/yanicksenn/unity-console.git#1.0.0`

4. Click "Add"

## Usage

- [Console](#user-content-console)

- [Logging](#user-content-logging)

- [Toggling](#user-content-toggling)

### Console

A console can be created through the asset menu > Create > Console > ... .

![Asset menu](./Documentation/asset-menu.png)

### Logging

You can inject a console throught the inspector into your script.

Is is possible to use lazy logging or normal logging, although it is recommended to always use lazy logging inside of a script.

| Lazy logging             | Normal logging |

|--------------------------|----------------|

| `LazyLog(() => ...)`     | `Log(...)`     |

| `LazyWarning(() => ...)` | `Warning(...)` |

| `LazyError(() => ...)`   | `Error(...)`   |

```c#

public class MyBehaviour : MonoBehaviour

{

    public Console console;

    

    private Start()

    {

        console?.LazyLog(() => "Hello, World!");

    }

}

```

Normal logging is recommended through a unity event.

```c#

public class MyBehaviour : MonoBehaviour

{

    public UnityEvent unityEvent = new UnityEvent();

    

    private Awake()

    {

        unityEvent.Invoke();

    }

}

```

![Unity event](./Documentation/unity-event.png)

After the untiy event was invoked the following output will appear in the editor console.

![Output](./Documentation/output.png)

### Toggling

No messages will be printed to the console when it is set to inactive.

![Toggle active](./Documentation/toggle-active.png)

_Active console_

![Toggle inactive](./Documentation/toggle-inactive.png)

_Inactive console_

Lazy logging ensures that no messages are generated while normal logging always generates a message but will only print it when the console is active.