boyquotes / godot-wakatime

Godot plugin for metrics, insights, and time tracking automatically generated from your Godot usage. https://wakatime.com

godot-wakatime

Godot plugin for metrics, insights, and time tracking automatically generated from your Godot usage.

Dependencies

As there is no easy way to unzip files in GDScript, this plugin uses Ouch! to decompress Wakatime CLI right from the Github page.

But there is no need to manually download it as the Godot Wakatime plugin automatically downloads, uses and deletes as needed

Installation

The easiest and fastest way is to install directly from Godot's AssetLib

1. Access Godot's AssetLib inside the engine (F4 default keybind)
2. Search for godot-wakatime and click on install button

Or, you can manually install the latest version following the next steps

1. Download and extract latest zip file from releases.
2. Copy or move the wakatime directory from the extracted zip and put into your project's addons directory. Create the addons directory at the root of your project if you don't have one.

Activation

• Activate godot-wakatime on Plugins tab at menu Project -> Project Settings -> Plugins.
• Enter your Wakatime API Key on opened prompt.
• Use Godot script editor for a while and check on https://wakatime.com/api/v1/users/current or https://wakatime.com/dashboard to see your coding activity :)

Tracking GDScript and GDNative files

For now, pygments doesn't support GDScript by default. The workaround is to use a custom rule to force any files ending with .gd to be categorized as GDScript. (https://wakatime.com/settings/rules)

Configuring

Some settings are available in the editor bottom panel as soon as the plugin is active

Wakatime settings and plugin settings (like Python binary path) are stored in the file at <GODOT_PROJECT>/addons/wakatime/settings.cfg.

Supported Godot versions

Tested with Godot 3.3.X, 3.4.X and 3.5.X on Windows and Linux.

It has Mac OS support as well, but has not yet been tested.