Add additional default properties to help filter export and debug builds.

Author: agmathew

README.md

@@ -71,7 +71,18 @@ If you'd like to use your own UI and manually handle consent management, you can
 ### Customizing consent UI
 By default, the built-in consent UI will use whatever UI theme that has been set for your project. You can modify this by changing the properties of the ConsentDialog found in `/addons/quiver_analytics/consent_dialog.tscn`.
 
-### Advanced Properties
+### Default Properties
+
+The plugin will automatically add the following default properties to all events:
+	
+* "$platform": The platform the game is running on. Can be either "Windows", "macOS", "Linux", "FreeBSD", "NetBSD", "OpenBSD", "BSD", "Android", "iOS", or "Web". Custom builds may yield other values.
+* "$session_id": The unique session identifier for this event. A session starts when the game launches and ends when the game is exited.
+* "$debug": Whether this event came from a debug build of the game. Both editor and debug versions of export templates will set debug to true. You can use this to filter out events created during development.
+* "$export_template": Whether this event came from a build using an export template, whether it is debug or release.
+
+All default property names start with a "$".
+
+### Advanced Settings
 If you turn on Advanced Settings for Project Settings -> Quiver -> Analytics, you'll find the following properties:
 
 * "Config File Path": where the config file is stored, defaults to "user://analytics.cfg".

addons/quiver_analytics/analytics.gd

@@ -178,6 +178,8 @@ func add_event(name: String, properties: Dictionary = {}) -> void:
 	# Auto-add the platform
 	properties["$platform"] = OS.get_name()
 	properties["$session_id"] = session_id
+	properties["$debug"] = OS.is_debug_build()
+	properties["$export_template"] = OS.has_feature("template")
 
 	# Add the request to the queue and process the queue
 	var request := {

addons/quiver_analytics/plugin.cfg

@@ -3,5 +3,5 @@
 name="Quiver Analytics"
 description="Get key insights into how players are interacting with your game while still respecting their privacy."
 author="Quiver"
-version="0.2"
+version="0.3"
 script="plugin.gd"