Use Steam HTTP API for app info

Author: ShadowApex

core/library_steam.gd

@@ -6,16 +6,19 @@ extends Library
 # ~/.steam/steam/userdata/<user_id>/config/localconfig.vdf
 
 const SteamClient := preload("res://plugins/steam/core/steam_client.gd")
+const SteamAPIClient := preload("res://plugins/steam/core/steam_api_client.gd")
 const _apps_cache_file: String = "apps.json"
 
 var thread_pool := load("res://core/systems/threading/thread_pool.tres") as ThreadPool
+var steam_api_client := SteamAPIClient.new()
 
 @onready var steam: SteamClient = get_tree().get_first_node_in_group("steam_client")
 
 
 # Called when the node enters the scene tree for the first time.
 func _ready() -> void:
 	super()
+	add_child(steam_api_client)
 	logger = Log.get_logger("Steam", Log.LEVEL.DEBUG)
 	logger.info("Steam Library loaded")
 	steam.logged_in.connect(_on_logged_in)
@@ -131,7 +134,8 @@ func _on_logged_in(status: SteamClient.LOGIN_STATUS):
 		if not LibraryManager.has_app(item.name):
 			var msg := "App {0} was not loaded. Adding item".format([item.name])
 			logger.info(msg)
-			LibraryManager.add_library_launch_item(library_id, item)
+			launch_item_added.emit(item)
+			#LibraryManager.add_library_launch_item(library_id, item)
 		# TODO: Update installed status
 
 	# TODO: Remove library items that have been deleted
@@ -168,9 +172,10 @@ func _load_library(
 		return []
 
 	logger.info("Fetching Steam library...")
+	
 	# Get all available apps
-	var app_ids: PackedInt64Array = await _get_available_apps()
-	var app_info: Dictionary = await _get_games_from_app_info(app_ids)
+	var app_ids: PackedInt64Array = await get_available_apps()
+	var app_info: Dictionary = await get_apps_info(app_ids)
 	var apps_installed: Array = await steam.get_installed_apps()
 	var app_ids_installed := PackedStringArray()
 	for app in apps_installed:
@@ -179,13 +184,11 @@ func _load_library(
 	# Generate launch items for each game
 	var items := [] as Array[LibraryLaunchItem]
 	for app_id in app_info.keys():
-		var item: LibraryLaunchItem = LibraryLaunchItem.new()
-		item.provider_app_id = "{0}".format([app_id])
-		item.name = app_info[app_id]
-		item.command = "steam"
-		item.args = ["-gamepadui", "-steamos3", "-steampal", "-steamdeck", "-silent", "steam://rungameid/" + item.provider_app_id]
-		item.tags = ["steam"]
-		item.installed = app_id in app_ids_installed
+		var info := app_info[app_id] as Dictionary
+		var item := _app_info_to_launch_item(info, app_id in app_ids_installed)
+		if not item:
+			logger.debug("Unable to create launch item for: " + app_id)
+			continue
 		items.append(item)
 
 	# Cache the discovered apps
@@ -202,65 +205,89 @@ func _load_library(
 
 
 # Returns an array of available steamAppIds
-func _get_available_apps() -> Array:
+func get_available_apps() -> Array:
 	var app_ids = await steam.get_available_apps()
 	return app_ids
 
 
-# Returns the app status for the given app ids
-func _get_app_status(app_ids: Array) -> Dictionary:
-	var app_status := {}
-	for app_id in app_ids:
-		var id := str(app_id)
-		var status := await steam.get_app_status(app_id)
-		app_status[app_id] = status
-	return app_status
-
-
-# Returns the app information for the given app ids
-func _get_games_from_app_info(app_ids: Array, caching_flags: int = Cache.FLAGS.LOAD | Cache.FLAGS.SAVE) -> Dictionary:
+## Returns the app information for the given app ids. This is returned as a
+## dictionary where the key is the app ID, and the value is the app info.
+func get_apps_info(app_ids: Array, caching_flags: int = Cache.FLAGS.LOAD | Cache.FLAGS.SAVE) -> Dictionary:
 	var app_info := {}
 	for app_id in app_ids:
 		var id := str(app_id)
-		var info := await _get_app_info(id, caching_flags)
+		var info := await get_app_info(id, caching_flags)
 
 		if not id in info:
 			continue
-		if not "common" in info[id]:
-			continue
-		if not "type" in info[id]["common"]:
-			continue
-		if info[id]["common"]["type"] != "Game":  # Skip non-games
-			continue
-		if not "name" in info[id]["common"]:
-			continue
-		app_info[id] = info[id]["common"]["name"]
+
+		app_info[id] = info
 
 	return app_info
 
 
 ## Returns the app info dictionary parsed from the VDF
-func _get_app_info(app_id: String, caching_flags: int = Cache.FLAGS.LOAD | Cache.FLAGS.SAVE) -> Dictionary:
+func get_app_info(app_id: String, caching_flags: int = Cache.FLAGS.LOAD | Cache.FLAGS.SAVE) -> Dictionary:
 	# Load the app info from cache if requested
 	var cache_key := app_id + ".app_info"
 	if caching_flags & Cache.FLAGS.LOAD and Cache.is_cached(_cache_dir, cache_key):
 		return Cache.get_json(_cache_dir, cache_key)
 	else:
-		var info := await steam.get_app_info(app_id)
+		var info = await steam_api_client.get_app_details(app_id)
+		logger.debug("Found app info for " + app_id + ": " + str(info))
+		if info == null:
+			return {}
 		if caching_flags & Cache.FLAGS.SAVE:
 			Cache.save_json(_cache_dir, cache_key, info)
 		return info
 
 
+## Builds a library launch item from the given Steam app information from the store API.
+func _app_info_to_launch_item(info: Dictionary, is_installed: bool) -> LibraryLaunchItem:
+	if info.size() == 0:
+		return null
+
+	var app_id := info.keys()[0] as String
+	var details := info[app_id] as Dictionary
+	if not "data" in details:
+		return null
+	var data := details["data"] as Dictionary
+	if not "type" in data:
+		return null
+	if not data["type"] == "game":
+		return null
+	var categories := PackedStringArray()
+	if "categories" in data:
+		for category in data["categories"]:
+			categories.append(category["description"])
+	var tags := PackedStringArray()
+	if "genres" in data:
+		for genre in data["genres"]:
+			tags.append((genre["description"] as String).to_lower())
+
+	var item := LibraryLaunchItem.new()
+	item.provider_app_id = app_id
+	item.name = data["name"]
+	item.command = "steam"
+	item.args = ["-gamepadui", "-steamos3", "-steampal", "-steamdeck", "-silent", "steam://rungameid/" + app_id]
+	item.categories = categories
+	item.tags = ["steam"]
+	item.tags.append_array(tags)
+	item.installed = is_installed
+	
+	return item
+
+
 # Returns whether or not the given app id has a Linux binary
 func _app_supports_linux(app_id: String) -> bool:
-	var info := await _get_app_info(app_id)
+	var info = await steam_api_client.get_app_details(app_id)
 	if not app_id in info:
 		return false
-	if not "common" in info[app_id]:
+	if not "data" in info[app_id]:
+		return false
+	if not "platform" in info[app_id]["data"]:
 		return false
-	if not "oslist" in info[app_id]["common"]:
+	if not "linux" in info[app_id]["data"]["platform"]:
 		return false
-	var os_list := info[app_id]["common"]["oslist"].split(",") as Array
 
-	return "linux" in os_list
+	return info[app_id]["data"]["platform"]["linux"]

core/steam_api_client.gd

@@ -0,0 +1,33 @@
+extends HTTPAPIClient
+
+## Steam HTTP API Client
+##
+## HTTP API client for interacting with the Steam API.
+## Reference: https://wiki.teamfortress.com/wiki/User:RJackson/StorefrontAPI
+
+
+func _init() -> void:
+	logger = Log.get_logger("SteamAPIClient")
+
+
+# Called when the node enters the scene tree for the first time.
+func _ready() -> void:
+	base_url = "https://store.steampowered.com"
+
+
+## Returns the app details as a Dictionary with the given app id.
+## E.g.
+## {
+##   "367520": {
+##     "success": true,
+##     "data": {
+##       "type": "game",
+##       "name": "Hollow Knight",
+##       "steam_appid": 367520,
+##   ...
+func get_app_details(app_id: String) -> Variant:
+	var url := "/api/appdetails?appids={0}".format([app_id])
+	var response := await request(url)
+	if response.code != 200:
+		return null
+	return response.get_json()

plugin.json

@@ -1,7 +1,7 @@
 {
   "plugin.id": "steam",
   "plugin.name": "Steam",
-  "plugin.version": "1.0.6",
+  "plugin.version": "1.0.8",
   "plugin.min-api-version": "1.0.0",
   "plugin.link": "https://github.com/ShadowBlip/OpenGamepadUI-steam",
   "plugin.source": "https://github.com/ShadowBlip/OpenGamepadUI-steam",