Awesome Debug Log

Display values with titles into a panel in-game

Features

• Console log But in game! No more need to minimize the game screen
• Order your logs with Tabs
• Easy keyboard based navigation

Installation

From The AssetLib

• Open the AssetLib tab in your project and search for Awesome Debug Log
• Open it and select install, from there follow the instructions
• Finally, go to Project/Project Settings/Plugins and activate awesome-debug-log

Manually

• Go to Releases and download the Source code, inside will be a folder called

  awesome-debug-log (it may be nested)

  • UPDATE THIS WHEN THE ADDON BEEN GREENLITED

You can also get it from the Godot Asset Library

• Go to the root of your project and open the addons folder (create it if there's none)
• Finally, go to Project/Project Settings/Plugins and activate awesome-debug-log

Usage

With the addon active, an Autoload called Debug will be added, then call Debug.callable with any of the below functions, the most important is:

log

Call Debug.log() anywhere in your scripts to start displaying your values.

Creates a new line in the selected tab, if there's already a line with the same title it will update that instead unless specified.

In this case, to display the frames per second we call the log function with "FPS" as the title and a string that divides delta by 1.0 as the value.
We don´t care about the other values.

func _process(delta):
    Debug.log("FPS", "%.2f" % (1.0 / delta))

Then it will show like so:

add_tab

Adds a new tab, if there's already a tab with the same name, it will issue a warning and return

After that, you can log your values in that tab by referencing the name like so:

func _ready():
    Debug.add_tab("New Tab")
 Debug.log("Vector right", Vector2.RIGHT, "New Tab")

remove_tab

You can similarly delete tabs with the same name, if there's no tabs or there's no tab with that name, it will print an error and return

Modifying already existing tabs

This is a tandem of 3 functions and a general function for changing properties of an existing tab. All of them returns true or false if they succeeded or failed on updating their property

update_tab

With the name of the tab, you can change all its properties. Use it when you want to change 2 or more properties at once

If you want to change only one of those properties, use the following:

update_tab_name

Changes the name of a tab with a new one

update_tab_position

Changes the position of a tab to the one selected, the value is clamped between 0 and the maximum number of caps (so don't worry about it)

update_tab_log_cap

Changes the cap of the logs from tab

Utility functions

There are a bunch of utility functions inside Debug.gd and they are (mostly) documented or self explanatory, you can see them by using the auto docs from Godot themselves

Navigating between tabs

Apart from clicking on them like normal, you can use the Function Keys to travel between the tabs and toggle the panel altogether.

F1

Hides/Shows the panel

F2

Selects the previous tab

F3

Selects the next tab

Changing the hotkeys

Right now it checks for the physical keycode of the input received, this is so because i cant create a input event for you to easily modify.

So if you want different hotkeys you´ll have to modify it to listen to whatever you want

Heres the whole input function in Debug.gd

func _input(event: InputEvent):

    ## Replace it with whatever you want

    # I used Keycode because i don´t see how to add a custom action to the input map

    # Well, more like i don´t WANT to make a way, so I used physical keycode

    if event is InputEventKey and event.is_released():

        match event.keycode:

            # Toggle the whole screen

            KEY_F1:

                visible = !visible

  

            # Switch between tabs by pressing F1 and F2

            KEY_F2:

                tabs.select_previous_available()

            KEY_F3:

                tabs.select_next_available()

I just called tabs.select_previous_available/next_available
And toggle the visibility using this line:visible = !visible