Merge pull request #118 from TaloDev/develop

Release 0.29.0

Author: tudddorrr

.github/hooks/pre-commit

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+cd addons/talo
+
+PLUGIN_CFG="plugin.cfg"
+TALO_CLIENT_GD="talo_client.gd"
+
+if [ ! -f "$PLUGIN_CFG" ]; then
+    echo "Error: $PLUGIN_CFG not found."
+    exit 1
+fi
+
+if [ ! -f "$TALO_CLIENT_GD" ]; then
+    echo "Error: $TALO_CLIENT_GD not found."
+    exit 1
+fi
+
+# `grep -E '^version='` finds the line starting with 'version='.
+# `sed -E 's/version="([^"]+)"/\1/'` extracts the version string between quotes.
+NEW_VERSION=$(grep -E '^version=' "$PLUGIN_CFG" | sed -E 's/version="([^"]+)"/\1/')
+
+if [ -z "$NEW_VERSION" ]; then
+    echo "Error: could not extract version from $PLUGIN_CFG."
+    exit 1
+fi
+
+echo "Detected new version: $NEW_VERSION"
+
+# `sed -i.bak` edits the file in place and creates a backup with .bak extension.
+# the regex `(const TALO_CLIENT_VERSION = \")[^\"]+(\")` captures the parts before and after the version.
+# `\1$NEW_VERSION\2` reconstructs the line with the new version inserted.
+sed -i.bak -E "s/(const TALO_CLIENT_VERSION = \")[^\"]+(\")/\1$NEW_VERSION\2/" "$TALO_CLIENT_GD"
+
+if [ $? -ne 0 ]; then
+    echo "Error: failed to update version in $TALO_CLIENT_GD."
+    rm -f "$TALO_CLIENT_GD.bak" # Clean up the backup file if an error occurred
+    exit 1
+fi
+
+rm -f "$TALO_CLIENT_GD.bak"
+
+git add "$TALO_CLIENT_GD"
+
+echo "Successfully updated $TALO_CLIENT_GD with version $NEW_VERSION."
+echo "Pre-commit hook finished."
+
+exit 0

README.md

@@ -33,8 +33,9 @@ channels](https://trytalo.com/channels): Send real-time messages between players
 - 🎮 Playground: a text-based playground allowing you to test identifying, events, stats and leaderboards.
 - 🕹️ Leaderboards: a basic leaderboard UI, allowing you to add and update entries.
 - 💾 Multi-scene saves: a small game showing how to persist save data across multiple scenes.
-- 💾 Stateful buttons: a simple demo showing how to save and load game state.
+- 💾 Persistent buttons: a simple demo showing how to save and load game state.
 - 💬 Chat: showing how to send messages between channels in a chat room.
+- 🤝 Channel storage: showing how to store data that can be accessed by other players using channels.
 
 ## Documentation
 

addons/talo/apis/channels_api.gd

@@ -17,10 +17,17 @@ signal channel_ownership_transferred(channel: TaloChannel, new_owner_player_alia
 signal channel_deleted(channel: TaloChannel)
 ## Emitted when a channel is updated.
 signal channel_updated(channel: TaloChannel, changed_properties: Array[String])
+## Emitted when channel storage props are updated or deleted.
+signal channel_storage_props_updated(channel: TaloChannel, upserted_props: Array[TaloChannelStorageProp], deleted_props: Array[TaloChannelStorageProp])
+## Emitted when one or more storage props were not successfully set.
+signal channel_storage_props_failed_to_set(channel: TaloChannel, failed_props: Array[TaloChannelStoragePropError])
+
+var _storage_manager := TaloChannelStorageManager.new()
 
 func _ready() -> void:
 	await Talo.init_completed
 	Talo.socket.message_received.connect(_on_message_received)
+	channel_storage_props_updated.connect(_storage_manager.on_props_updated)
 
 func _on_message_received(res: String, data: Dictionary) -> void:
 	match res:
@@ -31,13 +38,19 @@ func _on_message_received(res: String, data: Dictionary) -> void:
 		"v1.channels.player-left":
 			player_left.emit(TaloChannel.new(data.channel), TaloPlayerAlias.new(data.playerAlias), data.meta.reason)
 		"v1.channels.ownership-transferred":
-			player_left.emit(TaloChannel.new(data.channel), TaloPlayerAlias.new(data.newOwner))
+			channel_ownership_transferred.emit(TaloChannel.new(data.channel), TaloPlayerAlias.new(data.newOwner))
 		"v1.channels.deleted":
 			channel_deleted.emit(TaloChannel.new(data.channel))
 		"v1.channels.updated":
 			var changed_properties: Array[String] = []
 			changed_properties.assign(data.changedProperties)
 			channel_updated.emit(TaloChannel.new(data.channel), changed_properties)
+		"v1.channels.storage.updated":
+			var upserted_props: Array[TaloChannelStorageProp] = []
+			upserted_props.assign(data.upsertedProps.map(func (prop: Dictionary): return TaloChannelStorageProp.new(prop)))
+			var deleted_props: Array[TaloChannelStorageProp] = []
+			deleted_props.assign(data.deletedProps.map(func (prop: Dictionary): return TaloChannelStorageProp.new(prop)))
+			channel_storage_props_updated.emit(TaloChannel.new(data.channel), upserted_props, deleted_props)
 
 ## Get a channel by its ID.
 func find(channel_id: int) -> TaloChannel:
@@ -142,7 +155,7 @@ func leave(channel_id: int) -> void:
 	await client.make_request(HTTPClient.METHOD_POST, "/%s/leave" % channel_id)
 
 ## Update a channel. This will only work if the current player is the owner of the channel.
-func update(channel_id: int, name: String = "", new_owner_alias_id: int = -1, props: Dictionary = {}) -> TaloChannel:
+func update(channel_id: int, name: String = "", new_owner_alias_id: int = -1, props: Dictionary[String, Variant] = {}) -> TaloChannel:
 	if Talo.identity_check() != OK:
 		return
 
@@ -152,7 +165,7 @@ func update(channel_id: int, name: String = "", new_owner_alias_id: int = -1, pr
 	if new_owner_alias_id != -1:
 		data.ownerAliasId = new_owner_alias_id
 	if props.size() > 0:
-		data.props = props
+		data.props = TaloPropUtils.dictionary_to_array(props)
 
 	var res := await client.make_request(HTTPClient.METHOD_PUT, "/%s" % channel_id, data)
 
@@ -216,6 +229,43 @@ func get_members(channel_id: int) -> Array[TaloPlayerAlias]:
 		_:
 			return []
 
+func get_storage_prop(channel_id: int, prop_key: String, bust_cache: bool = false) -> TaloChannelStorageProp:
+	if Talo.identity_check() != OK:
+		return null
+
+	if not bust_cache:
+		return await _storage_manager.get_prop(channel_id, prop_key)
+
+	var res := await client.make_request(HTTPClient.METHOD_GET, "/%s/storage?propKey=%s" % [channel_id, prop_key])
+
+	match res.status:
+		200:
+			if not res.body.prop:
+				return null
+
+			var prop := TaloChannelStorageProp.new(res.body.prop)
+			_storage_manager.upsert_prop(channel_id, prop)
+			return prop
+		_:
+			return null
+
+func set_storage_props(channel_id: int, props: Dictionary[String, Variant]) -> void:
+	if Talo.identity_check() != OK:
+		return
+
+	var res := await client.make_request(HTTPClient.METHOD_PUT, "/%s/storage" % channel_id, {
+		props = TaloPropUtils.dictionary_to_array(props)
+	})
+
+	match res.status:
+		200:
+			if res.body.failedProps.size() > 0:
+				var failed_props: Array[TaloChannelStoragePropError] = []
+				failed_props.assign(res.body.failedProps.map(
+					func (prop: Dictionary): return TaloChannelStoragePropError.new(prop.key, prop.error))
+				)
+				channel_storage_props_failed_to_set.emit(TaloChannel.new(res.body.channel), failed_props)
+
 class ChannelPage:
 	var channels: Array[TaloChannel]
 	var count: int
@@ -240,7 +290,7 @@ class GetSubscribedChannelsOptions:
 class CreateChannelOptions:
 	var name: String = ""
 	var auto_cleanup: bool = false
-	var props: Dictionary = {}
+	var props: Dictionary[String, String] = {}
 	var private: bool = false
 	var temporary_membership: bool = false
 

addons/talo/apis/events_api.gd

@@ -32,20 +32,16 @@ func _has_errors(errors: Array) -> bool:
 	return errors.any((func (err: Array): return err.size() > 0))
 
 ## Track an event with optional props (key-value pairs) and add it to the queue of events ready to be sent to the backend. If the queue reaches the minimum size, it will be flushed.
-func track(name: String, props: Dictionary = {}) -> void:
+func track(name: String, props: Dictionary[String, Variant] = {}) -> void:
 	if Talo.identity_check() != OK:
 		return
 
 	var final_props := _build_meta_props()
-	final_props.append_array(
-		props
-			.keys()
-			.map(func (key: String): return TaloProp.new(key, str(props[key])))
-	)
+	final_props.append_array(TaloPropUtils.dictionary_to_prop_array(props))
 
 	_queue.push_back({
 		name = name,
-		props = final_props.map(func (prop: TaloProp): return prop.to_dictionary()),
+		props = TaloPropUtils.serialise_prop_array(final_props),
 		timestamp = TaloTimeUtils.get_timestamp_msec()
 	})
 

addons/talo/apis/leaderboards_api.gd

@@ -46,7 +46,7 @@ func get_entries(internal_name: String, options = GetEntriesOptions.new()) -> En
 	match res.status:
 		200:
 			var entries: Array[TaloLeaderboardEntry] = Array(res.body.entries.map(
-				func(data: Dictionary):
+				func (data: Dictionary):
 					var entry := TaloLeaderboardEntry.new(data)
 					_entries_manager.upsert_entry(internal_name, entry)
 
@@ -65,15 +65,13 @@ func get_entries_for_current_player(internal_name: String, options = GetEntriesO
 	return await get_entries(internal_name, options)
 
 ## Add an entry to a leaderboard. The props (key-value pairs) parameter is used to store additional data with the entry.
-func add_entry(internal_name: String, score: float, props: Dictionary = {}) -> AddEntryResult:
+func add_entry(internal_name: String, score: float, props: Dictionary[String, Variant] = {}) -> AddEntryResult:
 	if Talo.identity_check() != OK:
 		return null
 
-	var props_to_send := props.keys().map(func(key: String) -> Dictionary: return {key = key, value = str(props[key])})
-
 	var res := await client.make_request(HTTPClient.METHOD_POST, "/%s/entries" % internal_name, {
 		score = score,
-		props = props_to_send
+		props = TaloPropUtils.dictionary_to_array(props)
 	})
 
 	match res.status:

addons/talo/entities/channel_storage_prop.gd

@@ -0,0 +1,16 @@
+class_name TaloChannelStorageProp extends RefCounted
+
+var key: String
+var value: String
+var created_by_alias: TaloPlayerAlias
+var last_updated_by_alias: TaloPlayerAlias
+var created_at: String
+var updated_at: String
+
+func _init(data: Dictionary):
+	key = data.key
+	value = data.value
+	created_by_alias = TaloPlayerAlias.new(data.createdBy)
+	last_updated_by_alias = TaloPlayerAlias.new(data.lastUpdatedBy)
+	created_at = data.createdAt
+	updated_at = data.updatedAt

addons/talo/entities/channel_storage_prop.gd.uid

@@ -0,0 +1 @@
+uid://cwk21i34hfe62

addons/talo/plugin.cfg

@@ -3,5 +3,5 @@
 name="Talo Game Services"
 description="Talo (https://trytalo.com) is an open-source game backend with services designed to help you build games faster. You can currently:\n\n- Identify and authenticate players\n- Store persistent data across players\n- Track events (levelling up, finding loot, etc)\n- Display high scores with leaderboards\n- Store and load player saves\n- Load game config options and flags from the cloud\n- Get feedback directly from your players\n- Keep your data in-sync even when players are offline\n- Send channel messages between players\n- See if players are online and set custom statuses"
 author="trytalo"
-version="0.28.0"
+version="0.29.0"
 script="talo_autoload.gd"

addons/talo/samples/channel_storage/channel_storage.tscn

@@ -0,0 +1,67 @@
+[gd_scene load_steps=2 format=3 uid="uid://cw6g72wpjl0g8"]
+
+[ext_resource type="Script" uid="uid://u7gy82vw7fn6" path="res://addons/talo/samples/channel_storage/scripts/channel_storage_demo.gd" id="1_1wlas"]
+
+[node name="ChannelStorage" type="Node2D"]
+script = ExtResource("1_1wlas")
+
+[node name="Control" type="Control" parent="."]
+layout_mode = 3
+anchors_preset = 0
+offset_right = 1080.0
+offset_bottom = 720.0
+
+[node name="VBoxContainer" type="VBoxContainer" parent="Control"]
+layout_mode = 1
+anchors_preset = 8
+anchor_left = 0.5
+anchor_top = 0.5
+anchor_right = 0.5
+anchor_bottom = 0.5
+offset_left = -450.0
+offset_top = -208.5
+offset_right = 450.0
+offset_bottom = 208.5
+grow_horizontal = 2
+grow_vertical = 2
+theme_override_constants/separation = 20
+
+[node name="PropKey" type="LineEdit" parent="Control/VBoxContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+placeholder_text = "Prop key"
+
+[node name="PropValue" type="LineEdit" parent="Control/VBoxContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+placeholder_text = "Prop value"
+
+[node name="PropLiveValueLabel" type="Label" parent="Control/VBoxContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+text = "%s live value is: %s"
+
+[node name="PropUpdatedLabel" type="Label" parent="Control/VBoxContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+text = "%s was last updated %s by %s"
+
+[node name="UpsertPropButton" type="Button" parent="Control/VBoxContainer"]
+layout_mode = 2
+text = "Upsert"
+
+[node name="DeletePropButton" type="Button" parent="Control/VBoxContainer"]
+layout_mode = 2
+text = "Delete"
+
+[node name="InfoLabel" type="Label" parent="Control/VBoxContainer"]
+custom_minimum_size = Vector2(900, 0)
+layout_mode = 2
+text = "
+How to use this demo: go to \"Debug > Customize Run Instances...\" and select \"Enable Multiple Instances\".
+
+Enter a prop key and value, then upsert it. You can also prefill the prop by setting the \"Prop Key\" exported variable on the root \"ChannelStorage\" node. You will see changes to your selected prop key in real time."
+autowrap_mode = 2
+
+[connection signal="pressed" from="Control/VBoxContainer/UpsertPropButton" to="." method="_on_upsert_prop_button_pressed"]
+[connection signal="pressed" from="Control/VBoxContainer/DeletePropButton" to="." method="_on_delete_prop_button_pressed"]