Skip to content

A godot plugin for interfacing with pycolytics, a tiny event logging webservice.

License

Notifications You must be signed in to change notification settings

KerekesDavid/pycolytics-godot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Pycolytics Godot Client - Event Analytics

A Godot plugin for interfacing with pycolytics, a tiny open source event logging webservice. It provides anonymized event logging with as little as a single function call.

I made pycolytics so I could collect anonymized game statistics with the least amount of hassle possible. No quotas, no monthly fees, no bloated software, no megacorporation spying on my user's data.

Requires Godot 4.2 or higher.

Getting Started

  • Install this plugin from the asset library, or by copying the addons folder from this repository into your project root folder.
  • Enable the plugin (pycolytics-godot) under ProjectSettings/Plugins.
  • Install pycolytics on a local machine, or a remote server.
  • Use the PycoLog autoload, for example PycoLog.log_event(...) to log your events.

For more examples, see examples/example.gd, or open up example.tscn in Godot!

The simplest way to log an event.

Key Features

  • Event properties are resources: You can export them, reuse them, set them from the editor!
  • Automatic batched submission: Minimal performance impact.
  • Autoload included: For convinient logging.
  • Built-in startup and shutdown events. With customizable callbacks.
  • Automatic user-id and session-id generation.

Configuration for Production

To log to a server on the internet, set addons/pycolytics/server_url and addons/pycolytics/api_key under project settings.

Contibuting

Open an issue if you wish to contribute, or buy me a coffee if you find my work useful.

Buy Me a Coffee at ko-fi.com

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

A godot plugin for interfacing with pycolytics, a tiny event logging webservice.

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published