Merge pull request #813 from CnCNet/develop

SadPencil · web-flow · commit c193cf2adec2 · 2025-08-01T05:29:00.000+08:00
Release 2.12.8
diff --git a/ClientCore/ClientConfiguration.cs b/ClientCore/ClientConfiguration.cs
@@ -21,11 +21,11 @@ public class ClientConfiguration
         private const string TRANSLATIONS = "Translations";
         private const string USER_DEFAULTS = "UserDefaults";
 
-        private const string CLIENT_SETTINGS = "DTACnCNetClient.ini";
-        private const string GAME_OPTIONS = "GameOptions.ini";
-        private const string CLIENT_DEFS = "ClientDefinitions.ini";
-        private const string NETWORK_DEFS_LOCAL = "NetworkDefinitions.local.ini";
-        private const string NETWORK_DEFS = "NetworkDefinitions.ini";
+        public const string CLIENT_SETTINGS = "DTACnCNetClient.ini";
+        public const string GAME_OPTIONS = "GameOptions.ini";
+        public const string CLIENT_DEFS = "ClientDefinitions.ini";
+        public const string NETWORK_DEFS_LOCAL = "NetworkDefinitions.local.ini";
+        public const string NETWORK_DEFS = "NetworkDefinitions.ini";
 
         private static ClientConfiguration _instance;
 
diff --git a/ClientCore/Extensions/IniFileExtensions.cs b/ClientCore/Extensions/IniFileExtensions.cs
@@ -8,6 +8,31 @@ 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)
+        {
+            var newIni = new IniFile();
+            foreach (string sectionName in oldIniFile.GetSections())
+            {
+                IniSection oldSection = oldIniFile.GetSection(sectionName);
+                newIni.AddSection(oldSection.Clone());
+            }
+
+            return newIni;
+        }
+
+        public static IniSection Clone(this IniSection oldSection)
+        {
+            IniSection newSection = new(oldSection.SectionName);
+
+            foreach ((var key, var value) in oldSection.Keys)
+            {
+                newSection.AddKey(key, value);
+            }
+
+            return newSection;
+        }
+
         public static IniSection GetOrAddSection(this IniFile iniFile, string sectionName)
         {
             var section = iniFile.GetSection(sectionName);
diff --git a/ClientCore/Settings/UserINISettings.cs b/ClientCore/Settings/UserINISettings.cs
@@ -1,10 +1,13 @@
-using ClientCore.Settings;
-using Rampastring.Tools;
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
+
 using ClientCore.Enums;
 using ClientCore.Extensions;
+using ClientCore.Settings;
+
+using Rampastring.Tools;
 
 namespace ClientCore
 {
@@ -37,14 +40,47 @@ public static UserINISettings Instance
             }
         }
 
-        public static void Initialize(string iniFileName)
+        public static void Initialize(string userIniFileName)
         {
             if (_instance != null)
                 throw new InvalidOperationException("UserINISettings has already been initialized!");
 
-            var iniFile = new IniFile(SafePath.CombineFilePath(ProgramConstants.GamePath, iniFileName));
+            var userIni = new IniFile(SafePath.CombineFilePath(ProgramConstants.GamePath, userIniFileName));
+
+            string userDefaultIniFilePath = SafePath.CombineFilePath(ProgramConstants.GetResourcePath(), "UserDefaults.ini");
+
+            if (!File.Exists(userDefaultIniFilePath))
+            {
+                _instance = new UserINISettings(userIni);
+                return;
+            }
+
+            var userDefaultIni = new IniFile(userDefaultIniFilePath);
+
+            var combinedUserIni = userDefaultIni.Clone();
+            combinedUserIni.FileName = null;
+
+            // Combine userIni and userDefaultIni
+            foreach (string sectionName in userIni.GetSections())
+            {
+                IniSection userSection = userIni.GetSection(sectionName);
+
+                IniSection combinedUserSection = combinedUserIni.GetSection(sectionName);
+                if (combinedUserSection == null)
+                {
+                    combinedUserSection = new IniSection(sectionName);
+                    combinedUserIni.AddSection(combinedUserSection);
+                }
+
+                foreach ((var key, var value) in userSection.Keys)
+                {
+                    combinedUserSection.AddOrReplaceKey(key, value);
+                }
+            }
+
+            combinedUserIni.FileName = userIni.FileName;
 
-            _instance = new UserINISettings(iniFile);
+            _instance = new UserINISettings(combinedUserIni);
         }
 
         protected UserINISettings(IniFile iniFile)
@@ -356,7 +392,7 @@ public void SaveSettings()
         public bool IsGameFiltersApplied()
             => ShowFriendGamesOnly.Value != DEFAULT_SHOW_FRIENDS_ONLY_GAMES
                || HideLockedGames.Value != DEFAULT_HIDE_LOCKED_GAMES
-               || HidePasswordedGames.Value != DEFAULT_HIDE_PASSWORDED_GAMES 
+               || HidePasswordedGames.Value != DEFAULT_HIDE_PASSWORDED_GAMES
                || HideIncompatibleGames.Value != DEFAULT_HIDE_INCOMPATIBLE_GAMES
                || MaxPlayerCount.Value != DEFAULT_MAX_PLAYER_COUNT;
 
diff --git a/ClientGUI/XNAClientColorDropDown.cs b/ClientGUI/XNAClientColorDropDown.cs
@@ -78,6 +78,9 @@ protected override void ParseControlINIAttribute(IniFile iniFile, string key, st
                     RandomColorTexture = AssetLoader.LoadTexture(value);
                     Items[0].Texture = RandomColorTexture;
                     break;
+                case nameof(DisabledItemTexture):
+                    DisabledItemTexture = AssetLoader.LoadTexture(value);
+                    break;
                 default:
                     base.ParseControlINIAttribute(iniFile, key, value);
                     return;
diff --git a/ClientGUI/XNAClientDropDown.cs b/ClientGUI/XNAClientDropDown.cs
@@ -46,9 +46,10 @@ protected override void ParseControlINIAttribute(IniFile iniFile, string key, st
             base.ParseControlINIAttribute(iniFile, key, value);
         }
 
-        public override void OnMouseLeftDown()
+        public override void OnMouseLeftDown(InputEventArgs inputEventArgs)
         {
-            base.OnMouseLeftDown();
+            // no need to set Handled to true since we're not "consuming" the event here, just augmenting
+            base.OnMouseLeftDown(inputEventArgs);
             UpdateToolTipBlock();
         }
 
diff --git a/ClientGUI/XNAClientLinkLabel.cs b/ClientGUI/XNAClientLinkLabel.cs
@@ -99,8 +99,10 @@ public override void OnMouseLeave()
             TextColor = IdleColor;
         }
 
-        public override void OnLeftClick()
+        public override void OnLeftClick(InputEventArgs inputEventArgs)
         {
+            inputEventArgs.Handled = true;
+            
             ClickSoundEffect?.Play();
 
             OSVersion osVersion = ClientConfiguration.Instance.GetOperatingSystemVersion();
@@ -110,7 +112,7 @@ public override void OnLeftClick()
             else if (!string.IsNullOrEmpty(URL))
                 ProcessLauncher.StartShellProcess(URL);
 
-            base.OnLeftClick();
+            base.OnLeftClick(inputEventArgs);
         }
     }
 }
diff --git a/ClientGUI/XNALinkButton.cs b/ClientGUI/XNALinkButton.cs
@@ -36,16 +36,18 @@ protected override void ParseControlINIAttribute(IniFile iniFile, string key, st
             base.ParseControlINIAttribute(iniFile, key, value);
         }
 
-        public override void OnLeftClick()
+        public override void OnLeftClick(InputEventArgs inputEventArgs)
         {
+            inputEventArgs.Handled = true;
+            
             OSVersion osVersion = ClientConfiguration.Instance.GetOperatingSystemVersion();
 
             if (osVersion == OSVersion.UNIX && !string.IsNullOrEmpty(UnixURL))
                 ProcessLauncher.StartShellProcess(UnixURL, Arguments);
             else if (!string.IsNullOrEmpty(URL))
                 ProcessLauncher.StartShellProcess(URL, Arguments);
 
-            base.OnLeftClick();
+            base.OnLeftClick(inputEventArgs);
         }
     }
 }
diff --git a/DXMainClient/DXGUI/Generic/GameInProgressWindow.cs b/DXMainClient/DXGUI/Generic/GameInProgressWindow.cs
@@ -129,7 +129,7 @@ private void SharedUILogic_GameProcessStarted()
 
         private void SharedUILogic_GameProcessExited()
         {
-            AddCallback(new Action(HandleGameProcessExited), null);
+            WindowManager.AddCallback(new Action(HandleGameProcessExited), null);
         }
 
         private void HandleGameProcessExited()
diff --git a/DXMainClient/DXGUI/Generic/MainMenu.cs b/DXMainClient/DXGUI/Generic/MainMenu.cs
@@ -679,14 +679,21 @@ private void LoadThemeSong()
             string songExtension = "wma";
 #endif
 
-            FileInfo mainMenuMusicFile = SafePath.GetFile(ProgramConstants.GamePath, ProgramConstants.BASE_RESOURCE_PATH, 
+            FileInfo mainMenuMusicFile = SafePath.GetFile(ProgramConstants.GamePath, ProgramConstants.BASE_RESOURCE_PATH,
                 FormattableString.Invariant($"{ClientConfiguration.Instance.MainMenuMusicName}.{songExtension}"));
 
             if (!mainMenuMusicFile.Exists)
                 return;
 
-            Song song = Song.FromUri(ClientConfiguration.Instance.MainMenuMusicName, new Uri(mainMenuMusicFile.FullName));
-            themeSong = song;
+            try
+            {
+                themeSong = Song.FromUri(ClientConfiguration.Instance.MainMenuMusicName, new Uri(mainMenuMusicFile.FullName));
+            }
+            catch (Exception ex)
+            {
+                Logger.Log($"Error loading the theme song. Fallback to the legacy method. Have you installed 'Media Feature Pack for Windows 10/11 N'? Exception: {ex.ToString()}");
+                themeSong = AssetLoader.LoadSong(ClientConfiguration.Instance.MainMenuMusicName);
+            }
 #endif
         }
 
diff --git a/DXMainClient/DXGUI/Multiplayer/CnCNet/PrivateMessagingPanel.cs b/DXMainClient/DXGUI/Multiplayer/CnCNet/PrivateMessagingPanel.cs
@@ -13,25 +13,14 @@ public PrivateMessagingPanel(WindowManager windowManager) : base(windowManager)
         {
         }
 
-        public override void OnLeftClick()
+        public override void OnLeftClick(InputEventArgs inputEventArgs)
         {
-            bool hideControl = true;
-
-            foreach (var child in Children)
-            {
-                if (child.IsActive)
-                {
-                    hideControl = false;
-                    break;
-                }
-            }
-
-            if (hideControl)
+            inputEventArgs.Handled = true;
+            
+            if (GetActiveChild() == null)
                 Hide();
 
-            base.OnLeftClick();
+            base.OnLeftClick(inputEventArgs);
         }
-
-
     }
 }
diff --git a/DXMainClient/DXGUI/Multiplayer/GameLobby/GameLobbyCheckBox.cs b/DXMainClient/DXGUI/Multiplayer/GameLobby/GameLobbyCheckBox.cs
@@ -190,12 +190,16 @@ public void ApplyDisallowedSideIndex(bool[] disallowedArray)
             }
         }
 
-        public override void OnLeftClick()
+        public override void OnLeftClick(InputEventArgs inputEventArgs)
         {
+            // FIXME there's a discrepancy with how base XNAUI handles this
+            // it doesn't set handled if changing the setting is not allowed
+            inputEventArgs.Handled = true;
+            
             if (!AllowChanges)
                 return;
 
-            base.OnLeftClick();
+            base.OnLeftClick(inputEventArgs);
             UserChecked = Checked;
         }
     }
diff --git a/DXMainClient/DXGUI/Multiplayer/GameLobby/GameLobbyDropDown.cs b/DXMainClient/DXGUI/Multiplayer/GameLobby/GameLobbyDropDown.cs
@@ -147,12 +147,16 @@ public void ApplyMapCode(IniFile mapIni, GameMode gameMode)
             MapCodeHelper.ApplyMapCode(mapIni, customIniPath, gameMode);
         }
 
-        public override void OnLeftClick()
+        public override void OnLeftClick(InputEventArgs inputEventArgs)
         {
+            // FIXME there's a discrepancy with how base XNAUI handles this
+            // it doesn't set handled if changing the setting is not allowed
+            inputEventArgs.Handled = true;
+            
             if (!AllowDropDown)
                 return;
 
-            base.OnLeftClick();
+            base.OnLeftClick(inputEventArgs);
             UserSelectedIndex = SelectedIndex;
         }
     }
diff --git a/DXMainClient/DXGUI/Multiplayer/GameLobby/MapPreviewBox.cs b/DXMainClient/DXGUI/Multiplayer/GameLobby/MapPreviewBox.cs
@@ -617,8 +617,10 @@ public override void OnMouseLeave()
             base.OnMouseLeave();
         }
 
-        public override void OnLeftClick()
+        public override void OnLeftClick(InputEventArgs inputEventArgs)
         {
+            inputEventArgs.Handled = true;
+            
             if (Keyboard.IsKeyHeldDown(Keys.LeftControl))
             {
                 FileInfo previewFileInfo = SafePath.GetFile(ProgramConstants.GamePath, GameModeMap.Map.PreviewPath);
@@ -627,7 +629,7 @@ public override void OnLeftClick()
                     ProcessLauncher.StartShellProcess(previewFileInfo.FullName);
             }
 
-            base.OnLeftClick();
+            base.OnLeftClick(inputEventArgs);
         }
 
         public override void Draw(GameTime gameTime)
diff --git a/DXMainClient/Domain/Multiplayer/Map.cs b/DXMainClient/Domain/Multiplayer/Map.cs
@@ -400,7 +400,7 @@ public bool SetInfoFromMpMapsINI(IniFile iniFile)
                     if (string.IsNullOrEmpty(waypoint))
                         break;
 
-                    Debug.Assert(int.TryParse(waypoint, out _), $"waypoint should be a number, got {waypoint}");
+                    Debug.Assert(int.TryParse(waypoint.Split(',')[0], out _), $"waypoint should be a number, got {waypoint}");
                     waypoints.Add(waypoint);
                 }
 
diff --git a/DXMainClient/Online/FileHashCalculator.cs b/DXMainClient/Online/FileHashCalculator.cs
diff --git a/DXMainClient/Resources/DTA/UserDefaults.ini b/DXMainClient/Resources/DTA/UserDefaults.ini
diff --git a/Directory.Packages.props b/Directory.Packages.props
diff --git a/Docs/INISystem.md b/Docs/INISystem.md

Original file line number	Diff line number	Diff line change
`@@ -46,9 +46,10 @@ protected override void ParseControlINIAttribute(IniFile iniFile, string key, st`
`46`	`46`	`base.ParseControlINIAttribute(iniFile, key, value);`
`47`	`47`	`}`
`48`	`48`
`49`		`- public override void OnMouseLeftDown()`
	`49`	`+ public override void OnMouseLeftDown(InputEventArgs inputEventArgs)`
`50`	`50`	`{`
`51`		`- base.OnMouseLeftDown();`
	`51`	`+ // no need to set Handled to true since we're not "consuming" the event here, just augmenting`
	`52`	`+ base.OnMouseLeftDown(inputEventArgs);`
`52`	`53`	`UpdateToolTipBlock();`
`53`	`54`	`}`
`54`	`55`
Original file line number	Diff line number	Diff line change
`@@ -99,8 +99,10 @@ public override void OnMouseLeave()`
`99`	`99`	`TextColor = IdleColor;`
`100`	`100`	`}`
`101`	`101`
`102`		`- public override void OnLeftClick()`
	`102`	`+ public override void OnLeftClick(InputEventArgs inputEventArgs)`
`103`	`103`	`{`
	`104`	`+ inputEventArgs.Handled = true;`
	`105`	`+`
`104`	`106`	`ClickSoundEffect?.Play();`
`105`	`107`
`106`	`108`	`OSVersion osVersion = ClientConfiguration.Instance.GetOperatingSystemVersion();`
`@@ -110,7 +112,7 @@ public override void OnLeftClick()`
`110`	`112`	`else if (!string.IsNullOrEmpty(URL))`
`111`	`113`	`ProcessLauncher.StartShellProcess(URL);`
`112`	`114`
`113`		`- base.OnLeftClick();`
	`115`	`+ base.OnLeftClick(inputEventArgs);`
`114`	`116`	`}`
`115`	`117`	`}`
`116`	`118`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,16 +36,18 @@ protected override void ParseControlINIAttribute(IniFile iniFile, string key, st`
`36`	`36`	`base.ParseControlINIAttribute(iniFile, key, value);`
`37`	`37`	`}`
`38`	`38`
`39`		`- public override void OnLeftClick()`
	`39`	`+ public override void OnLeftClick(InputEventArgs inputEventArgs)`
`40`	`40`	`{`
	`41`	`+ inputEventArgs.Handled = true;`
	`42`	`+`
`41`	`43`	`OSVersion osVersion = ClientConfiguration.Instance.GetOperatingSystemVersion();`
`42`	`44`
`43`	`45`	`if (osVersion == OSVersion.UNIX && !string.IsNullOrEmpty(UnixURL))`
`44`	`46`	`ProcessLauncher.StartShellProcess(UnixURL, Arguments);`
`45`	`47`	`else if (!string.IsNullOrEmpty(URL))`
`46`	`48`	`ProcessLauncher.StartShellProcess(URL, Arguments);`
`47`	`49`
`48`		`- base.OnLeftClick();`
	`50`	`+ base.OnLeftClick(inputEventArgs);`
`49`	`51`	`}`
`50`	`52`	`}`
`51`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ private void SharedUILogic_GameProcessStarted()`
`129`	`129`
`130`	`130`	`private void SharedUILogic_GameProcessExited()`
`131`	`131`	`{`
`132`		`- AddCallback(new Action(HandleGameProcessExited), null);`
	`132`	`+ WindowManager.AddCallback(new Action(HandleGameProcessExited), null);`
`133`	`133`	`}`
`134`	`134`
`135`	`135`	`private void HandleGameProcessExited()`
Original file line number	Diff line number	Diff line change
`@@ -13,25 +13,14 @@ public PrivateMessagingPanel(WindowManager windowManager) : base(windowManager)`
`13`	`13`	`{`
`14`	`14`	`}`
`15`	`15`
`16`		`- public override void OnLeftClick()`
	`16`	`+ public override void OnLeftClick(InputEventArgs inputEventArgs)`
`17`	`17`	`{`
`18`		`- bool hideControl = true;`
`19`		`-`
`20`		`- foreach (var child in Children)`
`21`		`- {`
`22`		`- if (child.IsActive)`
`23`		`- {`
`24`		`- hideControl = false;`
`25`		`- break;`
`26`		`- }`
`27`		`- }`
`28`		`-`
`29`		`- if (hideControl)`
	`18`	`+ inputEventArgs.Handled = true;`
	`19`	`+`
	`20`	`+ if (GetActiveChild() == null)`
`30`	`21`	`Hide();`
`31`	`22`
`32`		`- base.OnLeftClick();`
	`23`	`+ base.OnLeftClick(inputEventArgs);`
`33`	`24`	`}`
`34`		`-`
`35`		`-`
`36`	`25`	`}`
`37`	`26`	`}`