Merge pull request #68 from TaloDev/develop

Release 0.21.0

Author: tudddorrr

README.md

@@ -19,11 +19,13 @@ The Talo Godot Plugin is a lightweight wrapper around the [REST API](https://doc
 - 🕹️ [Leaderboards](https://trytalo.com/leaderboards): Highly customisable leaderboards that can sync with Steamworks.
 - 💾 [Game saves](https://trytalo.com/saves): A simple and flexible way to load/save game state; also works offline.
 - 📊 [Game stats](https://trytalo.com/stats): Track global or per-player stats across your game; also syncs with Steamworks.
-- 💬 [Game channels](https://trytalo.com/channels): Send real-time messages between players subscribed to specific topics.
+- 💬 [Game 
+channels](https://trytalo.com/channels): Send real-time messages between players subscribed to specific topics.
 - ⚙️ [Live config](https://trytalo.com/live-config): Update game settings from the web with zero downtime.
 - 🔧 [Steamworks integration](https://trytalo.com/steamworks-integration): Hook into Steamworks for authentication and ownership checks.
 - 🗣️ [Game feedback](https://trytalo.com/feedback): Collect and manage feedback from your players.
 - 🛡️ [Continuity](https://trytalo.com/continuity): Keep your data in-sync even when your players are offline.
+- 🔔 [Player presence](https://trytalo.com/player#presence): See if players are online and set custom statuses.
 
 ## Samples included with the plugin
 

addons/talo/apis/channels_api.gd

@@ -5,6 +5,17 @@ class_name ChannelsAPI extends TaloAPI
 ##
 ## @tutorial: https://docs.trytalo.com/docs/godot/channels
 
+## Emitted when a message is received from a channel.
+signal message_received(channel: TaloChannel, player_alias: TaloPlayerAlias, message: String)
+
+func _ready():
+	await Talo.init_completed
+	Talo.socket.message_received.connect(_on_message_received)
+
+func _on_message_received(res: String, data: Dictionary) -> void:
+	if res == "v1.channels.message":
+		message_received.emit(TaloChannel.new(data.channel), TaloPlayerAlias.new(data.playerAlias), data.message)
+
 ## Get a channel by its ID.
 func find(channel_id: int) -> TaloChannel:
 	var res = await client.make_request(HTTPClient.METHOD_GET, "/%s" % channel_id)
@@ -111,7 +122,7 @@ func delete(channel_id: int) -> void:
 		return
 
 	var res = await client.make_request(HTTPClient.METHOD_DELETE, "/%s" % channel_id)
-	
+
 	match (res.status):
 		403:
 			push_error("Player does not have permissions to delete channel %s." % channel_id)

addons/talo/apis/game_config_api.gd

@@ -7,6 +7,8 @@ class_name GameConfigAPI extends TaloAPI
 
 ## Emitted when the live config has been loaded.
 signal live_config_loaded(live_config: TaloLiveConfig)
+
+## Emitted when the live config has been updated.
 signal live_config_updated(live_config: TaloLiveConfig)
 
 func _ready() -> void:

addons/talo/apis/leaderboards_api.gd

@@ -22,14 +22,17 @@ func get_cached_entries_for_current_player(internal_name: String) -> Array:
 	)
 
 ## Get a list of entries for a leaderboard. The page parameter is used for pagination.
-func get_entries(internal_name: String, page: int, alias_id = -1) -> Array:
+func get_entries(internal_name: String, page: int, alias_id = -1, include_archived = false) -> Array:
 	var url = "/%s/entries?page=%s"
 	var url_data = [internal_name, page]
 
 	if alias_id != -1:
 		url += "&aliasId=%s"
 		url_data += alias_id
 
+	if include_archived:
+		url += "&withDeleted=1"
+
 	var res = await client.make_request(HTTPClient.METHOD_GET, url % url_data)
 
 	match (res.status):
@@ -46,11 +49,11 @@ func get_entries(internal_name: String, page: int, alias_id = -1) -> Array:
 			return []
 
 ## Get a list of entries for a leaderboard for the current player. The page parameter is used for pagination.
-func get_entries_for_current_player(internal_name: String, page: int) -> Array:
+func get_entries_for_current_player(internal_name: String, page: int, include_archived = false) -> Array:
 	if Talo.identity_check() != OK:
 		return []
-	
-	return await get_entries(internal_name, page, Talo.current_alias.id)
+
+	return await get_entries(internal_name, page, Talo.current_alias.id, include_archived)
 
 ## 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 = {}) -> Array:

addons/talo/apis/player_presence_api.gd

@@ -0,0 +1,44 @@
+class_name PlayerPresenceAPI extends TaloAPI
+## An interface for communicating with the Talo Player Presence API.
+##
+## This API is used to track and manage player presence in your game. Presence indicates whether players are online
+## and their current status.
+##
+## @tutorial: https://docs.trytalo.com/docs/godot/player-presence
+
+## Emitted when a player's presence status changes.
+signal presence_changed(presence: TaloPlayerPresence, online_changed: bool, custom_status_changed: bool)
+
+func _ready():
+	await Talo.init_completed
+	Talo.socket.message_received.connect(_on_message_received)
+
+func _on_message_received(res: String, data: Dictionary) -> void:
+	if res == "v1.players.presence.updated":
+		presence_changed.emit(TaloPlayerPresence.new(data.presence), data.meta.onlineChanged, data.meta.customStatusChanged)
+
+## Get the presence status for a specific player.
+func get_presence(player_id: String) -> TaloPlayerPresence:
+	var res = await client.make_request(HTTPClient.METHOD_GET, "/%s" % player_id)
+
+	match (res.status):
+		200:
+			return TaloPlayerPresence.new(res.body.presence)
+		_:
+			return null
+
+## Update the presence status for the current player.
+func update_presence(online: bool, custom_status: String = "") -> TaloPlayerPresence:
+	if Talo.identity_check() != OK:
+		return null
+
+	var res = await client.make_request(HTTPClient.METHOD_PUT, "", {
+		online = online,
+		customStatus = custom_status
+	})
+
+	match (res.status):
+		200:
+			return TaloPlayerPresence.new(res.body.presence)
+		_:
+			return null

addons/talo/entities/channel.gd

@@ -13,8 +13,9 @@ func _init(data: Dictionary):
 
 	id = data.id
 	display_name = data.name
-	owner_alias = TaloPlayerAlias.new(data.owner)
+	if data.owner:
+		owner_alias = TaloPlayerAlias.new(data.owner)
 	total_messages = data.totalMessages
-	member_count = data.memberCount
+	member_count = data.get('memberCount', 0) # TODO: socket messages don't currently send the memberCount
 	created_at = data.createdAt
 	updated_at = data.updatedAt

addons/talo/entities/leaderboard_entry.gd

@@ -6,6 +6,7 @@ var score: float
 var player_alias: TaloPlayerAlias
 var created_at: String
 var updated_at: String
+var deleted_at: String
 
 func _init(data: Dictionary):
 	super._init(data.props.map(func (prop): return TaloProp.new(prop.key, prop.value)))
@@ -16,3 +17,5 @@ func _init(data: Dictionary):
 	player_alias = TaloPlayerAlias.new(data.playerAlias)
 	created_at = data.createdAt
 	updated_at = data.updatedAt
+	if data.deletedAt:
+		deleted_at = data.deletedAt

addons/talo/entities/live_config.gd

@@ -11,4 +11,4 @@ func _init(props: Array):
 ## Get a property value by key. Returns the fallback value if the key is not found.
 func get_prop(key: String, fallback: String) -> String:
 	var filtered = props.filter(func (prop: TaloProp): return prop.key == key)
-	return fallback if filtered.is_empty() else filtered.front()
+	return fallback if filtered.is_empty() else filtered.front().value

addons/talo/entities/player_presence.gd

@@ -0,0 +1,12 @@
+class_name TaloPlayerPresence extends Node
+
+var online: bool
+var custom_status: String
+var player_alias: TaloPlayerAlias
+var updated_at: String
+
+func _init(data: Dictionary):
+	online = data.online
+	custom_status = data.customStatus
+	player_alias = null if data.playerAlias == null else TaloPlayerAlias.new(data.playerAlias)
+	updated_at = data.updatedAt

addons/talo/plugin.cfg

@@ -1,7 +1,7 @@
 [plugin]
 
 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"
+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.20.0"
+version="0.21.0"
 script="talo_autoload.gd"