{"id":13786094,"url":"https://github.com/daemon3000/UnityDebugConsole","last_synced_at":"2025-05-11T22:30:35.480Z","repository":{"id":37692536,"uuid":"102757415","full_name":"daemon3000/UnityDebugConsole","owner":"daemon3000","description":"In-game debug console for Unity games.","archived":false,"fork":false,"pushed_at":"2018-06-03T08:49:09.000Z","size":700,"stargazers_count":30,"open_issues_count":0,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-17T22:36:03.169Z","etag":null,"topics":["c-sharp","console","debugconsole","unity","unity3d"],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/daemon3000.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-07T15:57:30.000Z","updated_at":"2023-12-24T07:16:09.000Z","dependencies_parsed_at":"2022-09-16T09:50:31.107Z","dependency_job_id":null,"html_url":"https://github.com/daemon3000/UnityDebugConsole","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daemon3000%2FUnityDebugConsole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daemon3000%2FUnityDebugConsole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daemon3000%2FUnityDebugConsole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/daemon3000%2FUnityDebugConsole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/daemon3000","download_url":"https://codeload.github.com/daemon3000/UnityDebugConsole/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253645069,"owners_count":21941311,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c-sharp","console","debugconsole","unity","unity3d"],"created_at":"2024-08-03T19:01:09.465Z","updated_at":"2025-05-11T22:30:34.117Z","avatar_url":"https://github.com/daemon3000.png","language":"C#","readme":"# Introduction\nThis plugin allows you to view debug messages in-game, in a build. In addition it also allows you to execute commands(using a Lua parser) and comes with a bult-in bug report tool.\n\n![](Documentation/header.png)\n\n# Requirements\nUnity 5.6 or newer. If you decide to use the Lua command parser the platofrm you aim to publish on must be supported by [MoonSharp](http://www.moonsharp.org/unitytips.html).\n\n# Installation\n* Clone or download the repository to your computer.\n* The repository contains a Unity project. Open the project in Unity.\n* Export everything in the *Assets* folder as a *.unitypackage* file. If you don't want or don't need the Lua command parser uncheck the following folders in the export window: *Console/Addons/LuaCommandParser* and *Plugins*.\n* Import the *.unitypackage* file into your project.\n\nNote: The ***Examples*** folder is optional and can be discarded when you export the Unity package.\n\n# How To\n## Add the console to your game\nSimply drag \u0026 drop the prefab into your first scene and enable **Dont Destroy On Load** in the inspector. The prefab is located in *Assets/Console/Resources/DebugConsole*.\n\nThe debug console will automatically pick up calls to ***UnityEngine.Debug.Log*** so you don't need to write any code.\n\n## Open and close the console\nTo open and close the console press \"~\" on your keyboard. The key can be changed in the inspector(on the **Toggle Debug Console On Key** component).\n\nTo open and close the console from a script call **DebugConsole.Open()** and **DebugConsole.Close()**.\n\nIf you want to temporarily lock the console(e.g. during a loading screen) call **DebuConsole.Lock()** and **DebugConsole.Unlock()**. While locked the console will not respond to user input.\n\n## Write custom commands\nIf you decided to keep the Lua command parser you can add new commands as follows:\n* Create a new C# class that inherits from **LuaCommandModule**.\n* For each command create a method that returns **void** and has any number of parameters of type: **int**, **float**, **bool** or **string**.\n* To display your custom commands when you type **help** in the console add the **LuaCommand** attribute to each command method.\n\n![](Documentation/custom_commands.png)\n\n## Write a custom command parser\nTo use a custom command parser create a script that inherits from **ICommandParser** and assign an instance of it to **DebugConsole.CommandParser**. Attach the script to the debug console game-object.\n\n![](Documentation/custom_command_parser.png)\n\n## Pause the game when the console opens\nIf you want to pause the game when the console opens create a script that inherits from **IPauseHandler** and assign an instance of it to **DebugConsole.PauseHandler**. Attach the script to the debug console game-object.\n\nAdditionally, you can use the built-in class **GenericPauseHandler**.\n\nIf you don't want to pause the game but want to disable player input, for example, subscribe to the **DebugConsole.Opened** and **DebugConsole.Closed** events.\n\n![](Documentation/custom_pause_handler.png)\n\n## Use the bug report tool\nTo use the bug report tool you'll need to implement you own custom feedback form that can upload the data to a private server. **Web programming knowledge is required.**\n\nTo create a custom feedback form create a script that inherits from **IFeedbackForm** and assign an instance of it to **FeedbackUI.FeedbackForm**. Attach the script to the debug console game-object.\n\nAn example feedback form is available that can send the data to [Google Forms](https://support.google.com/docs/answer/6281888).\n\n![](Documentation/custom_feedback_form.png)\n\n# License\nThis software is released under the [MIT license](http://opensource.org/licenses/MIT). You can find a copy of the license in the LICENSE file included in the repository.","funding_links":[],"categories":["UI Debug"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaemon3000%2FUnityDebugConsole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaemon3000%2FUnityDebugConsole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaemon3000%2FUnityDebugConsole/lists"}