{"id":14960850,"url":"https://github.com/blueeagle421/blueconsole","last_synced_at":"2026-02-07T01:04:10.893Z","repository":{"id":207903034,"uuid":"720384177","full_name":"BlueEagle421/BlueConsole","owner":"BlueEagle421","description":"A versatile in-game debug console with built-in commands, logging messages, and a regex-based hint system.","archived":false,"fork":false,"pushed_at":"2024-03-10T11:38:12.000Z","size":4413,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T20:42:17.725Z","etag":null,"topics":["unity","unity-package","unity-script","unity-scripts","unity2d"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BlueEagle421.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-18T10:15:50.000Z","updated_at":"2024-03-09T12:25:24.000Z","dependencies_parsed_at":"2024-09-29T06:19:13.116Z","dependency_job_id":null,"html_url":"https://github.com/BlueEagle421/BlueConsole","commit_stats":{"total_commits":162,"total_committers":2,"mean_commits":81.0,"dds":0.08024691358024694,"last_synced_commit":"7b9a5b697de907e031cf9d22903e2a6d2718ef8c"},"previous_names":["blueeagle421/blueconsole"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/BlueEagle421/BlueConsole","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlueEagle421%2FBlueConsole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlueEagle421%2FBlueConsole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlueEagle421%2FBlueConsole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlueEagle421%2FBlueConsole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BlueEagle421","download_url":"https://codeload.github.com/BlueEagle421/BlueConsole/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BlueEagle421%2FBlueConsole/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265276681,"owners_count":23739243,"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":["unity","unity-package","unity-script","unity-scripts","unity2d"],"created_at":"2024-09-24T13:23:12.905Z","updated_at":"2026-02-07T01:04:10.830Z","avatar_url":"https://github.com/BlueEagle421.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e  \n  Blue-Console\n\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003eA lightweight, versatile in-game debug console with built-in commands, logging messages, and a regex-based hint system.\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n \u003ca href=\"https://unity3d.com/get-unity/download\"\u003e\n \u003cimg src=\"https://img.shields.io/badge/unity-2022.3%2B-blue.svg\" alt=\"Unity Download Link\"\u003e\n \u003ca href=\"https://github.com/BlueEagle421/BlueConsole/blob/main/LICENSE\"\u003e\n \u003cimg src=\"https://img.shields.io/badge/License-MIT-brightgreen.svg\" alt=\"License MIT\"\u003e\n\u003c/p\u003e\n\n \u003cp align=\"center\"\u003e\n  \u003ca href=\"#about\"\u003eAbout\u003c/a\u003e •\n  \u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e •\n  \u003ca href=\"#how-to-use\"\u003eHow-To-Use\u003c/a\u003e •\n  \u003ca href=\"#features\"\u003eFeatures\u003c/a\u003e •\n  \u003ca href=\"#feedback\"\u003eFeedback\u003c/a\u003e •\n  \u003ca href=\"#resources\"\u003eResources\u003c/a\u003e •\n  \u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\n\u003c/p\u003e\n\n## About\nA versatile in-game debug console with built-in commands, logging messages, and a regex-based hint system.\nThe strongest aspect of this console is how easy and fast it is to add new commands to suit any game.\n\nI initiated this project because some time ago, I needed a console to debug my game and couldn't find anything online that met all my requirements.\nI then decided to create one myself.\n\n## Installation\nTo add BlueConsole to your project simply copy the HTTPS link from this repository and download it from the Unity Package Manager using the \"Add package from git URL...\" option.\n\n```\nhttps://github.com/BlueEagle421/BlueConsole.git\n```\n\n\u003cp align=\"center\"\u003e\n \u003cimg src=\"https://i.imgur.com/uf6pXfu.png\"\u003e\n\u003c/p\u003e\n\nYou can also download it directly from [Releases](https://github.com/BlueEagle421/BlueConsole/releases).\n\n## How-To-Use\n\nAfter installing the package you can just simply drag the \"Console\" prefab into your scene. And that's it! You now have a working BlueConsole.\nThe main prefab can be found in BlueConsole/Prefabs folder.\n\nKey bindings:\n\n- Use \u003ckbd\u003e~\u003c/kbd\u003e to toggle the console on and off\n- Use \u003ckbd\u003eenter\u003c/kbd\u003e to execute text content from the input\n- Use \u003ckbd\u003e↑\u003c/kbd\u003e and \u003ckbd\u003e↓\u003c/kbd\u003e to scroll through history\n- Use \u003ckbd\u003etab\u003c/kbd\u003e to accept maching hint\n\nIf you downloaded the package with git URL I recommend to create a local copy of the console prefab, because otherwise you won't be able to make changes to it.\n\nNote that you need to have an EventSystem in you scene for the input working properly.\n\n## Features\n\nMain features of the console:\n\n### Very modular and an easy way to add custom console commands.\nEvery command is essentially a method with a custom \"ConsoleCommandAttribute.\" Adding your own commands is a straightforward process – just add the attribute, customize the command's ID and description, and write the code for your function. The console reads all methods from specified assemblies and adds them as executables.\n\n```c#\n[Command(\"quit\", \"closes the application\")]\npublic static void Quit()\n{\n    Application.Quit();\n}\n```\n\n### Commands use custom parameter types.\nEvery type is parsed and checked differently. BlueConsole, by default, supports almost every C# type and a bunch of Unity types. If you want, you can easily allow your own types to be parsed in arguments – it could be a struct, scriptable object, or anything you prefer!\n\n```c#\n[TypeParameter(\"\\\".*?\\\"\", true)]     \npublic static string StringParameter(string inputParam)     \n{         \n    return inputParam.Replace(\"\\\"\", string.Empty);    \n}\n```\n\n### Regex-based hint system.\nThe console tells you the closest command to what you are typing in the input field using a simple regex matching function. This feature makes it intuitive to find what you want and ensures that you didn't misspell anything.\n\n### Logic and visuals are separated.\nEverything that happens in the console should appear on the screen and be customizable. BlueConsole not only allows you to change every aspect of its looks but can also be completely overhauled with some tweaks in a single class. This is because the logic triggers specific events, and visuals receive them to display content accordingly.\n\n### Logging Unity messages\nBy default BlueConsole subscribes to all Unity logs and shows them in-game. This is particularly useful for debugging built projects that don't have the default console provided by Unity editor. Colored messaged also make it effortless to spot what needs extra attention in code.\n\n## Feedback\n\nPlease let me know what you think about the console and its presentation. I hope that my explanations are somewhat C# newcomer-friendly. It's my first game tool, and every piece of feedback is valuable to me.\nEvery issue with the package can be reported in [Issues](https://github.com/BlueEagle421/BlueConsole/issues).\n\n## Resources\nHere are some sites I used for learning during the development of BlueConsole. If your interested in these topics I highly recommend them!\n\nFor regex:\n\nhttps://regex101.com\n\nhttps://gist.github.com/vitorbritto/9ff58ef998100b8f19a0\n\n## License\n\nMIT License\n\nhttps://github.com/BlueEagle421/BlueConsole/blob/main/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblueeagle421%2Fblueconsole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblueeagle421%2Fblueconsole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblueeagle421%2Fblueconsole/lists"}