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

Thanks to

As this addon is influenced by the godot console addon check it out as well.

• https://github.com/jitspoe/godot-console