{"id":14961570,"url":"https://github.com/kubulambula/godot-gdshell","last_synced_at":"2025-04-09T20:00:21.234Z","repository":{"id":63977189,"uuid":"559879261","full_name":"Kubulambula/Godot-GDShell","owner":"Kubulambula","description":"Light-weight, powerful, customizable and modular in-game console for Godot 4.","archived":false,"fork":false,"pushed_at":"2025-03-05T19:26:05.000Z","size":1218,"stargazers_count":221,"open_issues_count":10,"forks_count":12,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-02T19:00:45.930Z","etag":null,"topics":["console","gdscript","gdshell","godot","godot-addon","godot-console","godot-engine","godot4","godotengine","shell"],"latest_commit_sha":null,"homepage":"https://godotengine.org/asset-library/asset/1526","language":"GDScript","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/Kubulambula.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2022-10-31T09:40:23.000Z","updated_at":"2025-03-29T17:54:49.000Z","dependencies_parsed_at":"2024-09-24T13:43:21.065Z","dependency_job_id":"54be3c70-6259-4105-ba4f-18ab5f57af09","html_url":"https://github.com/Kubulambula/Godot-GDShell","commit_stats":{"total_commits":144,"total_committers":7,"mean_commits":"20.571428571428573","dds":"0.19444444444444442","last_synced_commit":"3e894e7d5539cca48002f67d13d4306a3934f741"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kubulambula%2FGodot-GDShell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kubulambula%2FGodot-GDShell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kubulambula%2FGodot-GDShell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kubulambula%2FGodot-GDShell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kubulambula","download_url":"https://codeload.github.com/Kubulambula/Godot-GDShell/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103877,"owners_count":21048245,"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":["console","gdscript","gdshell","godot","godot-addon","godot-console","godot-engine","godot4","godotengine","shell"],"created_at":"2024-09-24T13:25:43.106Z","updated_at":"2025-04-09T20:00:21.054Z","avatar_url":"https://github.com/Kubulambula.png","language":"GDScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GDShell\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Kubulambula/Godot-GDShell\"\u003e\n    \u003cimg src=\"addons/gdshell/docs/assets/logo_text.png\" width=\"700\" alt=\"GDShell logo\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\n#### ⚠️ This plugin is still in early development\n\n\nSimple, linux-like, all-in-one, in-game console for development, debugging, cheats and/or any other interaction with your game.\n\n\n## 📦 Out of the box\nGDShell works right away after installation with no need for a complex setup.\n\nAdd you own commands, don't reinvent the wheel and get right back to the important stuff that makes your game fun!\n\n\n\n## 🏄 Easy to use\nForget creating commands from [`Callable`](https://docs.godotengine.org/en/latest/classes/class_callable.html)s, with messy object and method relations.\n\nEvery command is it's own script, resulting in better code organization and project structure by design.\n\n\n**Just create a script, place it in a command folder and you're good to go!**\n\n```gdscript\nextends GDShellCommand\n# res://addons/gdshell/commands/hello.gd\n\nfunc _main(argv, data):\n    output(\"Hello World!\")\n    return {}\n```\n\n\n## 💪 Simple, yet powerful\nDon't let the ease of use fool you. GDShell can be used even for more complex tasks like:\n\n* sequential and conditional command chaining\n\n    `alias cls clear \u0026\u0026 echo \"Success\" || echo \"Failed\"; echo \":(\"`\n\n* executing commands in background\n\n    `wait_for_godot\u0026 ; think_about_your_game_project`\n\n* command result passing\n\n    `gdfetch -s | echo`\n\nThe sky is the limit here. Even if you never need any of these features, you can sleep knowing, that they are here, if you ever will.\n\n\n## 🧩 Modular and customizable\n* Do you dislike the default UI?\n* Do you wish to have a new operator?\n* Do you want to have bunch of buttons that call the commands directly without the console interface?\n\nEvery part of GDShell can be modified, extended or replaced as long as you implement the necessary methods.\n\nNearly anything your heart desires can be done!\n\n\n## 🧪 Installation\n### Installation via [AssetLib](https://godotengine.org/asset-library/asset/1526)\n1. Open AssetLib in your project (AssetLib button in the top center)\n2. Search for: **GDShell**\n3. Open **GDShell**\n4. Click **Download**\n5. Click **Install**\n6. Go to `Project \u003e Project Settings \u003e Plugins` and check the `Enable` checkbox for GDShell\n\n\n### Installation via Git\n1. **Clone** or **download** the [latest release](https://github.com/Kubulambula/Godot-GDShell/releases/latest)\n2. Copy the `gdshell/` folder into your project's `res://addons/` folder.\n3. Go to `Project \u003e Project Settings \u003e Plugins` and check the `Enable` checkbox for GDShell\n\n\nYou can also checkout the Godot's [Installing plugins](https://docs.godotengine.org/en/latest/tutorials/plugins/editor/installing_plugins.html) docs\n\n\n## 📚 Documentation \u0026 Tutorials\nSee the **[Docs](addons/gdshell/docs/en/docs.md)** page.\n\nFor command examples, you can checkout the **[default commands](/addons/gdshell/commands/default_commands)**.\n\n\n## 👥 Contributing\nAll contributions are very welcome, so feel free to make [issues](https://github.com/Kubulambula/Godot-GDShell/issues), [proposals](https://github.com/Kubulambula/Godot-GDShell/issues/proposal) and [pull requests](https://github.com/Kubulambula/Godot-GDShell/pulls). \n\n\n## ❤️ License (It's free, baby!)\nGDShell is available under the **MIT license**.\nSee [`LICENSE.md`](LICENSE.md).\n\nGDShell logo is available under the **Free Art License 1.3**. See [`LOGO_LICENSE.md`](addons/gdshell/LOGO_LICENSE.md)\n\n\n## ❔ FAQ\n**- Can I use GDShell in my project?**\n\nYes! You can use GDShell in any kind of project - free or commercial.\u003cbr\u003e\nThe ONLY condition is to credit the GDShell creators in your project according to MIT license. See [`LICENSE.md`](LICENSE.md)\n\n---\n\n**- Can I use GDShell in a non-game project?**\u003cbr\u003e\n\nYes you can! Debug consoles can come in handy with any kind of project.\u003cbr\u003e\nThe GDShell usage is consistent between game and non-game projects.\n\n---\n\n**- Why is GDShell made with GDScript and not C#?**\u003cbr\u003e\n\nGDShell is made with GDScript so that both Standard and Mono versions of Godot can easily run GDShell.\n\n---\n\n**- Can I use C# with GDShell?**\u003cbr\u003e\n\nNot yet, but a C# wrapper is on it's way. If this is something that interests you, consider contributing to GDShell.\u003cbr\u003e\nUntil then, you can use [Cross language scripting](https://docs.godotengine.org/en/latest/tutorials/scripting/cross_language_scripting.html) as a workaround.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubulambula%2Fgodot-gdshell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkubulambula%2Fgodot-gdshell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubulambula%2Fgodot-gdshell/lists"}