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 Callables, 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!

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

Open AssetLib in your project (AssetLib button in the top center)
Search for: GDShell
Open GDShell
Click Download
Click Install
Go to Project > Project Settings > Plugins and check the Enable checkbox for GDShell

Installation via Git

Clone or download the latest release
Copy the gdshell/ folder into your project's res://addons/ folder.
Go to Project > Project Settings > Plugins and check the Enable checkbox for GDShell

You can also checkout the Godot's Installing plugins docs

📚 Documentation & Tutorials

See the Docs page.

For command examples, you can checkout the default commands.

👥 Contributing

All contributions are very welcome, so feel free to make issues, proposals and pull requests.

❤️ License (It's free, baby!)

GDShell is available under the MIT license. See LICENSE.md.

GDShell logo is available under the Free Art License 1.3. See 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

- 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 as a workaround.

geowarin / Godot-GDShell