Remove support for CustomGamePlayedWhileFarming and CustomGamePlayedWhileIdle, #3551

Author: JustArchi

ArchiSteamFarm/Steam/Bot.cs

@@ -1429,32 +1429,6 @@ internal static string FormatBotResponse(string response, string botName) {
 		return ((ECommunityPrivacy) privacySettings.privacy_state == ECommunityPrivacy.Public) && ((ECommunityPrivacy) privacySettings.privacy_state_inventory == ECommunityPrivacy.Public);
 	}
 
-	internal async Task IdleGame(Game game) {
-		ArgumentNullException.ThrowIfNull(game);
-
-		string? gameName = null;
-
-		if (!string.IsNullOrEmpty(BotConfig.CustomGamePlayedWhileFarming)) {
-			gameName = string.Format(CultureInfo.CurrentCulture, BotConfig.CustomGamePlayedWhileFarming, game.AppID, game.GameName);
-		}
-
-		await ArchiHandler.PlayGames(new HashSet<uint>(1) { game.PlayableAppID }, gameName).ConfigureAwait(false);
-	}
-
-	internal async Task IdleGames(IReadOnlyCollection<Game> games) {
-		if ((games == null) || (games.Count == 0)) {
-			throw new ArgumentNullException(nameof(games));
-		}
-
-		string? gameName = null;
-
-		if (!string.IsNullOrEmpty(BotConfig.CustomGamePlayedWhileFarming)) {
-			gameName = string.Format(CultureInfo.CurrentCulture, BotConfig.CustomGamePlayedWhileFarming, string.Join(", ", games.Select(static game => game.AppID)), string.Join(", ", games.Select(static game => game.GameName)));
-		}
-
-		await ArchiHandler.PlayGames(games.Select(static game => game.PlayableAppID).ToHashSet(), gameName).ConfigureAwait(false);
-	}
-
 	internal async Task ImportKeysToRedeem(string filePath) {
 		ArgumentException.ThrowIfNullOrEmpty(filePath);
 
@@ -3858,7 +3832,7 @@ private async Task ResetGamesPlayed() {
 			ArchiLogger.LogGenericInfo(Strings.FormatBotIdlingSelectedGames(nameof(BotConfig.GamesPlayedWhileIdle), string.Join(", ", BotConfig.GamesPlayedWhileIdle)));
 		}
 
-		await ArchiHandler.PlayGames(BotConfig.GamesPlayedWhileIdle, BotConfig.CustomGamePlayedWhileIdle).ConfigureAwait(false);
+		ArchiHandler.PlayGames(BotConfig.GamesPlayedWhileIdle);
 	}
 
 	private void ResetPlayingWasBlockedWithTimer(object? state = null) {

ArchiSteamFarm/Steam/Cards/CardsFarmer.cs

@@ -890,7 +890,7 @@ private async Task<bool> FarmCards(Game game) {
 			Bot.ArchiLogger.LogGenericWarning(Strings.FormatWarningIdlingGameMismatch(game.AppID, game.GameName, game.PlayableAppID));
 		}
 
-		await Bot.IdleGame(game).ConfigureAwait(false);
+		Bot.ArchiHandler.PlayGames(new HashSet<uint>(1) { game.PlayableAppID });
 
 		bool keepFarming = true;
 		DateTime endFarmingDate = DateTime.UtcNow.AddHours(ASF.GlobalConfig?.MaxFarmingTime ?? GlobalConfig.DefaultMaxFarmingTime);
@@ -949,7 +949,7 @@ private async Task<bool> FarmHours(HashSet<Game> games) {
 			return true;
 		}
 
-		await Bot.IdleGames(games).ConfigureAwait(false);
+		Bot.ArchiHandler.PlayGames(games.Select(static game => game.PlayableAppID).ToHashSet());
 
 		bool keepFarming = true;
 

ArchiSteamFarm/Steam/Integration/ArchiHandler.cs

@@ -949,9 +949,13 @@ internal async Task<ulong> GetServerTime() {
 		return response.Result == EResult.OK ? response.Body.device_identifier : null;
 	}
 
-	internal async Task PlayGames(IReadOnlyCollection<uint> gameIDs, string? gameName = null) {
+	internal void PlayGames(IReadOnlyCollection<uint> gameIDs) {
 		ArgumentNullException.ThrowIfNull(gameIDs);
 
+		if (gameIDs.Count > MaxGamesPlayedConcurrently) {
+			throw new InvalidOperationException(nameof(gameIDs));
+		}
+
 		if (Client == null) {
 			throw new InvalidOperationException(nameof(Client));
 		}
@@ -967,39 +971,10 @@ internal async Task PlayGames(IReadOnlyCollection<uint> gameIDs, string? gameNam
 			}
 		};
 
-		if (!string.IsNullOrEmpty(gameName)) {
-			// If we have custom name to display, we must workaround the Steam network broken behaviour and send request on clean non-playing session
-			// This ensures that custom name will in fact display properly (if it's not omitted due to MaxGamesPlayedConcurrently, that is)
-			Client.Send(request);
-
-			await Task.Delay(Bot.CallbackSleep).ConfigureAwait(false);
-
-			request.Body.games_played.Add(
-				new CMsgClientGamesPlayed.GamePlayed {
-					game_extra_info = gameName,
-					game_id = new GameID {
-						AppType = GameID.GameType.Shortcut,
-						ModID = uint.MaxValue
-					}
-				}
-			);
-		}
-
 		if (gameIDs.Count > 0) {
-			IEnumerable<uint> uniqueGameIDs = gameIDs as IReadOnlySet<uint> ?? gameIDs.Distinct();
+			IEnumerable<uint> uniqueGameIDs = gameIDs is IReadOnlySet<uint> or ISet<uint> ? gameIDs : gameIDs.Distinct();
 
 			foreach (uint gameID in uniqueGameIDs.Where(static gameID => gameID > 0)) {
-				if (request.Body.games_played.Count >= MaxGamesPlayedConcurrently) {
-					if (string.IsNullOrEmpty(gameName)) {
-						throw new ArgumentOutOfRangeException(nameof(gameIDs));
-					}
-
-					// Make extra space by ditching custom gameName
-					gameName = null;
-
-					request.Body.games_played.RemoveAt(0);
-				}
-
 				request.Body.games_played.Add(new CMsgClientGamesPlayed.GamePlayed { game_id = new GameID(gameID) });
 			}
 		}

ArchiSteamFarm/Steam/Interaction/Actions.cs

@@ -307,7 +307,7 @@ public static string Hash(ArchiCryptoHelper.EHashingMethod hashingMethod, string
 			// Despite of proper order on our end, Steam network might not respect it
 			await Task.Delay(Bot.CallbackSleep).ConfigureAwait(false);
 
-			await Bot.ArchiHandler.PlayGames([], Bot.BotConfig.CustomGamePlayedWhileIdle).ConfigureAwait(false);
+			Bot.ArchiHandler.PlayGames([]);
 		}
 
 		if (resumeInSeconds > 0) {
@@ -327,7 +327,7 @@ public static string Hash(ArchiCryptoHelper.EHashingMethod hashingMethod, string
 	}
 
 	[PublicAPI]
-	public async Task<(bool Success, string Message)> Play(IReadOnlyCollection<uint> gameIDs, string? gameName = null) {
+	public async Task<(bool Success, string Message)> Play(IReadOnlyCollection<uint> gameIDs) {
 		ArgumentNullException.ThrowIfNull(gameIDs);
 
 		if (!Bot.IsConnectedAndLoggedOn) {
@@ -338,7 +338,7 @@ public static string Hash(ArchiCryptoHelper.EHashingMethod hashingMethod, string
 			await Bot.CardsFarmer.Pause(true).ConfigureAwait(false);
 		}
 
-		await Bot.ArchiHandler.PlayGames(gameIDs, gameName).ConfigureAwait(false);
+		Bot.ArchiHandler.PlayGames(gameIDs);
 
 		return (true, gameIDs.Count > 0 ? Strings.FormatBotIdlingSelectedGames(nameof(gameIDs), string.Join(", ", gameIDs)) : Strings.Done);
 	}

ArchiSteamFarm/Steam/Interaction/Commands.cs

@@ -2316,7 +2316,7 @@ internal void OnNewLicenseList() {
 		return responses.Count > 0 ? string.Join(Environment.NewLine, responses) : null;
 	}
 
-	private async Task<string?> ResponsePlay(EAccess access, HashSet<uint> gameIDs, string? gameName = null) {
+	private async Task<string?> ResponsePlay(EAccess access, HashSet<uint> gameIDs) {
 		if (!Enum.IsDefined(access)) {
 			throw new InvalidEnumArgumentException(nameof(access), (int) access, typeof(EAccess));
 		}
@@ -2335,7 +2335,7 @@ internal void OnNewLicenseList() {
 			return FormatBotResponse(Strings.BotNotConnected);
 		}
 
-		(bool success, string message) = await Bot.Actions.Play(gameIDs, gameName).ConfigureAwait(false);
+		(bool success, string message) = await Bot.Actions.Play(gameIDs).ConfigureAwait(false);
 
 		return FormatBotResponse(success ? message : Strings.FormatWarningFailedWithError(message));
 	}
@@ -2357,32 +2357,24 @@ internal void OnNewLicenseList() {
 
 		string[] games = targetGameIDs.Split(SharedInfo.ListElementSeparators, StringSplitOptions.RemoveEmptyEntries);
 
-		if (games.Length == 0) {
-			return FormatBotResponse(Strings.FormatErrorIsEmpty(nameof(games)));
+		switch (games.Length) {
+			case 0:
+				return FormatBotResponse(Strings.FormatErrorIsEmpty(nameof(games)));
+			case > ArchiHandler.MaxGamesPlayedConcurrently:
+				return FormatBotResponse(Strings.FormatWarningFailedWithError($"{nameof(games)} > {ArchiHandler.MaxGamesPlayedConcurrently}"));
 		}
 
-		HashSet<uint> gamesToPlay = new(Math.Min(games.Length, ArchiHandler.MaxGamesPlayedConcurrently));
-		StringBuilder gameName = new();
+		HashSet<uint> gamesToPlay = new(games.Length);
 
 		foreach (string game in games) {
 			if (!uint.TryParse(game, out uint gameID) || (gameID == 0)) {
-				if (gameName.Length > 0) {
-					gameName.Append(' ');
-				}
-
-				gameName.Append(game);
-
-				continue;
-			}
-
-			if (gamesToPlay.Count >= ArchiHandler.MaxGamesPlayedConcurrently) {
-				return FormatBotResponse(Strings.FormatWarningFailedWithError($"{nameof(gamesToPlay)} > {ArchiHandler.MaxGamesPlayedConcurrently}"));
+				return FormatBotResponse(Strings.FormatErrorIsInvalid(nameof(game)));
 			}
 
 			gamesToPlay.Add(gameID);
 		}
 
-		return await ResponsePlay(access, gamesToPlay, gameName.Length > 0 ? gameName.ToString() : null).ConfigureAwait(false);
+		return await ResponsePlay(access, gamesToPlay).ConfigureAwait(false);
 	}
 
 	private static async Task<string?> ResponsePlay(EAccess access, string botNames, string targetGameIDs, ulong steamID = 0) {

ArchiSteamFarm/Steam/Storage/BotConfig.cs

@@ -54,9 +54,11 @@ public sealed class BotConfig {
 	[PublicAPI]
 	public const EBotBehaviour DefaultBotBehaviour = EBotBehaviour.None;
 
+	[Obsolete("Functionality deprecated, will be removed in the next version")]
 	[PublicAPI]
 	public const string? DefaultCustomGamePlayedWhileFarming = null;
 
+	[Obsolete("Functionality deprecated, will be removed in the next version")]
 	[PublicAPI]
 	public const string? DefaultCustomGamePlayedWhileIdle = null;
 
@@ -207,9 +209,11 @@ public WebProxy? WebProxy {
 	public ImmutableHashSet<EAssetType> CompleteTypesToSend { get; init; } = DefaultCompleteTypesToSend;
 
 	[JsonInclude]
+	[Obsolete("Functionality deprecated, will be removed in the next version")]
 	public string? CustomGamePlayedWhileFarming { get; init; } = DefaultCustomGamePlayedWhileFarming;
 
 	[JsonInclude]
+	[Obsolete("Functionality deprecated, will be removed in the next version")]
 	public string? CustomGamePlayedWhileIdle { get; init; } = DefaultCustomGamePlayedWhileIdle;
 
 	[JsonInclude]
@@ -388,11 +392,15 @@ public BotConfig() { }
 	[UsedImplicitly]
 	public bool ShouldSerializeCompleteTypesToSend() => !Saving || ((CompleteTypesToSend != DefaultCompleteTypesToSend) && !CompleteTypesToSend.SetEquals(DefaultCompleteTypesToSend));
 
+#pragma warning disable CA1822
+	[Obsolete("Functionality deprecated, will be removed in the next version")]
 	[UsedImplicitly]
-	public bool ShouldSerializeCustomGamePlayedWhileFarming() => !Saving || (CustomGamePlayedWhileFarming != DefaultCustomGamePlayedWhileFarming);
+	public bool ShouldSerializeCustomGamePlayedWhileFarming() => false;
 
+	[Obsolete("Functionality deprecated, will be removed in the next version")]
 	[UsedImplicitly]
-	public bool ShouldSerializeCustomGamePlayedWhileIdle() => !Saving || (CustomGamePlayedWhileIdle != DefaultCustomGamePlayedWhileIdle);
+	public bool ShouldSerializeCustomGamePlayedWhileIdle() => false;
+#pragma warning restore CA1822
 
 	[UsedImplicitly]
 	public bool ShouldSerializeEnabled() => !Saving || (Enabled != DefaultEnabled);
@@ -521,15 +529,6 @@ public static async Task<bool> Write(string filePath, BotConfig botConfig) {
 			}
 		}
 
-		if (!string.IsNullOrEmpty(CustomGamePlayedWhileFarming)) {
-			try {
-				// Test CustomGamePlayedWhileFarming against supported format, otherwise we'll throw later when used
-				string _ = string.Format(CultureInfo.CurrentCulture, CustomGamePlayedWhileFarming, null, null);
-			} catch (FormatException e) {
-				return (false, Strings.FormatErrorConfigPropertyInvalid(nameof(CustomGamePlayedWhileFarming), e.Message));
-			}
-		}
-
 		foreach (EFarmingOrder farmingOrder in FarmingOrders.Where(static farmingOrder => !Enum.IsDefined(farmingOrder))) {
 			return (false, Strings.FormatErrorConfigPropertyInvalid(nameof(FarmingOrders), farmingOrder));
 		}