Godot Game Console

This Godot addon will add a game console to your game. This console can be used to run commands from within your game.

To learn how to add and remove custom commands please checkout the example script or check the quickstart secion down below.

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.

⚠️ If you install the plugin and it is not active it is possible that godot will throw errors that the identifier "Console" cannot be found.
To fix this issues you just need to activate the plugin, this error is a result of an dependency to that global instance, which is not present after install throwing an error on Godot automatic code check.

Error listed because Console is not loaded just yet, this is normal

Quickstart

Register a command

Console.register_custom_command("reload", _reload, [], "Reload current scene")

func _reload() -> String:
	get_tree().reload_current_scene()
	return "reloaded scene"

This will add an command where the arguments are provided as Strings, your method accepting those arguments will get strings as well
you will need to convert to the correct data type all by yourself.

Register a strong argument command

Console.register_custom_strong_command("spawn_entity",
                                       _spawn_entity,
                                       [CommandArgument.new(CommandArgument.Type.INT, "X Position", "The x position on screen for the entity"),
                                        CommandArgument.new(CommandArgument.Type.INT, "y Position", "The y position on screen for the entity"),
                                        CommandArgument.new(CommandArgument.Type.FLOAT, "time to life", "The time the entity should life in seconds")
                                       ],
                                       "Spawn an example entity at a global position",
                                       "",
                                       ["spawn_entity 200 300 4"]
                                      )

func _spawn_entity(pos_x: int, pos_y: int, ttl: float) -> String:
    pass

This will add a new argument but the argument types are defined, this will parse the input data automatically making it easier to use in your method. If a wrong type was provided to any
of the arguments an error will be thrown preventing the method execution.

Unregister a command

Console.remove_command("reload")

Other important Options

## Change the console settings
## There are more options 
Console.update_console_settings(func(settings: ConsoleSettings):
	## Set key to toggle console
	settings.open_console_key = KEY_F12

	## Pause game tree if console does open up
	settings.pause_game_if_console_opened = true
)

## Hide console
Console.hide_console()

## Show console
Console.show_console()

## Disable console completely, can be used to remove it on release builds
Console.disable() 

## Enable a disabled console
Console.enable() 

Navigation

If inside the command input field use the arrow up and down key to navigate the history, if any. If there is a command which can be autocompleted to
it will be shown below the input field, to select the suggestion simply click "tab", to traverse the list backward use "shift + tab".

ℹ️ You can change the button to navigate the autocomplete entries via the console settings.

To send a command to the console, simple press enter. If a command is written in red no matching command was found, if it is written in green you are good to go,
keep in mind that this will not check if all the arguments are provided correctly.

Example Project

For further instructions on how to use this addon, checkout the example project. There are some custom commands in the example and some settings changed,
this should help you to get started.

Built in commands

This is a list with build in commands and there purpose

Special Thanks to

jitspoe because his addon did influenced the creation for my interpretation of it. So check it our as well, it might more more suitable for you.

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