Implement proper difficulty dropdown for co-op gamemodes

Author: Starkku

ClientCore/ClientConfiguration.cs

@@ -264,7 +264,7 @@ public void RefreshSettings()
 
         public string[] TrustedDomains => clientDefinitionsIni.GetStringListValue(SETTINGS, "TrustedDomains", string.Empty);
 
-        public string[] AlwaysTrustedDomains = {"cncnet.org", "gamesurge.net", "dronebl.org", "discord.com", "discord.gg", "youtube.com", "youtu.be"};
+        public string[] AlwaysTrustedDomains = { "cncnet.org", "gamesurge.net", "dronebl.org", "discord.com", "discord.gg", "youtube.com", "youtu.be" };
 
         public (string Name, string Path) GetThemeInfoFromIndex(int themeIndex) => clientDefinitionsIni.GetStringValue("Themes", themeIndex.ToString(), ",").Split(',').AsTuple2();
 
@@ -287,6 +287,30 @@ public string GetThemePath(string themeName)
             return null;
         }
 
+        private string[] GetCoopDifficultyINIPaths()
+        {
+            List<string> paths = new List<string>();
+            var pathString = clientDefinitionsIni.GetStringValue(SETTINGS, nameof(CoopDifficultyINIPaths), string.Empty);
+
+            if (string.IsNullOrEmpty(pathString))
+            {
+                paths.Add(SafePath.CombineFilePath("INI", "Map Code", "Coop Difficulty Easy.ini"));
+                paths.Add(SafePath.CombineFilePath("INI", "Map Code", "Coop Difficulty Medium.ini"));
+                paths.Add(SafePath.CombineFilePath("INI", "Map Code", "Coop Difficulty Hard.ini"));
+            }
+            else
+            {
+                var pathStrings = pathString.Split(',', StringSplitOptions.RemoveEmptyEntries);
+
+                foreach (var path in pathStrings)
+                {
+                    paths.Add(SafePath.CombineFilePath(path));
+                }
+            }
+            
+            return paths.ToArray();
+        }
+
         public string SettingsIniName => clientDefinitionsIni.GetStringValue(SETTINGS, "SettingsFile", "Settings.ini");
 
         public string TranslationIniName => clientDefinitionsIni.GetStringValue(TRANSLATIONS, nameof(TranslationIniName), "Translation.ini");
@@ -348,6 +372,8 @@ private List<TranslationGameFile> ParseTranslationGameFiles()
 
         public string MPMapsIniPath => SafePath.CombineFilePath(clientDefinitionsIni.GetStringValue(SETTINGS, "MPMapsPath", SafePath.CombineFilePath("INI", "MPMaps.ini")));
 
+        public string[] CoopDifficultyINIPaths => GetCoopDifficultyINIPaths();
+
         public string KeyboardINI => clientDefinitionsIni.GetStringValue(SETTINGS, "KeyboardINI", "Keyboard.ini");
 
         public int MinimumIngameWidth => clientDefinitionsIni.GetIntValue(SETTINGS, "MinimumIngameWidth", 640);

ClientCore/ProgramConstants.cs

@@ -26,8 +26,8 @@ public static class ProgramConstants
 
         public const string QRES_EXECUTABLE = "qres.dat";
 
-        public const string CNCNET_PROTOCOL_REVISION = "R13";
-        public const string LAN_PROTOCOL_REVISION = "RL8";
+        public const string CNCNET_PROTOCOL_REVISION = "R14";
+        public const string LAN_PROTOCOL_REVISION = "RL9";
         public const int LAN_PORT = 1234;
         public const int LAN_INGAME_PORT = 1234;
         public const int LAN_LOBBY_PORT = 1232;
@@ -112,6 +112,7 @@ public static string GetAILevelName(int aiLevel)
 
         // Static fields might be initialized before the translation file is loaded. Change to readonly properties here.
         public static List<string> AI_PLAYER_NAMES => new List<string> { "Easy AI".L10N("Client:Main:EasyAIName"), "Medium AI".L10N("Client:Main:MediumAIName"), "Hard AI".L10N("Client:Main:HardAIName") };
+        public static List<string> DIFFICULTY_NAMES => new List<string> { "Easy".L10N("Client:Main:DifficultyEasy"), "Medium".L10N("Client:Main:DifficultyMedium"), "Hard".L10N("Client:Main:DifficultyHard") };
 
         public static string LogFileName { get; set; }
 

DXMainClient/DXGUI/Campaign/CampaignSelector.cs

@@ -28,8 +28,6 @@ public class CampaignSelector : XNAWindow
 
         private const string SETTINGS_PATH = "Client/CampaignSettings.ini";
 
-        private static string[] DifficultyNames = new string[] { "Easy", "Medium", "Hard" };
-
         private static string[] DifficultyIniPaths = new string[]
         {
             "INI/Map Code/Difficulty Easy.ini",
@@ -364,7 +362,7 @@ private void LaunchMission(Mission mission)
             spawnIni.WriteIniFile();
 
             var difficultyIni = new IniFile(SafePath.CombineFilePath(ProgramConstants.GamePath, DifficultyIniPaths[trbDifficultySelector.Value]));
-            string difficultyName = DifficultyNames[trbDifficultySelector.Value];
+            string difficultyName = ProgramConstants.DIFFICULTY_NAMES[trbDifficultySelector.Value];
 
             if (copyMapsToSpawnmapINI)
             {

DXMainClient/DXGUI/Multiplayer/CnCNet/CnCNetLobby.cs

@@ -1504,7 +1504,7 @@ private void GameBroadcastChannel_CTCPReceived(object sender, ChannelCTCPEventAr
             string msg = e.Message.Substring(5); // Cut out GAME part
             string[] splitMessage = msg.Split(new char[] { ';' });
 
-            if (splitMessage.Length != 13)
+            if (splitMessage.Length != 14)
             {
                 Logger.Log("Ignoring CTCP game message because of an invalid amount of parameters.");
 
@@ -1550,6 +1550,8 @@ private void GameBroadcastChannel_CTCPReceived(object sender, ChannelCTCPEventAr
                 string loadedGameId = splitMessage[10];
                 int skillLevel = int.Parse(splitMessage[11]);
                 string mapHash = splitMessage[12];
+                int difficulty = int.Parse(splitMessage[13]);
+
 
                 CnCNetGame cncnetGame = gameCollection.GameList.Find(g => g.GameBroadcastChannel == channel.ChannelName);
 
@@ -1611,6 +1613,7 @@ private void GameBroadcastChannel_CTCPReceived(object sender, ChannelCTCPEventAr
                 game.Incompatible = cncnetGame == localGame && game.GameVersion != ProgramConstants.GAME_VERSION;
                 game.TunnelServer = tunnel;
                 game.SkillLevel = skillLevel;
+                game.Difficulty = difficulty;
 
                 if (isClosed)
                 {

DXMainClient/DXGUI/Multiplayer/GameInformationPanel.cs

@@ -164,6 +164,9 @@ public void SetInfo(GenericHostedGame game)
             string translatedGameModeName = string.IsNullOrEmpty(game.GameMode)
                 ? "Unknown".L10N("Client:Main:Unknown") : game.GameMode.L10N($"INI:GameModes:{game.GameMode}:UIName", notify: false);
 
+            if (game.Difficulty >= 0 && game.Difficulty < ProgramConstants.DIFFICULTY_NAMES.Count)
+                translatedGameModeName += $" ({ProgramConstants.DIFFICULTY_NAMES[game.Difficulty]})";
+
             lblGameMode.Text = Renderer.GetStringWithLimitedWidth("Game mode:".L10N("Client:Main:GameInfoGameMode") + " " + Renderer.GetSafeString(translatedGameModeName, lblGameMode.FontIndex),
                lblGameMode.FontIndex, Width - lblGameMode.X);
             lblGameMode.Visible = true;

DXMainClient/DXGUI/Multiplayer/GameLobby/CnCNetGameLobby.cs

@@ -1,23 +1,29 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Text;
+using System.Xml.Linq;
+
 using ClientCore;
+using ClientCore.Extensions;
+
 using ClientGUI;
-using DTAClient.Domain.Multiplayer;
+
 using DTAClient.Domain;
+using DTAClient.Domain.Multiplayer;
+using DTAClient.Domain.Multiplayer.CnCNet;
 using DTAClient.DXGUI.Generic;
 using DTAClient.DXGUI.Multiplayer.CnCNet;
 using DTAClient.DXGUI.Multiplayer.GameLobby.CommandHandlers;
 using DTAClient.Online;
 using DTAClient.Online.EventArguments;
+
 using Microsoft.Xna.Framework;
+
 using Rampastring.Tools;
 using Rampastring.XNAUI;
 using Rampastring.XNAUI.XNAControls;
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Linq;
-using System.Text;
-using DTAClient.Domain.Multiplayer.CnCNet;
-using ClientCore.Extensions;
 
 namespace DTAClient.DXGUI.Multiplayer.GameLobby
 {
@@ -1049,6 +1055,7 @@ protected override void OnGameOptionChanged()
             sb.Append(RandomSeed);
             sb.Append(Convert.ToInt32(RemoveStartingLocations));
             sb.Append(Map?.UntranslatedName ?? string.Empty);
+            sb.Append(ddDifficulty?.SelectedIndex ?? -1);
 
             channel.SendCTCPMessage(sb.ToString(), QueuedMessageType.GAME_SETTINGS_MESSAGE, 11);
         }
@@ -1223,6 +1230,15 @@ private void ApplyGameOptions(string sender, string message)
                 Convert.ToInt32(RemoveStartingLocations)));
             SetRandomStartingLocations(removeStartingLocations);
 
+            if (GameMode != null && GameMode.UseDifficultyDropDown && ddDifficulty != null)
+            {
+                int newIndex = Conversions.IntFromString(parts[partIndex + 9], ddDifficulty.SelectedIndex);
+                ddDifficulty.SelectedIndex = newIndex;
+
+                if (ddDifficulty.SelectedIndex >= 0)
+                    AddNotice(string.Format("The game host has set {0} to {1}".L10N("Client:Main:HostSetOption"), "Difficulty".L10N("Client:Main:DifficultyOptionName"), ddDifficulty.SelectedItem.Text));
+            }
+
             RandomSeed = randomSeed;
         }
 
@@ -2086,10 +2102,12 @@ private void BroadcastGame()
             sb.Append(skillLevel); // SkillLevel
             sb.Append(";");
             sb.Append(Map?.SHA1);
+            sb.Append(ddDifficulty?.SelectedIndex ?? -1);
 
             broadcastChannel.SendCTCPMessage(sb.ToString(), QueuedMessageType.SYSTEM_MESSAGE, 20);
         }
 
+
         #endregion
 
         public override string GetSwitchName() => "Game Lobby".L10N("Client:Main:GameLobby");

DXMainClient/DXGUI/Multiplayer/GameLobby/GameLobbyBase.cs

@@ -146,6 +146,8 @@ protected GameModeMap GameModeMap
         protected ToolTip mapListTooltip;
         protected XNAClientDropDown ddGameModeMapFilter;
         protected XNALabel lblGameModeSelect;
+        protected XNAClientDropDown ddDifficulty;
+        protected XNALabel lblDifficulty;
         protected XNAContextMenu mapContextMenu;
         private XNAContextMenuItem toggleFavoriteItem;
 
@@ -173,6 +175,7 @@ protected GameModeMap GameModeMap
         protected int UniqueGameID { get; set; }
         protected int SideCount { get; private set; }
         protected int RandomSelectorCount { get; private set; } = 1;
+        protected int PreviousSelectedDifficulty { get; set; }
 
         protected List<int[]> RandomSelectors = new List<int[]>();
 
@@ -299,6 +302,21 @@ public override void Initialize()
 
             lblGameModeSelect = FindChild<XNALabel>(nameof(lblGameModeSelect));
 
+            ddDifficulty = FindChild<XNAClientDropDown>(nameof(ddDifficulty), true);
+            lblDifficulty = FindChild<XNALabel>(nameof(lblDifficulty), true);
+
+            if (ddDifficulty != null)
+            {
+                // Hardcode difficulty items just in case someone tries something stupid.
+                ddDifficulty.Items.Clear();
+
+                foreach (string difficultyName in ProgramConstants.DIFFICULTY_NAMES)
+                    ddDifficulty.AddItem(difficultyName);
+
+                ddDifficulty.SelectedIndex = -1;
+                ddDifficulty.SelectedIndexChanged += DdDifficulty_SelectedIndexChanged;
+            }
+
             InitBtnMapSort();
 
             tbMapSearch = FindChild<XNASuggestionTextBox>(nameof(tbMapSearch));
@@ -568,9 +586,23 @@ protected void DdGameModeMapFilter_SelectedIndexChanged(object sender, EventArgs
             ListMaps();
 
             if (lbGameModeMapList.SelectedIndex == -1)
+            {
                 lbGameModeMapList.SelectedIndex = 0; // Select default GameModeMap
+                UpdateDifficultyDropdown();
+            }
             else
+            {
                 ChangeMap(GameModeMap);
+            }
+        }
+
+        protected void DdDifficulty_SelectedIndexChanged(object sender, EventArgs e)
+        {
+            if (ddDifficulty.SelectedIndex >= 0)
+                PreviousSelectedDifficulty = ddDifficulty.SelectedIndex;
+
+            OnGameOptionChanged();
+            SetMapLabels();
         }
 
         protected void BtnPlayerExtraOptions_LeftClick(object sender, EventArgs e)
@@ -694,7 +726,7 @@ protected void ListMaps()
                 {
                     // Note: StatisticsManager.Statistics must be initialized to call `HasBeatCoOpMap()`. This means StatisticsWindow must be initialized before any lobbies extending GameLobbyBase.
                     if (StatisticsManager.Instance.HasBeatCoOpMap(gameModeMap.Map.UntranslatedName, gameModeMap.GameMode.UntranslatedUIName))
-                        rankItem.Texture = RankTextures[Math.Abs(2 - gameModeMap.GameMode.CoopDifficultyLevel) + 1];
+                        rankItem.Texture = RankTextures[Math.Abs(2 - GetCoopDifficultyLevel()) + 1];
                     else
                         rankItem.Texture = RankTextures[0];
                 }
@@ -747,6 +779,45 @@ protected void ListMaps()
                 LbGameModeMapList_SelectedIndexChanged();
         }
 
+        protected int GetCoopDifficultyLevel()
+        {
+            var gameMode = GameModeMap?.GameMode;
+
+            if (gameMode != null)
+            {
+                if (gameMode.UseDifficultyDropDown && ddDifficulty != null && ddDifficulty.SelectedIndex >= 0)
+                {
+                    return ddDifficulty.Items.Count - ddDifficulty.SelectedIndex - 1;
+                }
+                else
+                {
+                    return gameMode.CoopDifficultyLevel;
+                }
+            }
+            
+            return 0;
+        }
+
+        protected virtual void UpdateDifficultyDropdown()
+        {
+            bool enabled = GameModeMap != null && GameModeMap.GameMode != null && GameModeMap.GameMode.UseDifficultyDropDown;
+
+            if (ddDifficulty != null)
+            {
+                ddDifficulty.AllowDropDown = enabled;
+
+                if (enabled && ddDifficulty.SelectedIndex < 0)
+                    ddDifficulty.SelectedIndex = PreviousSelectedDifficulty;
+                else if (!enabled)
+                    ddDifficulty.SelectedIndex = -1;
+            }
+
+            if (lblDifficulty != null)
+            {
+                lblDifficulty.TextColor = enabled ? UISettings.ActiveSettings.TextColor : UISettings.ActiveSettings.DisabledItemColor;
+            }
+        }
+
         protected abstract int GetDefaultMapRankIndex(GameModeMap gameModeMap);
 
         private void LbGameModeMapList_RightClick(object sender, EventArgs e)
@@ -1587,7 +1658,7 @@ private PlayerHouseInfo[] WriteSpawnIni()
 
             GameMode.ApplySpawnIniCode(spawnIni); // Forced options from the game mode
             Map.ApplySpawnIniCode(spawnIni, Players.Count + AIPlayers.Count,
-                AIPlayers.Count, GameMode.CoopDifficultyLevel); // Forced options from the map
+                AIPlayers.Count, GetCoopDifficultyLevel()); // Forced options from the map
 
             // Player options
 
@@ -1814,6 +1885,23 @@ private void WriteMap(PlayerHouseInfo[] houseInfos)
                 mapIni.SetStringValue("Basic", "OriginalFilename", mapIniFileName);
             }
 
+            if (GameMode.UseDifficultyDropDown && ddDifficulty != null && ddDifficulty.SelectedIndex >= 0)
+            { 
+                var filePath = string.Empty;
+
+                try
+                {
+                    filePath = ClientConfiguration.Instance.CoopDifficultyINIPaths[ddDifficulty.SelectedIndex];
+                }
+                catch (IndexOutOfRangeException)
+                {
+                    Logger.Log($"CoopDifficultyINIPaths does not contain file path for difficulty index {ddDifficulty.SelectedIndex}");
+                }
+
+                IniFile difficultyIni = new IniFile(filePath);
+                MapCodeHelper.ApplyMapCode(mapIni, difficultyIni);
+            }
+
             foreach (GameLobbyCheckBox checkBox in CheckBoxes)
                 checkBox.ApplyMapCode(mapIni, GameMode);
 
@@ -2315,6 +2403,11 @@ protected virtual void SetMapLabels()
             lblMapAuthor.Text = "By".L10N("Client:Main:AuthorBy") + " " + Renderer.GetSafeString(Map.Author, lblMapAuthor.FontIndex);
             lblGameMode.Text = "Game mode:".L10N("Client:Main:GameModeLabel") + " " + GameMode.UIName;
             lblMapSize.Text = "Size:".L10N("Client:Main:MapSize") + " " + Map.GetSizeString();
+
+            if (GameMode.UseDifficultyDropDown && ddDifficulty != null && ddDifficulty.SelectedIndex >= 0)
+            {
+                lblGameMode.Text += " (" + "Difficulty: ".L10N("Client:Main:DifficultyLabel") + ddDifficulty.SelectedItem.Text + ")";
+            }
         }
 
         /// <summary>
@@ -2333,6 +2426,7 @@ protected virtual void ChangeMap(GameModeMap gameModeMap)
             {
                 MapPreviewBox.GameModeMap = null;
                 OnGameOptionChanged();
+                UpdateDifficultyDropdown();
                 return;
             }
 
@@ -2345,6 +2439,8 @@ protected virtual void ChangeMap(GameModeMap gameModeMap)
             foreach (var checkBox in CheckBoxes)
                 checkBox.AllowChecking = true;
 
+            UpdateDifficultyDropdown();
+
             // We could either pass the CheckBoxes and DropDowns of this class
             // to the Map and GameMode instances and let them apply their forced
             // options, or we could do it in this class with helper functions.