Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kubulambula/godot-gdshell
Light-weight, powerful, customizable and modular in-game console for Godot 4.
https://github.com/kubulambula/godot-gdshell
console gdscript gdshell godot godot-addon godot-console godot-engine godot4 godotengine shell
Last synced: about 1 month ago
JSON representation
Light-weight, powerful, customizable and modular in-game console for Godot 4.
- Host: GitHub
- URL: https://github.com/kubulambula/godot-gdshell
- Owner: Kubulambula
- License: mit
- Created: 2022-10-31T09:40:23.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-27T12:40:47.000Z (about 1 year ago)
- Last Synced: 2024-10-10T11:04:37.219Z (about 1 month ago)
- Topics: console, gdscript, gdshell, godot, godot-addon, godot-console, godot-engine, godot4, godotengine, shell
- Language: GDScript
- Homepage: https://godotengine.org/asset-library/asset/1526
- Size: 1.15 MB
- Stars: 212
- Watchers: 6
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# GDShell
#### ⚠️ This plugin is still in early development
Simple, linux-like, all-in-one, in-game console for development, debugging, cheats and/or any other interaction with your game.
## 📦 Out of the box
GDShell works right away after installation with no need for a complex setup.
Add you own commands, don't reinvent the wheel and get right back to the important stuff that makes your game fun!
## 🏄 Easy to use
Forget creating commands from [`Callable`](https://docs.godotengine.org/en/latest/classes/class_callable.html)s, with messy object and method relations.
Every command is it's own script, resulting in better code organization and project structure by design.
**Just create a script, place it in a command folder and you're good to go!**
```gdscript
extends GDShellCommand
# res://addons/gdshell/commands/hello.gd
func _main(argv, data):
output("Hello World!")
return {}
```
## 💪 Simple, yet powerful
Don't let the ease of use fool you. GDShell can be used even for more complex tasks like:
* sequential and conditional command chaining
`alias cls clear && echo "Success" || echo "Failed"; echo ":("`
* executing commands in background
`wait_for_godot& ; think_about_your_game_project`
* command result passing
`gdfetch -s | echo`
The 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.
## 🧩 Modular and customizable
* Do you dislike the default UI?
* Do you wish to have a new operator?
* Do you want to have bunch of buttons that call the commands directly without the console interface?
Every part of GDShell can be modified, extended or replaced as long as you implement the necessary methods.
Nearly anything your heart desires can be done!
## 🧪 Installation
### Installation via [AssetLib](https://godotengine.org/asset-library/asset/1526)
1. Open AssetLib in your project (AssetLib button in the top center)
2. Search for: **GDShell**
3. Open **GDShell**
4. Click **Download**
5. Click **Install**
6. Go to `Project > Project Settings > Plugins` and check the `Enable` checkbox for GDShell
### Installation via Git
1. **Clone** or **download** the [latest release](https://github.com/Kubulambula/Godot-GDShell/releases/latest)
2. Copy the `gdshell/` folder into your project's `res://addons/` folder.
3. Go to `Project > Project Settings > Plugins` and check the `Enable` checkbox for GDShell
You can also checkout the Godot's [Installing plugins](https://docs.godotengine.org/en/latest/tutorials/plugins/editor/installing_plugins.html) docs
## 📚 Documentation & Tutorials
See the **[Docs](addons/gdshell/docs/en/docs.md)** page.
For command examples, you can checkout the **[default commands](/addons/gdshell/commands/default_commands)**.
## 👥 Contributing
All 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).
## ❤️ License (It's free, baby!)
GDShell is available under the **MIT license**.
See [`LICENSE.md`](LICENSE.md).
GDShell logo is available under the **Free Art License 1.3**. See [`LOGO_LICENSE.md`](addons/gdshell/LOGO_LICENSE.md)
## ❔ FAQ
**- Can I use GDShell in my project?**
Yes! You can use GDShell in any kind of project - free or commercial.
The ONLY condition is to credit the GDShell creators in your project according to MIT license. See [`LICENSE.md`](LICENSE.md)
---
**- Can I use GDShell in a non-game project?**
Yes you can! Debug consoles can come in handy with any kind of project.
The GDShell usage is consistent between game and non-game projects.
---
**- Why is GDShell made with GDScript and not C#?**
GDShell is made with GDScript so that both Standard and Mono versions of Godot can easily run GDShell.
---
**- Can I use C# with GDShell?**
Not yet, but a C# wrapper is on it's way. If this is something that interests you, consider contributing to GDShell.
Until then, you can use [Cross language scripting](https://docs.godotengine.org/en/latest/tutorials/scripting/cross_language_scripting.html) as a workaround.