fix(SteamClient): modernize settings and fix steamcmd stderr parsing

Author: ShadowApex

core/steam_client.gd

@@ -39,10 +39,11 @@ signal install_progressed(app_id: String, current: int, total: int)
 
 var steamcmd_dir := "/".join([OS.get_environment("HOME"), ".steam", "steamcmd"])
 var steamcmd := "/".join([steamcmd_dir, "steamcmd.sh"])
+var steamcmd_stderr: FileAccess
 var proc: InteractiveProcess
 var state: STATE = STATE.BOOT
 var is_logged_in := false
-var client_started := false 
+var client_started := false
 
 var cmd_queue: Array[String] = []
 var current_cmd := ""
@@ -496,6 +497,16 @@ func _thread_process(_delta: float) -> void:
 	# Read the output from the process
 	var output := proc.read()
 
+	# Also read output from the stderr file
+	if steamcmd_stderr:
+		#logger.debug("steamcmd-stderr: Current position:", steamcmd_stderr.get_position(), "Current size:", steamcmd_stderr.get_length())
+		var remaining_data := steamcmd_stderr.get_length() - steamcmd_stderr.get_position()
+		if remaining_data > 0:
+			var data := steamcmd_stderr.get_buffer(remaining_data)
+			var stderr := data.get_string_from_utf8()
+			logger.debug("steamcmd-stderr: " + stderr)
+			output += stderr
+
 	# Return if there is no output from the process
 	if output == "":
 		return
@@ -509,6 +520,29 @@ func _thread_process(_delta: float) -> void:
 		for line in lines:
 			logger.debug("steamcmd: " + line)
 
+	# Wait for "Redirecting stderr to" to open stderr file.
+	# Because of new behavior as of ~2024-06, steamcmd outputs stderr to a file
+	# instead of to normal stderr.
+	if not steamcmd_stderr:
+		for line in lines:
+			if not line.begins_with("Redirecting stderr to"):
+				continue
+
+			# Parse the line:
+			# Redirecting stderr to '/home/<user>/.local/share/Steam/logs/stderr.txt'
+			var parts := line.split("'")
+			if parts.size() < 2:
+				logger.error("Unable to parse stderr path for line: " + line)
+				break
+			var stderr_path := parts[1]
+
+			# Open the stderr file
+			steamcmd_stderr = FileAccess.open(stderr_path, FileAccess.READ)
+			if not steamcmd_stderr:
+				logger.error("Unable to open steamcmd stderr: " + str(FileAccess.get_open_error()))
+				break
+			logger.debug("Opened steamcmd stderr file: " + stderr_path)
+
 	# Signal when command progress has been made 
 	if current_cmd != "":
 		var out := lines.duplicate()

core/steam_settings.gd

@@ -1,14 +1,14 @@
 extends Control
 
 const SteamClient := preload("res://plugins/steam/core/steam_client.gd")
-const SettingsManager := preload("res://core/global/settings_manager.tres")
-const NotificationManager := preload("res://core/global/notification_manager.tres")
+var settings_manager := load("res://core/global/settings_manager.tres") as SettingsManager
+var notification_manager := load("res://core/global/notification_manager.tres") as NotificationManager
 const icon := preload("res://plugins/steam/assets/steam.svg")
 
 @onready var status := $%Status
 @onready var connected_status := $%ConnectedStatus
 @onready var logged_in_status := $%LoggedInStatus
-@onready var user_box := $%UsernameTextInput as ComponentTextInput
+@onready var user_box := $%UsernameTextInput
 @onready var pass_box := $%PasswordTextInput
 @onready var tfa_box := $%TFATextInput
 @onready var login_button := $%LoginButton
@@ -18,7 +18,7 @@ const icon := preload("res://plugins/steam/assets/steam.svg")
 # Called when the node enters the scene tree for the first time.
 func _ready() -> void:
 	# If we have logged in before, populate the username box
-	var user := SettingsManager.get_value("plugin.steam", "user", "") as String
+	var user := settings_manager.get_value("plugin.steam", "user", "") as String
 	user_box.text = user
 
 	# Set the status label based on the steam client status
@@ -74,12 +74,22 @@ func _on_login(login_status: SteamClient.LOGIN_STATUS) -> void:
 	if login_status == SteamClient.LOGIN_STATUS.TFA_REQUIRED:
 		tfa_box.visible = true
 		tfa_box.grab_focus.call_deferred()
+
+		var notify := Notification.new("Two-factor authentication required")
+		notify.icon = icon
+		notification_manager.show(notify)
+
 		return
 
 	# If we logged, woo!
 	if login_status == SteamClient.LOGIN_STATUS.OK:
 		logged_in_status.status = logged_in_status.STATUS.CLOSED
 		logged_in_status.color = "green"
+		
+		var notify := Notification.new("Successfully logged in to Steam")
+		notify.icon = icon
+		notification_manager.show(notify)
+		
 		return
 
 
@@ -88,5 +98,5 @@ func _on_login_button() -> void:
 	var username: String = user_box.text
 	var password: String = pass_box.text
 	var tfa_code: String = tfa_box.text
-	SettingsManager.set_value("plugin.steam", "user", username)
+	settings_manager.set_value("plugin.steam", "user", username)
 	steam.login(username, password, tfa_code)

core/steam_settings.tscn

@@ -3,82 +3,72 @@
 [ext_resource type="Script" path="res://plugins/steam/core/steam_settings.gd" id="1_482tk"]
 [ext_resource type="PackedScene" uid="uid://d1hlp6c8wrqgv" path="res://core/ui/components/status.tscn" id="2_xf1mt"]
 [ext_resource type="PackedScene" uid="uid://d1rjdfxxrdccf" path="res://core/ui/components/text_input.tscn" id="3_d62ly"]
-[ext_resource type="PackedScene" uid="uid://df5o1o2dsik84" path="res://core/ui/components/button.tscn" id="4_5dgjq"]
+[ext_resource type="PackedScene" uid="uid://c71ayw7pcw6u6" path="res://core/ui/components/card_button.tscn" id="4_jlnf0"]
 
-[node name="SteamSettings" type="ScrollContainer"]
+[node name="MarginContainer" type="MarginContainer"]
 anchors_preset = 15
 anchor_right = 1.0
 anchor_bottom = 1.0
 grow_horizontal = 2
 grow_vertical = 2
-size_flags_horizontal = 3
-size_flags_vertical = 3
-follow_focus = true
 script = ExtResource("1_482tk")
 
-[node name="MarginContainer" type="MarginContainer" parent="."]
+[node name="ContentContainer" type="VBoxContainer" parent="."]
 layout_mode = 2
 size_flags_horizontal = 3
-theme_override_constants/margin_left = 5
-theme_override_constants/margin_top = 5
-theme_override_constants/margin_right = 5
-theme_override_constants/margin_bottom = 5
-
-[node name="ContentContainer" type="VBoxContainer" parent="MarginContainer"]
-layout_mode = 2
-size_flags_vertical = 3
+size_flags_vertical = 0
 theme_override_constants/separation = 10
 
-[node name="Status" parent="MarginContainer/ContentContainer" instance=ExtResource("2_xf1mt")]
+[node name="Status" parent="ContentContainer" instance=ExtResource("2_xf1mt")]
 unique_name_in_owner = true
 layout_mode = 2
 title = "Status"
 description = ""
 status = 2
 color = "red"
 
-[node name="ConnectedStatus" parent="MarginContainer/ContentContainer" instance=ExtResource("2_xf1mt")]
+[node name="ConnectedStatus" parent="ContentContainer" instance=ExtResource("2_xf1mt")]
 unique_name_in_owner = true
 layout_mode = 2
 title = "Connected"
 description = ""
 color = "gray"
 
-[node name="LoggedInStatus" parent="MarginContainer/ContentContainer" instance=ExtResource("2_xf1mt")]
+[node name="LoggedInStatus" parent="ContentContainer" instance=ExtResource("2_xf1mt")]
 unique_name_in_owner = true
 layout_mode = 2
 title = "Logged In"
 description = ""
 color = "gray"
 
-[node name="HSeparator" type="HSeparator" parent="MarginContainer/ContentContainer"]
+[node name="HSeparator" type="HSeparator" parent="ContentContainer"]
 layout_mode = 2
 
-[node name="UsernameTextInput" parent="MarginContainer/ContentContainer" instance=ExtResource("3_d62ly")]
+[node name="UsernameTextInput" parent="ContentContainer" instance=ExtResource("3_d62ly")]
 unique_name_in_owner = true
 layout_mode = 2
 title = "Username"
 description = ""
 
-[node name="PasswordTextInput" parent="MarginContainer/ContentContainer" instance=ExtResource("3_d62ly")]
+[node name="PasswordTextInput" parent="ContentContainer" instance=ExtResource("3_d62ly")]
 unique_name_in_owner = true
 layout_mode = 2
 title = "Password"
 description = ""
 secret = true
 
-[node name="TFATextInput" parent="MarginContainer/ContentContainer" instance=ExtResource("3_d62ly")]
+[node name="TFATextInput" parent="ContentContainer" instance=ExtResource("3_d62ly")]
 unique_name_in_owner = true
 visible = false
 layout_mode = 2
 title = "SteamGuard Code"
 description = "Enter your Steam Guard code to continue"
 secret = true
 
-[node name="HSeparatorLogin" type="HSeparator" parent="MarginContainer/ContentContainer"]
+[node name="HSeparatorLogin" type="HSeparator" parent="ContentContainer"]
 layout_mode = 2
 
-[node name="LoginButton" parent="MarginContainer/ContentContainer" instance=ExtResource("4_5dgjq")]
+[node name="LoginButton" parent="ContentContainer" instance=ExtResource("4_jlnf0")]
 unique_name_in_owner = true
 layout_mode = 2
 text = "Login"

plugin.gd

@@ -1,13 +1,14 @@
 extends Plugin
 
 const SteamClient := preload("res://plugins/steam/core/steam_client.gd")
-const SettingsManager := preload("res://core/global/settings_manager.tres")
-const NotificationManager := preload("res://core/global/notification_manager.tres")
-const settings_menu := preload("res://plugins/steam/core/steam_settings.tscn")
-const icon := preload("res://plugins/steam/assets/steam.svg")
+
+var settings_manager := load("res://core/global/settings_manager.tres") as SettingsManager
+var notification_manager := load("res://core/global/notification_manager.tres") as NotificationManager
+var settings_menu := load("res://plugins/steam/core/steam_settings.tscn") as PackedScene
+var icon := preload("res://plugins/steam/assets/steam.svg")
 
 var steam: SteamClient
-var user := SettingsManager.get_value("plugin.steam", "user", "") as String
+var user := settings_manager.get_value("plugin.steam", "user", "") as String
 
 
 # Called when the node enters the scene tree for the first time.
@@ -41,7 +42,7 @@ func _on_client_start():
 		var notify := Notification.new("Unable to start steam client")
 		notify.icon = icon
 		logger.error(notify.text)
-		NotificationManager.show(notify)
+		notification_manager.show(notify)
 		return
 
 
@@ -52,7 +53,7 @@ func _on_client_ready():
 		var notify := Notification.new("Steam login required")
 		notify.icon = icon
 		logger.info(notify.text)
-		NotificationManager.show(notify)
+		notification_manager.show(notify)
 		return
 
 	# If we have logged in before, try logging in with saved credentials

plugin.json

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