feat: add quiver analytics

.github/workflows/release-packaging.yml

@@ -5,7 +5,7 @@ on:
   # Ensure the build works on main
   push:
     branches: [main]
-    tags:
+    tags: ['*']
   # Ensure the build works on each pull request
   pull_request:
 
@@ -44,6 +44,9 @@ jobs:
       - name: Load dotenv
         run: just ci-load-dotenv
 
+      - name: Setup Quiver
+        run: just quiver ${{ secrets.QUIVER_AUTH_TOKEN }}
+
       - name: Cache Godot
         uses: actions/cache@v4
         with:
@@ -113,6 +116,9 @@ jobs:
       - name: Load dotenv
         run: just ci-load-dotenv
 
+      - name: Setup Quiver
+        run: just quiver ${{ secrets.QUIVER_AUTH_TOKEN }}
+
       - name: Download artifact
         uses: dawidd6/action-download-artifact@v3
         with:
@@ -125,4 +131,4 @@ jobs:
         run: just ci-publish
         env:
           BUTLER_API_KEY: ${{ secrets.BUTLER_API_KEY }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.PAT }}

.godot/global_script_class_cache.cfg

@@ -35,6 +35,12 @@ list=Array[Dictionary]([{
 "language": &"GDScript",
 "path": "res://addons/logger/config.gd"
 }, {
+"base": &"CanvasLayer",
+"class": &"ConsentDialog",
+"icon": "",
+"language": &"GDScript",
+"path": "res://addons/quiver_analytics/consent_dialog.gd"
+}, {
 "base": &"Observable",
 "class": &"DarkRoad",
 "icon": "",

CHANGELOG.md

@@ -4,6 +4,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ## [Unreleased]
 ### Added
 - Add custom bootsplash ([#25](https://github.com/MechanicalFlower/HazyRoad/pull/25))
+- Add Quiver Analtics ([#28](https://github.com/MechanicalFlower/HazyRoad/pull/28))
 ### Changed
 ### Deprecated
 ### Removed

Justfile

@@ -196,6 +196,10 @@ butler *ARGS: check-butler
     echo "Update version in the project.godot"
     sed -i "s,config/version=.*$,config/version=\"{{ game_version }}\",g" ./project.godot
 
+@quiver $QUIVER_AUTH_TOKEN:
+    echo "Add Quiver authentication token in the project.godot"
+    sed -i "s,REPLACE_ME,"$QUIVER_AUTH_TOKEN",g" ./project.godot
+
 [private]
 pre-export: clean-addons makedirs bump-version install-addons import-resources
 

plug.gd

@@ -30,6 +30,13 @@ func _plugging():
 			"include": ["addons/kanban_tasks"]
 		}
 	)
+	plug(
+		"quiver-dev/quiver-analytics-godot-plugin",
+		{
+			"commit": "7430a4533911701845c3f1f59945543d63962263",
+			"renovate-branch": "main",
+		}
+	)
 
 	# Patched version
 	plug(

project.godot

@@ -36,11 +36,12 @@ GlobalSignal="*res://scripts/framework/global_signal.gd"
 GameState="*res://scripts/framework/game_state.gd"
 MenuTemplateManager="*res://addons/EasyMenus/Nodes/menu_template_manager.tscn"
 Log="*res://addons/logger/logger.gd"
+Analytics="*res://addons/quiver_analytics/analytics.tscn"
 
 [custom_options]
 
-build_info/commit="a9602d15680d01d0406f54ed85a3d02b4ab69d4f"
-build_info/date="2024/02/10"
+build_info/commit="a340227663d7250445ca4ac8b0f59f41b64e9a03"
+build_info/date="2024/03/22"
 
 [display]
 
@@ -53,7 +54,7 @@ export/convert_text_resources_to_binary=false
 
 [editor_plugins]
 
-enabled=PackedStringArray("res://addons/debug_menu/plugin.cfg", "res://addons/dialogue_label/plugin.cfg", "res://addons/export-build-info/plugin.cfg", "res://addons/kanban_tasks/plugin.cfg", "res://addons/logger/plugin.cfg", "res://addons/proton_scatter/plugin.cfg")
+enabled=PackedStringArray("res://addons/debug_menu/plugin.cfg", "res://addons/dialogue_label/plugin.cfg", "res://addons/export-build-info/plugin.cfg", "res://addons/kanban_tasks/plugin.cfg", "res://addons/logger/plugin.cfg", "res://addons/proton_scatter/plugin.cfg", "res://addons/quiver_analytics/plugin.cfg")
 
 [filesystem]
 
@@ -146,6 +147,10 @@ locale/translations=PackedStringArray("res://assets/i18n/locale.fr.translation",
 3d_physics/layer_2="Player"
 3d_physics/layer_3="Floor"
 
+[quiver]
+
+general/auth_token="REPLACE_ME"
+
 [rendering]
 
 occlusion_culling/bvh_build_quality=0

scripts/player/inventory.gd

@@ -22,6 +22,13 @@ func _on_Accessory_current_item_updated(new_current_item: StringName):
 			fuse.show()
 		&"tire":
 			tire.show()
+	await Analytics.add_event(
+		"current_item_updated",
+		{
+			"game_version": ProjectSettings.get("application/config/version"),
+			"item_name": new_current_item
+		}
+	)
 
 
 func hide_all():

scripts/scenario.gd

@@ -22,13 +22,19 @@ func _ready():
 
 func _on_Scenario_animation_finished(anim_name: StringName):
 	if anim_name == &"intro":
+		await Analytics.add_event(
+			"Start the game", {"game_version": ProjectSettings.get("application/config/version")}
+		)
 		camera_car.get_parent().get_node("Engine").stop()
 
 		# Transition that launch the playable game
 		camera_car.set_current(false)
 		player.set_process_mode(PROCESS_MODE_INHERIT)
 
 	elif anim_name == &"outro":
+		await Analytics.add_event(
+			"Finish the game", {"game_version": ProjectSettings.get("application/config/version")}
+		)
 		await Fade.fade_out(1, Color.BLACK, "Diamond", false, false).finished
 		get_tree().change_scene_to_file("res://scenes/menu.tscn")