Merge branch 'CnCNet:develop' into develop

Author: CO2-code

.github/workflows/build.yml

@@ -13,9 +13,10 @@ jobs:
     - uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: recursive
 
     - name: Setup .NET SDK
-      uses: actions/setup-dotnet@v4
+      uses: actions/setup-dotnet@v5
       with:
         global-json-file: ./global.json
 

.github/workflows/release-build.yml

@@ -4,6 +4,9 @@ on:
   release:
     types: [published]
 
+permissions:
+  contents: write
+
 jobs:
   build:
     runs-on: windows-2022
@@ -13,24 +16,34 @@ jobs:
       uses: actions/checkout@v4
       with:
         fetch-depth: 0
+        submodules: recursive
 
     - name: Setup .NET SDK
-      uses: actions/setup-dotnet@v4
+      uses: actions/setup-dotnet@v5
       with:
         global-json-file: ./global.json
 
-    - name: Build
-      run: ./Scripts/build.ps1
-      shell: pwsh
+    - name: Install GitVersion
+      uses: gittools/actions/gitversion/setup@v0
+      with:
+        versionSpec: '5.x'
+
+    - name: Determine Version
+      uses: gittools/actions/gitversion/execute@v0
 
     - name: Development Build Check
+      if: "!github.event.release.prerelease"
       shell: pwsh
       run: |
         if ($env:GitVersion_CommitsSinceVersionSource -ne "0") {
           Write-Output "::error:: This is a development build and should not be released. Did you forget to create a new tag for the release?"
           exit 1
         }
 
+    - name: Build
+      run: ./Scripts/build.ps1
+      shell: pwsh
+
     - name: Zip Artifact
       run: 7z a -t7z -mx=9 -m0=lzma2 -ms=on -r -- ${{ format('xna-cncnet-client-{0}.7z', env.GitVersion_SemVer) }} ./Compiled/*
       shell: pwsh

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "Rampastring.XNAUI"]
+	path = Rampastring.XNAUI
+	url = https://github.com/CnCNet/Rampastring.XNAUI.git

ClientCore/ClientConfiguration.cs

@@ -90,7 +90,18 @@ public void RefreshSettings()
 
         #region Client settings
 
-        public string MainMenuMusicName => SafePath.CombineFilePath(DTACnCNetClient_ini.GetStringValue(GENERAL, "MainMenuTheme", "mainmenu"));
+        private string _mainMenuMusicName = null;
+        public string MainMenuMusicName => _mainMenuMusicName ??= GetMainMenuMusicName();
+        private string GetMainMenuMusicName()
+        {
+            string raw = DTACnCNetClient_ini.GetStringValue(GENERAL, "MainMenuTheme", "mainmenu");
+            string[] parts = raw.SplitWithCleanup();
+            string chosen = parts.Length > 0
+                ? parts[new Random().Next(parts.Length)]
+                : "mainmenu";
+
+            return SafePath.CombineFilePath(chosen);
+        }
 
         public float DefaultAlphaRate => DTACnCNetClient_ini.GetSingleValue(GENERAL, "AlphaRate", 0.005f);
 
@@ -258,13 +269,17 @@ public void RefreshSettings()
 
         public bool UseBuiltStatistic => clientDefinitionsIni.GetBooleanValue(SETTINGS, "UseBuiltStatistic", false);
 
+        public string WindowedModeKey => clientDefinitionsIni.GetStringValue(SETTINGS, "WindowedModeKey", "Video.Windowed");
+
         public bool CopyResolutionDependentLanguageDLL => clientDefinitionsIni.GetBooleanValue(SETTINGS, "CopyResolutionDependentLanguageDLL", true);
 
         public string StatisticsLogFileName => clientDefinitionsIni.GetStringValue(SETTINGS, "StatisticsLogFileName", "DTA.LOG");
 
         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 bool ShowGameIconInGameList => clientDefinitionsIni.GetBooleanValue(SETTINGS, "ShowGameIconInGameList", true);
 
         public (string Name, string Path) GetThemeInfoFromIndex(int themeIndex) => clientDefinitionsIni.GetStringValue("Themes", themeIndex.ToString(), ",").Split(',').AsTuple2();
 
@@ -369,9 +384,13 @@ private List<TranslationGameFile> ParseTranslationGameFiles()
         public bool InactiveHostKickEnabled => InactiveHostWarningMessageSeconds > 0 && InactiveHostKickSeconds > 0;
 
         public string SkillLevelOptions => clientDefinitionsIni.GetStringValue(SETTINGS, "SkillLevelOptions", "Any,Beginner,Intermediate,Pro");
-        
+
         public int DefaultSkillLevelIndex => clientDefinitionsIni.GetIntValue(SETTINGS, "DefaultSkillLevelIndex", 0);
-        
+
+        public bool CampaignTagSelectorEnabled => clientDefinitionsIni.GetBooleanValue(SETTINGS, "CampaignTagSelectorEnabled", false);
+
+        public bool ReturnToMainMenuOnMissionLaunch => clientDefinitionsIni.GetBooleanValue(SETTINGS, "ReturnToMainMenuOnMissionLaunch", true);
+
         public string GetGameExecutableName()
         {
             string[] exeNames = clientDefinitionsIni.GetStringListValue(SETTINGS, "GameExecutableNames", "Game.exe");
@@ -381,8 +400,15 @@ public string GetGameExecutableName()
 
         public string GameLauncherExecutableName => clientDefinitionsIni.GetStringValue(SETTINGS, "GameLauncherExecutableName", string.Empty);
 
+        public string[] GetCompatibilityCheckExecutables()
+        {
+            string[] exeNames = clientDefinitionsIni.GetStringListValue(SETTINGS, "CompatibilityCheckExecutables", string.Empty);
+
+            return exeNames;
+        }
+
         public bool SaveSkirmishGameOptions => clientDefinitionsIni.GetBooleanValue(SETTINGS, "SaveSkirmishGameOptions", false);
-        
+
         public bool SaveCampaignGameOptions => clientDefinitionsIni.GetBooleanValue(SETTINGS, "SaveCampaignGameOptions", false);
 
         public bool CreateSavedGamesDirectory => clientDefinitionsIni.GetBooleanValue(SETTINGS, "CreateSavedGamesDirectory", false);
@@ -420,7 +446,7 @@ public string GetGameExecutableName()
         /// The main map file extension that is read by the client.
         /// </summary>
         public string MapFileExtension => clientDefinitionsIni.GetStringValue(SETTINGS, "MapFileExtension", "map");
-        
+
         /// <summary>
         /// This tells the client which supplemental map files are ok to copy over during "spawnmap.ini" file creation.
         /// IE, if "BIN" is listed, then the client will look for and copy the file "map_a.bin"
@@ -505,6 +531,43 @@ public List<string> GetIRCServers()
 
         public bool DiscordIntegrationGloballyDisabled => string.IsNullOrWhiteSpace(DiscordAppId) || DisableDiscordIntegration;
 
+        public string CustomMissionPath => clientDefinitionsIni.GetStringValue(SETTINGS, "CustomMissionPath", "Maps/CustomMissions");
+
+        public List<(string extension, string copyAs)> GetCustomMissionSupplementFiles()
+        {
+            List<(string extension, string copyAs)> files = new();
+            Dictionary<string, int> extensionToIndex = new(StringComparer.OrdinalIgnoreCase);
+
+            int index = 0;
+            while (true)
+            {
+                string extensionKey = $"CustomMissionSupplementFile{index}Extension";
+                string copyAsKey = $"CustomMissionSupplementFile{index}CopyAs";
+
+                string extension = clientDefinitionsIni.GetStringValue(SETTINGS, extensionKey, null)?.Trim();
+
+                // Stop iteration if the extension key is missing
+                if (string.IsNullOrWhiteSpace(extension))
+                    break;
+
+                string copyAs = clientDefinitionsIni.GetStringValue(SETTINGS, copyAsKey, null);
+
+                // Validate that copyAs is not empty
+                if (string.IsNullOrWhiteSpace(copyAs))
+                    throw new ClientConfigurationException($"Configuration key '{copyAsKey}' is required when '{extensionKey}' is present for supplement file {index}.");
+
+                // Validate that extension is unique
+                if (extensionToIndex.TryGetValue(extension, out int firstIndex))
+                    throw new ClientConfigurationException($"Duplicate extension '{extension}' found in supplement files. Extension is used in both file {firstIndex} and file {index}.");
+
+                extensionToIndex.Add(extension, index);
+                files.Add((extension, copyAs));
+                index++;
+            }
+
+            return files;
+        }
+
         public OSVersion GetOperatingSystemVersion()
         {
 #if NETFRAMEWORK
@@ -567,4 +630,4 @@ public ClientConfigurationException(string message) : base(message)
         {
         }
     }
-}
+}

ClientCore/ClientCore.csproj

@@ -3,8 +3,10 @@
     <Description>CnCNet Client Core Library</Description>
   </PropertyGroup>
   <ItemGroup>
-    <PackageReference Include="Rampastring.Tools" />
     <PackageReference Include="System.Text.Encoding.CodePages" />
     <PackageReference Include="Ude.NetStandard" />
   </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\Rampastring.XNAUI\Rampastring.Tools\Rampastring.Tools.csproj" />
+  </ItemGroup>
 </Project>

ClientCore/Extensions/IniFileExtensions.cs

@@ -1,58 +1,79 @@
-using System.Collections.Generic;
+#nullable enable
+
+using System;
+using System.Collections.Generic;
 using System.Linq;
-using System.Runtime.CompilerServices;
 
 using Rampastring.Tools;
 
 namespace ClientCore.Extensions
 {
     public static class IniFileExtensions
     {
-        // Clone() method is not officially available now. https://github.com/Rampastring/Rampastring.Tools/issues/12
-        public static IniFile Clone(this IniFile oldIniFile)
+        extension(IniFile iniFile)
         {
-            var newIni = new IniFile();
-            foreach (string sectionName in oldIniFile.GetSections())
+            // Clone() method is not officially available now. https://github.com/Rampastring/Rampastring.Tools/issues/12
+            public IniFile Clone()
+            {
+                var newIni = new IniFile();
+                foreach (string sectionName in iniFile.GetSections())
+                {
+                    IniSection oldSection = iniFile.GetSection(sectionName);
+                    newIni.AddSection(oldSection.Clone());
+                }
+
+                return newIni;
+            }
+
+            public IniSection GetOrAddSection(string sectionName)
             {
-                IniSection oldSection = oldIniFile.GetSection(sectionName);
-                newIni.AddSection(oldSection.Clone());
+                var section = iniFile.GetSection(sectionName);
+                if (section != null)
+                    return section;
+
+                section = new IniSection(sectionName);
+                iniFile.AddSection(section);
+                return section;
             }
 
-            return newIni;
+            public string[] GetStringListValue(string section, string key, string defaultValue, char[]? separators = null)
+                => (iniFile.GetSection(section)?.GetStringValue(key, defaultValue) ?? defaultValue)
+                    .SplitWithCleanup(separators);
+
         }
 
-        public static IniSection Clone(this IniSection oldSection)
+        extension(IniSection iniSection)
         {
-            IniSection newSection = new(oldSection.SectionName);
-
-            foreach ((var key, var value) in oldSection.Keys)
+            public IniSection Clone()
             {
-                newSection.AddKey(key, value);
+                IniSection newSection = new(iniSection.SectionName);
+
+                foreach ((var key, var value) in iniSection.Keys)
+                {
+                    newSection.AddKey(key, value);
+                }
+
+                return newSection;
             }
 
-            return newSection;
-        }
+            public void RemoveAllKeys()
+            {
+                var keys = new List<KeyValuePair<string, string>>(iniSection.Keys);
+                foreach (KeyValuePair<string, string> iniSectionKey in keys)
+                    iniSection.RemoveKey(iniSectionKey.Key);
+            }
+            
+            public string? GetStringValueOrNull(string key) =>
+                iniSection.KeyExists(key) ? iniSection.GetStringValue(key, string.Empty) : null;
 
-        public static IniSection GetOrAddSection(this IniFile iniFile, string sectionName)
-        {
-            var section = iniFile.GetSection(sectionName);
-            if (section != null)
-                return section;
+            public int? GetIntValueOrNull(string key) =>
+                iniSection.KeyExists(key) ? iniSection.GetIntValue(key, 0) : null;
 
-            section = new IniSection(sectionName);
-            iniFile.AddSection(section);
-            return section;
-        }
+            public bool? GetBooleanValueOrNull(string key) =>
+                iniSection.KeyExists(key) ? iniSection.GetBooleanValue(key, false) : null;
 
-        public static void RemoveAllKeys(this IniSection iniSection)
-        {
-            var keys = new List<KeyValuePair<string, string>>(iniSection.Keys);
-            foreach (KeyValuePair<string, string> iniSectionKey in keys)
-                iniSection.RemoveKey(iniSectionKey.Key);
+            public List<T>? GetListValueOrNull<T>(string key, char separator, Func<string, T> converter) =>
+                iniSection.KeyExists(key) ? iniSection.GetListValue<T>(key, separator, converter) : null;
         }
-
-        public static string[] GetStringListValue(this IniFile iniFile, string section, string key, string defaultValue, char[] separators = null)
-            => (iniFile.GetSection(section)?.GetStringValue(key, defaultValue) ?? defaultValue)
-                .SplitWithCleanup();
     }
 }

ClientCore/ProgramConstants.cs

@@ -26,7 +26,7 @@ public static class ProgramConstants
 
         public const string QRES_EXECUTABLE = "qres.dat";
 
-        public const string CNCNET_PROTOCOL_REVISION = "R13";
+        public const string CNCNET_PROTOCOL_REVISION = "R14";
         public const string LAN_PROTOCOL_REVISION = "RL8";
         public const int LAN_PORT = 1234;
         public const int LAN_INGAME_PORT = 1234;