Skip to content

Installation & Setup

Tom B. edited this page Mar 25, 2025 · 6 revisions

Installation

Godot will print several errors upon importing the plugin and is expected! GoLogger simply requires an autoload, which isn't added until the plugin is enabled.

  • Importing the plugin: Only import the "addons" into your project's root directory. The folder structure should look like res://addons/GoLogger.

  • Enable the plugin: Navigate to Project > Project Settings > Plugins, and check "GoLogger" in the list of available plugins to enable it.
    If errors persist, ensure "GoLogger.tscn" was added properly as an autoload and then restart Godot.
    enable_plugin

Setup

Installing the plugin will set you up with the logging framework automatically. The default settings will create folders in your user://GoLogger/ directory for two categories(game and player) you can create entries for directly. The plugin will overwrite the oldest entries when it hits the default limit which can all be changed in the dock panel.
Default Settings

Once installed, you only need to create log entries in your code(see creating log entries) in order to actually record game events as they occur in your game.

It’s recommended to add Log.stop_session() before calling get_tree().quit() to help differentiate between normal exits, crashes, or forced closures, since the log file will end with a "Stopped session" entry.

Clone this wiki locally