Game Console
An asset by Xanatos
Install Asset
Install via Godot
To maintain one source of truth, Godot Asset Library is just a mirror of the old asset library so you can download directly on Godot via the integrated asset library browser
Quick Information
Game Console
Addon to add a console to your game, this will allow you to run commands after opening the console.To add a command simply use Console.register_custom_command("reload", _reload, [], "Reload current scene")where reload is a function without parameters.If you want to parse parameter useConsole.register_custom_command("count_up", _count_up, ["(int) amount to count up"], "Increase the counter", "Command will increase a local counter", ["count_up 1", "count_up 3"])This adds a command with a single argument, a short and long description and some examples.To unregister it run, this should be done if a node does leave the scene tree.Console.remove_command("reload")Other interessting methodsConsole.set_console_key(KEY_F12) -> Set toggle keyConsole.hide_console() -> Hide consoleConsole.show_console() -> Show consoleConsole.should_pause_on_open() -> Pause game tree if console does open upConsole.disable() -> Disable console completely, can be used to remove it on release buildsConsole.enable() -> Enable a disabled console
Supported Engine Version
4.3
Version String
0.3.0
License Version
MIT
Support Level
community
Modified Date
1 day ago
Git URL
Issue URL
Godot Game Console
This Godot addon will add a game console to your game. This console can be used to run commands on your game.
To learn how to add and remove custom commands please checkout the example script.
I do know there is a addon like this already in development, check it out at the end of this readme. I still wanted to create my own interpretation of this used in games I created. But as I already developed it I decided to make it public and give something back to the Godot developer community.
How to install
To install the addon download the source files and put the "addons" folder on a root level to your project. After that enable the plugin via the Godot plugin menu.
Checkout this part of the Godot documentation
Quickstart
Register a command
Console.register_custom_command("reload", _reload, [], "Reload current scene")
func _reload() -> String:
get_tree().reload_current_scene()
return "reloaded scene"
Unregister a command
Console.remove_command("reload")
Other important Options
## Set toggle key
Console.set_console_key(KEY_F12)
## Hide console
Console.hide_console()
## Show console
Console.show_console()
## Pause game tree if console does open up
Console.should_pause_on_open()
## Disable console completely, can be used to remove it on release builds
Console.disable()
## Enable a disabled console
Console.enable()
Example Project
I added a test and example project to this addon so you can check out the console in action. The example is not much but does show the usage in a really basic manner.
Built in commands
This is a list with build in commands and there purpose
| Name | Description | example |
|---|---|---|
| list_commands | This will list all the built in and custom commands currently available | list_commands |
| clear | Clear the output of the console window | clear |
| man | Get a more detailed description of a command, also including examples if any. Requires the command name as a argument | man clear |
| pause | Pause the game by pausing the root tree | pause |
| unpause | unpause the game by unpausing the root | unpause |
| quit | Close the game, does not work on a web build. | quit |
Thanks to
As this addon is influenced by the godot console addon check it out as well.
Addon to add a console to your game, this will allow you to run commands after opening the console.
To add a command simply use
Console.register_custom_command("reload", _reload, [], "Reload current scene")
where reload is a function without parameters.
If you want to parse parameter use
Console.register_custom_command("count_up", _count_up, ["(int) amount to count up"], "Increase the counter", "Command will increase a local counter", ["count_up 1", "count_up 3"])
This adds a command with a single argument, a short and long description and some examples.
To unregister it run, this should be done if a node does leave the scene tree.
Console.remove_command("reload")
Other interessting methods
Console.set_console_key(KEY_F12) -> Set toggle key
Console.hide_console() -> Hide console
Console.show_console() -> Show console
Console.should_pause_on_open() -> Pause game tree if console does open up
Console.disable() -> Disable console completely, can be used to remove it on release builds
Console.enable() -> Enable a disabled console
Reviews
Quick Information
Game Console
Addon to add a console to your game, this will allow you to run commands after opening the console.To add a command simply use Console.register_custom_command("reload", _reload, [], "Reload current scene")where reload is a function without parameters.If you want to parse parameter useConsole.register_custom_command("count_up", _count_up, ["(int) amount to count up"], "Increase the counter", "Command will increase a local counter", ["count_up 1", "count_up 3"])This adds a command with a single argument, a short and long description and some examples.To unregister it run, this should be done if a node does leave the scene tree.Console.remove_command("reload")Other interessting methodsConsole.set_console_key(KEY_F12) -> Set toggle keyConsole.hide_console() -> Hide consoleConsole.show_console() -> Show consoleConsole.should_pause_on_open() -> Pause game tree if console does open upConsole.disable() -> Disable console completely, can be used to remove it on release buildsConsole.enable() -> Enable a disabled console
Supported Engine Version
4.3
Version String
0.3.0
License Version
MIT
Support Level
community
Modified Date
1 day ago
Git URL
Issue URL