Merge pull request #707 from CnCNet/develop

Release 2.12.0

Author: SadPencil

.github/workflows/build.yml

@@ -9,13 +9,6 @@ on:
 jobs:
   build-clients:
     runs-on: windows-2022
-    strategy:
-      matrix:
-        Game: 
-          - Ares
-          - TS
-          - YR
-
     steps:
     - uses: actions/checkout@v4
       with:
@@ -26,13 +19,12 @@ jobs:
       with:
         global-json-file: ./global.json
 
-    - name: Build ${{matrix.Game}}
-      run: ./Scripts/build.ps1 ${{matrix.Game}}
+    - name: Build
+      run: ./Scripts/build.ps1
       shell: pwsh
 
     - uses: actions/upload-artifact@v4
       name: Upload Artifacts
       with:
-        name: artifacts-${{matrix.Game}}
-        path: ./Compiled/${{matrix.Game}}
-
+        name: artifacts
+        path: ./Compiled

.github/workflows/release-build.yml

@@ -0,0 +1,42 @@
+name: release build
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    runs-on: windows-2022
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Setup .NET SDK
+      uses: actions/setup-dotnet@v4
+      with:
+        global-json-file: ./global.json
+
+    - name: Build
+      run: ./Scripts/build.ps1
+      shell: pwsh
+
+    - name: Development Build Check
+      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: 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
+
+    - name: Upload Final Artifact to the Release
+      uses: softprops/action-gh-release@v2
+      with:
+        append_body: true
+        files: ${{ format('xna-cncnet-client-{0}.7z', env.GitVersion_SemVer) }}

ClientCore/ClientConfiguration.cs

@@ -6,6 +6,7 @@
 using System.Runtime.InteropServices;
 using ClientCore.I18N;
 using ClientCore.Extensions;
+using ClientCore.Enums;
 
 namespace ClientCore
 {
@@ -187,6 +188,10 @@ public void RefreshSettings()
 
         #region Client definitions
 
+        private string _ClientGameTypeString => clientDefinitionsIni.GetStringValue(SETTINGS, "ClientGameType", string.Empty);
+        private ClientType? _ClientGameType = null;
+        public ClientType ClientGameType => _ClientGameType ??= ClientTypeHelper.FromString(_ClientGameTypeString);
+
         public string DiscordAppId => clientDefinitionsIni.GetStringValue(SETTINGS, "DiscordAppId", string.Empty);
 
         public int SendSleep => clientDefinitionsIni.GetIntValue(SETTINGS, "SendSleep", 2500);
@@ -397,6 +402,11 @@ public string GetGameExecutableName()
         /// </summary>
         public string[] ForbiddenFiles => clientDefinitionsIni.GetStringValue(SETTINGS, "ForbiddenFiles", String.Empty).Split(',');
 
+        /// <summary>
+        /// 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"

ClientCore/ClientCore.csproj

@@ -11,5 +11,6 @@
     <PackageReference Include="Rampastring.XNAUI.$(Engine)" Condition="'!$(Configuration.Contains(Debug))'" />
     <PackageReference Include="Rampastring.XNAUI.$(Engine).Debug" Condition="'$(Configuration.Contains(Debug))'" />
     <PackageReference Include="System.Text.Encoding.CodePages" />
+    <PackageReference Include="Ude.NetStandard" />
   </ItemGroup>
 </Project>

ClientCore/Enums/ClientType.cs

@@ -0,0 +1,9 @@
+namespace ClientCore.Enums
+{
+    public enum ClientType
+    {
+        TS,
+        YR,
+        Ares,
+    }
+}

ClientCore/Enums/ClientTypeHelper.cs

@@ -0,0 +1,15 @@
+using System;
+
+namespace ClientCore.Enums
+{
+    public static class ClientTypeHelper
+    {
+        public static ClientType FromString(string value) => value switch
+        {
+            "TS" => ClientType.TS,
+            "YR" => ClientType.YR,
+            "Ares" => ClientType.Ares,
+            _ => throw new Exception("It seems the client configuration was not migrated to accommodate for the v2.12 changes. Please specify 'ClientGameType' in `[Settings]` section of the 'ClientDefinitions.ini' file, e.g., 'ClientGameType=Ares'."),
+        };
+    }
+}

ClientCore/Extensions/StringExtensions.cs

@@ -1,4 +1,6 @@
 using System;
+using System.Collections.Generic;
+
 using ClientCore.I18N;
 
 namespace ClientCore.Extensions;
@@ -77,4 +79,38 @@ public static string L10N(this string defaultValue, string key, bool notify = tr
         => string.IsNullOrEmpty(defaultValue)
             ? defaultValue
             : Translation.Instance.LookUp(key, defaultValue, notify);
+
+    /// <summary>
+    /// Replace special characters with spaces in the filename to avoid conflicts with WIN32API.
+    /// </summary>
+    /// <param name="defaultValue">The default string value.</param>
+    /// <returns>File name without special characters or reserved combinations.</returns>
+    /// <remarks>
+    /// Reference: <a href="https://learn.microsoft.com/en-us/windows/win32/fileio/naming-a-file">Naming Files, Paths, and Namespaces</a>.
+    /// </remarks>
+    public static string ToWin32FileName(this string filename)
+    {
+        foreach (char ch in "/\\:*?<>|")
+            filename = filename.Replace(ch, '_');
+
+        // If the user is somehow using "con" or any other filename that is
+        // reserved by WIN32API, it would be better to rename it.
+
+        HashSet<string> reservedFileNames = new HashSet<string>(new List<string>(){
+            "CON",
+            "PRN",
+            "AUX",
+            "NUL",
+            "COM1", "COM2", "COM3", "COM4", "COM5", "COM6", "COM7", "COM8", "COM9", "COM¹", "COM²", "COM³",
+            "LPT1", "LPT2", "LPT3", "LPT4", "LPT5", "LPT6", "LPT7", "LPT8", "LPT9", "LPT¹", "LPT²", "LPT³"
+        }, StringComparer.InvariantCultureIgnoreCase);
+
+        if (reservedFileNames.Contains(filename))
+            filename += "_";
+
+        return filename;
+    }
+  
+      public static T ToEnum<T>(this string value) where T : Enum 
+        => (T)Enum.Parse(typeof(T), value, true);
 }

ClientCore/FileHelper.cs

@@ -90,5 +90,21 @@ public static void CreateHardLinkFromSource(string source, string destination, b
                 throw new PlatformNotSupportedException();
             }
         }
+
+        public static Encoding GetEncoding(string filename)
+        {
+            Encoding encoding = new UTF8Encoding(false);
+
+            using (FileStream fs = File.OpenRead(filename))
+            {
+                Ude.CharsetDetector cdet = new Ude.CharsetDetector();
+                cdet.Feed(fs);
+                cdet.DataEnd();
+                if (cdet.Charset != null)
+                    encoding = Encoding.GetEncoding(cdet.Charset);
+            }
+
+            return encoding;
+        }
     }
 }

ClientCore/Settings/UserINISettings.cs

@@ -49,11 +49,11 @@ protected UserINISettings(IniFile iniFile)
             SettingsIni = iniFile;
 
             const string WINDOWED_MODE_KEY = "Video.Windowed";
-#if TS
-            BackBufferInVRAM = new BoolSetting(iniFile, VIDEO, "UseGraphicsPatch", true);
-#else
-            BackBufferInVRAM = new BoolSetting(iniFile, VIDEO, "VideoBackBuffer", false);
-#endif
+
+            if (ClientConfiguration.Instance.ClientGameType == ClientType.TS)
+                BackBufferInVRAM = new BoolSetting(iniFile, VIDEO, "UseGraphicsPatch", true);
+            else
+                BackBufferInVRAM = new BoolSetting(iniFile, VIDEO, "VideoBackBuffer", false);
 
             IngameScreenWidth = new IntSetting(iniFile, VIDEO, "ScreenWidth", 1024);
             IngameScreenHeight = new IntSetting(iniFile, VIDEO, "ScreenHeight", 768);
@@ -75,6 +75,7 @@ protected UserINISettings(IniFile iniFile)
             ClientVolume = new DoubleSetting(iniFile, AUDIO, "ClientVolume", 1.0);
             PlayMainMenuMusic = new BoolSetting(iniFile, AUDIO, "PlayMainMenuMusic", true);
             StopMusicOnMenu = new BoolSetting(iniFile, AUDIO, "StopMusicOnMenu", true);
+            StopGameLobbyMessageAudio = new BoolSetting(iniFile, AUDIO, "StopGameLobbyMessageAudio", true);
             MessageSound = new BoolSetting(iniFile, AUDIO, "ChatMessageSound", true);
 
             ScrollRate = new IntSetting(iniFile, OPTIONS, "ScrollRate", 3);
@@ -93,6 +94,7 @@ protected UserINISettings(IniFile iniFile)
             PersistentMode = new BoolSetting(iniFile, MULTIPLAYER, "PersistentMode", false);
             AutomaticCnCNetLogin = new BoolSetting(iniFile, MULTIPLAYER, "AutomaticCnCNetLogin", false);
             DiscordIntegration = new BoolSetting(iniFile, MULTIPLAYER, "DiscordIntegration", true);
+            SteamIntegration = new BoolSetting(iniFile, MULTIPLAYER, "SteamIntegration", true);
             AllowGameInvitesFromFriendsOnly = new BoolSetting(iniFile, MULTIPLAYER, "AllowGameInvitesFromFriendsOnly", false);
             NotifyOnUserListChange = new BoolSetting(iniFile, MULTIPLAYER, "NotifyOnUserListChange", true);
             DisablePrivateMessagePopups = new BoolSetting(iniFile, MULTIPLAYER, "DisablePrivateMessagePopups", false);
@@ -167,6 +169,7 @@ protected UserINISettings(IniFile iniFile)
         public DoubleSetting ClientVolume { get; private set; }
         public BoolSetting PlayMainMenuMusic { get; private set; }
         public BoolSetting StopMusicOnMenu { get; private set; }
+        public BoolSetting StopGameLobbyMessageAudio { get; private set; }
         public BoolSetting MessageSound { get; private set; }
 
         /********/
@@ -194,6 +197,7 @@ protected UserINISettings(IniFile iniFile)
         public BoolSetting PersistentMode { get; private set; }
         public BoolSetting AutomaticCnCNetLogin { get; private set; }
         public BoolSetting DiscordIntegration { get; private set; }
+        public BoolSetting SteamIntegration { get; private set; }
         public BoolSetting AllowGameInvitesFromFriendsOnly { get; private set; }
 
         public BoolSetting NotifyOnUserListChange { get; private set; }

ClientCore/Statistics/StatisticsManager.cs

@@ -290,6 +290,12 @@ public void ClearDatabase()
 
         public void AddMatchAndSaveDatabase(bool addMatch, MatchStatistics ms)
         {
+            if (ms == null)
+            {
+                Logger.Log("Skipping adding match to statistics because match statistics is null.");
+                return;
+            }
+
             // Skip adding stats if the game only had one player, make exception for co-op since it doesn't recognize pre-placed houses as players.
             if (ms.GetPlayerCount() <= 1 && !ms.MapIsCoop)
             {