Expand CampaignSelector with support for game options and forced spawn options (CnCNet#818)

* Refactor campaign launcher to use INI class instead of just StreamWriter

Co-authored-by: SadPencil <[email protected]>

* Unify campaign launch routine with game lobby one a bit more

* Improvements to game options and campaign support

- Added basic support for game options in campaign
- Introduced interfaces for the common functionality
- Refactored the code to encapsulate better
- Added `CampaignForcedSpawnIniOptions`

* Add saving of game settings for campaign selector

* Add docs

* Ban disallowed side indices settings from campaign selector

* Redo in a cleaner way

* File-scoped namespace; fix consistency of list parsing

* Post-merge fixes

---------

Co-authored-by: SadPencil <[email protected]>

Author: Metadorius

ClientCore/ClientConfiguration.cs

@@ -382,6 +382,8 @@ public string GetGameExecutableName()
         public string GameLauncherExecutableName => clientDefinitionsIni.GetStringValue(SETTINGS, "GameLauncherExecutableName", string.Empty);
 
         public bool SaveSkirmishGameOptions => clientDefinitionsIni.GetBooleanValue(SETTINGS, "SaveSkirmishGameOptions", false);
+        
+        public bool SaveCampaignGameOptions => clientDefinitionsIni.GetBooleanValue(SETTINGS, "SaveCampaignGameOptions", false);
 
         public bool CreateSavedGamesDirectory => clientDefinitionsIni.GetBooleanValue(SETTINGS, "CreateSavedGamesDirectory", false);
 

DXMainClient/DXGUI/Campaign/CampaignCheckBox.cs

@@ -0,0 +1,51 @@
+using System;
+
+using ClientCore;
+
+using DTAClient.DXGUI.Generic;
+
+using Rampastring.Tools;
+using Rampastring.XNAUI;
+using Rampastring.XNAUI.XNAControls;
+
+namespace DTAClient.DXGUI.Campaign;
+
+public class CampaignCheckBox : GameSessionCheckBox
+{
+    public CampaignCheckBox(WindowManager windowManager) : base (windowManager) { }
+    
+    public override void Initialize()
+    {
+        // Find the campaign selector that this control belongs to and register ourselves as a game option.
+
+        XNAControl parent = Parent;
+        while (true)
+        {
+            if (parent == null)
+                break;
+
+            // oh no, we have a circular class reference here!
+            if (parent is CampaignSelector configView)
+            {
+                configView.CheckBoxes.Add(this);
+                break;
+            }
+
+            parent = parent.Parent;
+        }
+
+        base.Initialize();
+    }
+
+    protected override void ParseControlINIAttribute(IniFile iniFile, string key, string value)
+    {
+        switch (key)
+        {
+            case "CustomIniPath" when !ClientConfiguration.Instance.CopyMissionsToSpawnmapINI:
+                throw new Exception($"Campaign settings can't affect map code if {nameof(ClientConfiguration.Instance.CopyMissionsToSpawnmapINI)} is disabled!\n\n"
+                    + $"Offending setting control: {Name}");
+        }
+        
+        base.ParseControlINIAttribute(iniFile, key, value);
+    }
+}

DXMainClient/DXGUI/Campaign/CampaignDropDown.cs

@@ -0,0 +1,50 @@
+using System;
+
+using ClientCore;
+
+using DTAClient.DXGUI.Generic;
+
+using Rampastring.Tools;
+using Rampastring.XNAUI;
+using Rampastring.XNAUI.XNAControls;
+
+namespace DTAClient.DXGUI.Campaign;
+
+public class CampaignDropDown : GameSessionDropDown
+{
+    public CampaignDropDown(WindowManager windowManager) : base (windowManager) { }
+    
+    public override void Initialize()
+    {
+        // Find the campaign selector that this control belongs to and register ourselves as a game option.
+
+        XNAControl parent = Parent;
+        while (true)
+        {
+            if (parent == null)
+                break;
+
+            // oh no, we have a circular class reference here!
+            if (parent is CampaignSelector configView)
+            {
+                configView.DropDowns.Add(this);
+                break;
+            }
+
+            parent = parent.Parent;
+        }
+
+        base.Initialize();
+    }
+
+    protected override void ParseControlINIAttribute(IniFile iniFile, string key, string value)
+    {
+        if (key == "DataWriteMode" && value.ToUpper() == "MAPCODE" && !ClientConfiguration.Instance.CopyMissionsToSpawnmapINI)
+        {
+            throw new Exception($"Campaign settings can't affect map code if {nameof(ClientConfiguration.Instance.CopyMissionsToSpawnmapINI)} is disabled!\n\n"
+                + $"Offending setting control: {Name}");
+        }
+        
+        base.ParseControlINIAttribute(iniFile, key, value);
+    }
+}

…Client/DXGUI/Generic/CampaignSelector.cs …lient/DXGUI/Campaign/CampaignSelector.csDXMainClient/DXGUI/Generic/CampaignSelector.cs renamed to DXMainClient/DXGUI/Campaign/CampaignSelector.cs DXMainClient/DXGUI/Generic/CampaignSelector.cs renamed to DXMainClient/DXGUI/Campaign/CampaignSelector.cs

@@ -1,24 +1,33 @@
-using ClientCore;
-using Microsoft.Xna.Framework;
 using System;
 using System.Collections.Generic;
-using DTAClient.Domain;
+using System.Globalization;
 using System.IO;
+
+using ClientCore;
+using ClientCore.Enums;
+using ClientCore.Extensions;
+
 using ClientGUI;
-using Rampastring.XNAUI.XNAControls;
-using Rampastring.XNAUI;
-using Rampastring.Tools;
+
 using ClientUpdater;
-using ClientCore.Extensions;
-using ClientCore.Enums;
 
-namespace DTAClient.DXGUI.Generic
+using DTAClient.Domain;
+
+using Microsoft.Xna.Framework;
+
+using Rampastring.Tools;
+using Rampastring.XNAUI;
+using Rampastring.XNAUI.XNAControls;
+
+namespace DTAClient.DXGUI.Campaign
 {
     public class CampaignSelector : XNAWindow
     {
         private const int DEFAULT_WIDTH = 650;
         private const int DEFAULT_HEIGHT = 600;
 
+        private const string SETTINGS_PATH = "Client/CampaignSettings.ini";
+
         private static string[] DifficultyNames = new string[] { "Easy", "Medium", "Hard" };
 
         private static string[] DifficultyIniPaths = new string[]
@@ -42,6 +51,11 @@ public CampaignSelector(WindowManager windowManager, DiscordHandler discordHandl
         private XNATrackbar trbDifficultySelector;
 
         private CheaterWindow cheaterWindow;
+        
+        public List<CampaignCheckBox> CheckBoxes { get; } = new();
+        public List<CampaignDropDown> DropDowns { get; } = new();
+        
+        private IniFile gameOptionsIni;
 
         private string[] filesToCheck = new string[]
         {
@@ -171,6 +185,9 @@ public override void Initialize()
             AddChild(lblNormal);
             AddChild(lblHard);
 
+            gameOptionsIni = new IniFile(SafePath.CombineFilePath(ProgramConstants.GetBaseResourcePath(),
+                ClientConfiguration.GAME_OPTIONS));
+
             // Set control attributes from INI file
             base.Initialize();
 
@@ -189,6 +206,8 @@ public override void Initialize()
             cheaterWindow.CenterOnParent();
             cheaterWindow.YesClicked += CheaterWindow_YesClicked;
             cheaterWindow.Disable();
+            
+            LoadSettings();
         }
 
         private void LbCampaignList_SelectedIndexChanged(object sender, EventArgs e)
@@ -222,11 +241,14 @@ private void LbCampaignList_SelectedIndexChanged(object sender, EventArgs e)
 
         private void BtnCancel_LeftClick(object sender, EventArgs e)
         {
+            SaveSettings();
             Disable();
         }
 
         private void BtnLaunch_LeftClick(object sender, EventArgs e)
         {
+            SaveSettings();
+            
             int selectedMissionId = lbCampaignList.SelectedIndex;
 
             Mission mission = Missions[selectedMissionId];
@@ -268,54 +290,94 @@ private void CheaterWindow_YesClicked(object sender, EventArgs e)
         /// </summary>
         private void LaunchMission(Mission mission)
         {
+            string scenario = mission.Scenario;
+            
+            FileInfo spawnerSettingsFile = SafePath.GetFile(ProgramConstants.GamePath, ProgramConstants.SPAWNER_SETTINGS);
+
+            spawnerSettingsFile.Delete();
+
             bool copyMapsToSpawnmapINI = ClientConfiguration.Instance.CopyMissionsToSpawnmapINI;
 
             Logger.Log("About to write spawn.ini.");
-            using (var spawnStreamWriter = new StreamWriter(SafePath.CombineFilePath(ProgramConstants.GamePath, "spawn.ini")))
+            IniFile spawnIni = new(spawnerSettingsFile.FullName)
             {
-                spawnStreamWriter.WriteLine("; Generated by DTA Client");
-                spawnStreamWriter.WriteLine("[Settings]");
-                if (copyMapsToSpawnmapINI)
-                    spawnStreamWriter.WriteLine("Scenario=spawnmap.ini");
-                else
-                    spawnStreamWriter.WriteLine("Scenario=" + mission.Scenario);
-
-                // No one wants to play missions on Fastest, so we'll change it to Faster
-                if (UserINISettings.Instance.GameSpeed == 0)
-                    UserINISettings.Instance.GameSpeed.Value = 1;
-
-                spawnStreamWriter.WriteLine("CampaignID=" + mission.CampaignID);
-                spawnStreamWriter.WriteLine("GameSpeed=" + UserINISettings.Instance.GameSpeed);
-
-                if (ClientConfiguration.Instance.ClientGameType == ClientType.YR ||
-                    ClientConfiguration.Instance.ClientGameType == ClientType.Ares)
-                    spawnStreamWriter.WriteLine("Ra2Mode=" + !mission.RequiredAddon);
-                else if (ClientConfiguration.Instance.ClientGameType == ClientType.TS)
-                    spawnStreamWriter.WriteLine("Firestorm=" + mission.RequiredAddon);
-      
-                spawnStreamWriter.WriteLine("CustomLoadScreen=" + LoadingScreenController.GetLoadScreenName(mission.Side.ToString()));
-                spawnStreamWriter.WriteLine("IsSinglePlayer=Yes");
-                spawnStreamWriter.WriteLine("SidebarHack=" + ClientConfiguration.Instance.SidebarHack);
-                spawnStreamWriter.WriteLine("Side=" + mission.Side);
-                spawnStreamWriter.WriteLine("BuildOffAlly=" + mission.BuildOffAlly);
-
-                UserINISettings.Instance.Difficulty.Value = trbDifficultySelector.Value;
-
-                spawnStreamWriter.WriteLine("DifficultyModeHuman=" + (mission.PlayerAlwaysOnNormalDifficulty ? "1" : trbDifficultySelector.Value.ToString()));
-                spawnStreamWriter.WriteLine("DifficultyModeComputer=" + GetComputerDifficulty());
-
-                spawnStreamWriter.WriteLine();
-                spawnStreamWriter.WriteLine();
-                spawnStreamWriter.WriteLine();
+                Comment = "Generated by CnCNet Client"
+            };
+            IniSection spawnIniSettings = new("Settings");
+
+            if (copyMapsToSpawnmapINI)
+                spawnIniSettings.AddKey("Scenario", "spawnmap.ini");
+            else
+                spawnIniSettings.AddKey("Scenario", scenario.ToUpperInvariant());
+
+            // No one wants to play missions on Fastest, so we'll change it to Faster
+            if (UserINISettings.Instance.GameSpeed == 0)
+                UserINISettings.Instance.GameSpeed.Value = 1;
+
+            spawnIniSettings.AddKey("CampaignID", mission.CampaignID.ToString(CultureInfo.InvariantCulture));
+            spawnIniSettings.AddKey("GameSpeed", UserINISettings.Instance.GameSpeed.ToString());
+
+            switch (ClientConfiguration.Instance.ClientGameType)
+            {
+                case ClientType.YR or ClientType.Ares:
+                    spawnIniSettings.AddKey("Ra2Mode", (!mission.RequiredAddon).ToString(CultureInfo.InvariantCulture));
+                    break;
+                case ClientType.TS:
+                    spawnIniSettings.AddKey("Firestorm", mission.RequiredAddon.ToString(CultureInfo.InvariantCulture));
+                    break;
+                // TODO figure out the RA one
+            }
+
+            spawnIniSettings.AddKey("CustomLoadScreen", LoadingScreenController.GetLoadScreenName(mission.Side.ToString()));
+
+            spawnIniSettings.AddKey("IsSinglePlayer", "Yes");
+            spawnIniSettings.AddKey("SidebarHack", ClientConfiguration.Instance.SidebarHack.ToString(CultureInfo.InvariantCulture));
+            spawnIniSettings.AddKey("Side", mission.Side.ToString(CultureInfo.InvariantCulture));
+            spawnIniSettings.AddKey("BuildOffAlly", mission.BuildOffAlly.ToString(CultureInfo.InvariantCulture));
+
+            UserINISettings.Instance.Difficulty.Value = trbDifficultySelector.Value;
+
+            spawnIniSettings.AddKey("DifficultyModeHuman", mission.PlayerAlwaysOnNormalDifficulty ? "1" : trbDifficultySelector.Value.ToString(CultureInfo.InvariantCulture));
+            spawnIniSettings.AddKey("DifficultyModeComputer", GetComputerDifficulty().ToString(CultureInfo.InvariantCulture));
+
+            spawnIni.AddSection(spawnIniSettings);
+            
+            foreach (CampaignCheckBox chkBox in CheckBoxes)
+                chkBox.ApplySpawnIniCode(spawnIni);
+
+            foreach (CampaignDropDown dd in DropDowns)
+                dd.ApplySpawnIniCode(spawnIni);
+
+            // Apply forced options from GameOptions.ini
+
+            List<string> forcedKeys = gameOptionsIni.GetSectionKeys("CampaignForcedSpawnIniOptions");
+
+            if (forcedKeys != null)
+            {
+                foreach (string key in forcedKeys)
+                {
+                    spawnIni.SetStringValue("Settings", key,
+                        gameOptionsIni.GetStringValue("CampaignForcedSpawnIniOptions", key, String.Empty));
+                }
             }
 
+            spawnIni.WriteIniFile();
+
             var difficultyIni = new IniFile(SafePath.CombineFilePath(ProgramConstants.GamePath, DifficultyIniPaths[trbDifficultySelector.Value]));
             string difficultyName = DifficultyNames[trbDifficultySelector.Value];
 
             if (copyMapsToSpawnmapINI)
             {
                 var mapIni = new IniFile(SafePath.CombineFilePath(ProgramConstants.GamePath, mission.Scenario));
+                
                 IniFile.ConsolidateIniFiles(mapIni, difficultyIni);
+                
+                foreach (CampaignCheckBox chkBox in CheckBoxes)
+                    chkBox.ApplyMapCode(mapIni, gameMode: null);
+                
+                foreach (CampaignDropDown dd in DropDowns)
+                    dd.ApplyMapCode(mapIni, gameMode: null);
+                
                 mapIni.WriteIniFile(SafePath.CombineFilePath(ProgramConstants.GamePath, "spawnmap.ini"));
             }
 
@@ -420,6 +482,58 @@ private bool ParseBattleIni(string path)
             Logger.Log("Finished parsing " + path + ".");
             return true;
         }
+        
+        /// <summary>
+        /// Saves settings to an INI file on the file system.
+        /// </summary>
+        private void SaveSettings()
+        {
+            if (!ClientConfiguration.Instance.SaveCampaignGameOptions)
+                return;
+
+            try
+            {
+                FileInfo settingsFileInfo = SafePath.GetFile(ProgramConstants.GamePath, SETTINGS_PATH);
+
+                settingsFileInfo.Delete();
+
+                var settingsIni = new IniFile(settingsFileInfo.FullName);
+                
+                foreach (CampaignDropDown dd in DropDowns)
+                    settingsIni.SetStringValue("GameOptions", dd.Name, dd.SelectedIndex.ToString());
+
+                foreach (CampaignCheckBox cb in CheckBoxes)
+                    settingsIni.SetStringValue("GameOptions", cb.Name, cb.Checked.ToString());
+
+                settingsIni.WriteIniFile();
+            }
+            catch (Exception ex)
+            {
+                Logger.Log($"Saving campaign settings failed! Reason: {ex}");
+            }
+        }
+        
+        /// <summary>
+        /// Loads settings from an INI file on the file system.
+        /// </summary>
+        private void LoadSettings()
+        {
+            if (!ClientConfiguration.Instance.SaveCampaignGameOptions)
+                return;
+
+            var settingsIni = new IniFile(SafePath.CombineFilePath(ProgramConstants.GamePath, SETTINGS_PATH));
+                
+            foreach (CampaignDropDown dd in DropDowns)
+            {
+                dd.SelectedIndex = settingsIni.GetIntValue("GameOptions", dd.Name, dd.SelectedIndex);
+
+                if (dd.SelectedIndex > -1 && dd.SelectedIndex < dd.Items.Count)
+                    dd.SelectedIndex = dd.SelectedIndex;
+            }
+
+            foreach (CampaignCheckBox cb in CheckBoxes)
+                cb.Checked = settingsIni.GetBooleanValue("GameOptions", cb.Name, cb.Checked);
+        }
 
         public override void Draw(GameTime gameTime)
         {