{"id":14960931,"url":"https://github.com/expressobits/ebconsole","last_synced_at":"2025-10-24T20:30:41.912Z","repository":{"id":88142686,"uuid":"261908087","full_name":"expressobits/EBConsole","owner":"expressobits","description":"🛃Customizable ▶️Easy ➿Definitive 🆓Free Console in Game for Unity!","archived":false,"fork":false,"pushed_at":"2022-06-04T17:37:58.000Z","size":363,"stargazers_count":22,"open_issues_count":5,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-01-31T03:54:20.824Z","etag":null,"topics":["unity","unity-scripts","unity3d","visual"],"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/expressobits.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","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":"2020-05-07T00:10:28.000Z","updated_at":"2024-07-04T10:02:29.000Z","dependencies_parsed_at":"2023-05-18T10:54:27.055Z","dependency_job_id":null,"html_url":"https://github.com/expressobits/EBConsole","commit_stats":{"total_commits":130,"total_committers":2,"mean_commits":65.0,"dds":0.05384615384615388,"last_synced_commit":"200600650876b760e211a078d47e696f8d3ecdc4"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/expressobits%2FEBConsole","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/expressobits%2FEBConsole/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/expressobits%2FEBConsole/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/expressobits%2FEBConsole/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/expressobits","download_url":"https://codeload.github.com/expressobits/EBConsole/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238030288,"owners_count":19404859,"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-scripts","unity3d","visual"],"created_at":"2024-09-24T13:23:28.426Z","updated_at":"2025-10-24T20:30:41.533Z","avatar_url":"https://github.com/expressobits.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Welcome to Expresso Bits Console 👋\n![Version](https://img.shields.io/badge/version-1.3.3-blue.svg?cacheSeconds=2592000)\n[![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](todo-doc)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](MIT)\n[![Twitter: ScriptsEngineer](https://img.shields.io/twitter/follow/ScriptsEngineer.svg?style=social)](https://twitter.com/ScriptsEngineer)\n\n![Demo4](https://raw.githubusercontent.com/wiki/ExpressoBits/EBConsole/Demo4.gif)\n\n## Features\n\n✔️ Commands with easy access.\n\n✔️ Persistent logs in the form of toasts.\n\n✔️ Command history.\n\n✔️ Commands pre-established or added at run time.\n\n✔️ Display Debug.Log messages in the console.\n\n✔️ Adding status messages (Example: FPS)\n\n🔨 Easy change of themes and visual by having separate interface and logic codes.\n\n\n## Install\n\n\nTo install open \u003cb\u003eWindow\u003c/b\u003e \u003e \u003cb\u003ePackage Manager\u003c/b\u003e and click on the + package icon and choose \u003cb\u003e\"Add package from git url\"\u003c/b\u003e and type:\n\n\u003e https://github.com/ExpressoBits/EBConsole.git\n\nand you're done!\n\n\n\n## Usage\nAdd the prefab consoler in the scene and the visual consoler in a permanent visual interface (One that is not destroyed between scenes).\nFor it to work correctly, an EventSystem is needed in your scene.\n\n## Components\n\n### ![Consoler](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Editor/Textures/Consoler.png) Consoler\n\nThe main component of the console system. The component is basically a utility for calling Singleton Commander and \nLog methods.Just add the components you want for a console of your taste!\n\n### ![Commander](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Editor/Textures/commander.png) Commander component\n\nThis component creates a visual bar for typing commands, it can be opened and closed using the ToggleCommander component or directly via code.\nYou can create custom commands by extending the \u003ci\u003eConsoleCommand\u003c/i\u003e class for add in commander component. \nThen just add the command's scriptable object to the \u003ci\u003eCommander\u003c/i\u003e component.\n\n### ![Logs](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Editor/Textures/Logs.png) Logs component\n\n![Demo3](https://raw.githubusercontent.com/wiki/ExpressoBits/EBConsole/Demo3.gif)\n\nComponent that displays responses from the console, when added creates a new visual component that allows displaying logs in toasts (when the commander is closed) and persistent logs until the defined limit is exceeded (this is displayed when the commander is open).\n\nHere are a variety of settings to make:\n- Log limit on the console\n- Standard time to exit toast\n- Log type colors and icons\n\n\u003e Note: \u003cb\u003eRich text\u003c/b\u003e is accepted in logs and commands\n\n#### Log methods\n![LogTypes](https://raw.githubusercontent.com/wiki/ExpressoBits/EBConsole/LogTypes.png)\n\nIt still has basic log commands that add messages to a panel below the console. These can be called up with:\n\n\n| ![icon](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Runtime/Textures/commander.png) | Log Type  | In Script    | In Commander |\n|:---:|:-------------------------|:------|:-----|\n| ![icon](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Runtime/Textures/log.png) | Default Log |  ```Consoler.Instance.Logs.Log(\"Log Default\");``` | ```/log Log Default``` |\n| ![icon](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Runtime/Textures/warn.png) | Warning Log |  ```Consoler.Instance.Logs.LogWarn(\"Warning log\");```  |   ```/warn Warning log``` |\n| ![icon](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Runtime/Textures/error.png) | Error Log | ```Consoler.Instance.Logs.LogError(\"Error log\");``` |    ```/error Error log``` |\n| ![icon](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Runtime/Textures/sucess.png) | Success Log | ```Consoler.Instance.Logs.LogSuccess(\"Success log\");``` |    ```/error Success log``` |\n| ![icon](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Runtime/Textures/help.png) | Help Log | ```Consoler.Instance.Logs.LogHelp(\"Help log\");``` |    ```/error Help log``` |\n|   | Clear the Log| ```Consoler.Instance.Logs.Clear();``` |    ```/clear``` |\n\u003e Note: the \u003cb\u003e/\u003c/b\u003e prefix can be modified by the user in the commander component.\n\n\n### ![ToggleCommander](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Editor/Textures/ToggleCommander.png) Toggle Commander Component\n\nBy default the component added to the prefab called \u003ci\u003eToggleCommander\u003c/i\u003e opens the console with \u003ci\u003eEnter\u003c/i\u003e and closes the console with \u003ci\u003eEsc\u003c/i\u003e. You can modify these keys for your convenience, and you can also remove this component if you want another component / object to handle the commander.\n\n### ![HelperCommander](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Editor/Textures/HelpCommander.png) Helper commander component\n\n![Demo2](https://raw.githubusercontent.com/wiki/ExpressoBits/EBConsole/helper.png)\n\nPrints help messages to open the console, to close and the console version.\n\n### ![History](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Editor/Textures/history.png) History component\n\n![Demo2](https://raw.githubusercontent.com/wiki/ExpressoBits/EBConsole/history.gif)\n\nStores the history of commands entered on the console, \nand also manages keyboard entries to navigate between the history (by default up and down arrow keys.\n\n### ![Visual Consoler](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Editor/Textures/VisualConsoler.png) Visual Consoler\n\nHere what interface magic happens, where you can modify how you can visually represent the console!\n\u003e Note:This component must be placed as a child of some visual resource such as a Canvas, Panel.\n\n### ![Theme](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Editor/Textures/Theme.png) Theme\n\nBy default the comforting look comes with the \u003ci\u003ePixel\u003c/i\u003e theme, but can be modified to another customized theme. Just add it via the \u003ci\u003eExpresso Bits \u003e Console \u003e Theme\u003c/i\u003e menu.\n\n### Sample commands\n\n| Command  |  Description |\n|----------|:-------------------------|\n| /log (message) |  ... | \n| /error (message) | ... |\n| /warn (message) | ... |\n| /error (message) | ... |\n| /success (message) | ... |\n| /help (message) | ... |\n| /history | ... |\n| /clear | ... |\n| /gravity (float) / (float) (float) (float) | ... |\n| /help | ... |\n\nPlease let me know some command ideas to be added here, use the [issues page](https://github.com/ExpressoBits/EBConsole/issues) for that!\n\n\n### ![Stater](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Editor/Textures/Stater.png) Stater\n\n![Stater](https://raw.githubusercontent.com/wiki/ExpressoBits/EBConsole/Stats.png)\n\nThis component other is used alone, it is used to add power feature display messages that stay somewhere on the screen with status function . A good example is the use of fps (Frames per second) status that is used by a prefab with the Stater component.\n\nAt the moment it is extremely simple and should always be linked to a Visual Stater\n\n### ![Visual Stater](https://raw.githubusercontent.com/ExpressoBits/EBConsole/master/Editor/Textures/VisualStater.png) Visual Stater\n\nJust like Visual Consoler, it separates every visual part of the stater. Here can be defined a visual prefab that I have InfoMessage as a component.\n\n\u003e Note: Can be modified to anywhere and corner of the screen the component.\n\n\n## Authors\n\n👤 **Rafael Correa**\n(Script)\n* Twitter: [@ScriptsEngineer](https://twitter.com/ScriptsEngineer)\n* Github: [@scriptsengineer](https://github.com/scriptsengineer)\n\n\n## 🤝 Contributing\n\nContributions, issues and feature requests are welcome!\n\nFeel free to check [issues page](https://github.com/ExpressoBits/EBConsole/issues).\n\n## Show your support\n\nGive a ⭐️ if this project helped you!\n\n\n## 📝 License\n\nCopyright © 2020 [Rafael Correa](https://github.com/scriptsengineer).\n\nThis project is [MIT](MIT) licensed.\n\n***\n_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexpressobits%2Febconsole","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexpressobits%2Febconsole","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexpressobits%2Febconsole/lists"}