Add TM:PE compatibility logic and notification support for missing addon (#335)

bonsaibauer · web-flow · commit 74de69269d54 · 2025-11-15T19:58:46.000+01:00
diff --git a/src/api/Log.cs b/src/api/Log.cs
@@ -64,6 +64,11 @@ public static void Warn(string message)
             Instance.Write(message, "Warn");
         }
 
+        public static void Warn(string message, Exception ex)
+        {
+            Instance.Write($"{message}: {ex}", "Warn");
+        }
+
         public static void Info(string message)
         {
             Instance.Write(message, "Info");
diff --git a/src/csm/CSM.csproj b/src/csm/CSM.csproj
@@ -145,6 +145,7 @@
 		<Compile Include="Models\Vector3Surrogate.cs" />
 		<Compile Include="Mods\ModCompat.cs" />
 		<Compile Include="Mods\ModSupport.cs" />
+		<Compile Include="Mods\TmpeSupportHelper.cs" />
 		<Compile Include="Networking\Client.cs" />
 		<Compile Include="Networking\Config\ClientConfig.cs" />
 		<Compile Include="Networking\Config\ConfigData.cs" />
@@ -201,4 +202,4 @@
 		<PostBuildEvent Condition="$([MSBuild]::IsOsPlatform('linux'))">pwsh "$(SolutionDir)scripts/build.ps1" -OutputDirectory "$(TargetDir)" -Install</PostBuildEvent>
 		<PostBuildEvent Condition="$([MSBuild]::IsOsPlatform('osx'))">pwsh "$(SolutionDir)scripts/build.ps1" -OutputDirectory "$(TargetDir)" -Install</PostBuildEvent>
 	</PropertyGroup>
-</Project>
+</Project>
diff --git a/src/csm/Helpers/SteamHelpers.cs b/src/csm/Helpers/SteamHelpers.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Runtime.InteropServices;
 using System.Threading;
 using ColossalFramework;
@@ -93,6 +94,36 @@ public void CheckCommandLine(bool checkLoadingManager)
             }
         }
 
+        public static void OpenOverlayToUrl(string url)
+        {
+            if (string.IsNullOrEmpty(url))
+            {
+                return;
+            }
+
+            if (CSM.IsSteamPresent && Instance != null && Instance._friendsPtr != IntPtr.Zero)
+            {
+                try
+                {
+                    SteamAPI_ISteamFriends_ActivateGameOverlayToWebPage(Instance._friendsPtr, url, EActivateGameOverlayToWebPageMode.k_EActivateGameOverlayToWebPageMode_Default);
+                    return;
+                }
+                catch (Exception ex)
+                {
+                    Log.Warn($"Failed to open Steam overlay for {url}", ex);
+                }
+            }
+
+            try
+            {
+                Process.Start(url);
+            }
+            catch (Exception ex)
+            {
+                Log.Warn($"Failed to open url {url}", ex);
+            }
+        }
+
         private void JoinFromSteam(string token, bool checkLoadingManager)
         {
             if (checkLoadingManager && Singleton<LoadingManager>.exists && (Singleton<LoadingManager>.instance.m_currentlyLoading ||
@@ -284,6 +315,14 @@ private static void SteamAPI_ISteamFriends_ActivateGameOverlay(IntPtr instancePt
             else SteamAPI_ISteamFriends_ActivateGameOverlay_32(instancePtr, pchDialog);
         }
 
+        private static void SteamAPI_ISteamFriends_ActivateGameOverlayToWebPage(IntPtr instancePtr, string url, EActivateGameOverlayToWebPageMode mode)
+        {
+            if (_use64Bit)
+                SteamAPI_ISteamFriends_ActivateGameOverlayToWebPage_64(instancePtr, url, mode);
+            else
+                SteamAPI_ISteamFriends_ActivateGameOverlayToWebPage_32(instancePtr, url, mode);
+        }
+
         [DllImport("steam_api", EntryPoint = "SteamAPI_Init", CallingConvention = CallingConvention.Cdecl)]
         private static extern bool SteamAPI_Init_32();
 
@@ -319,6 +358,8 @@ private static void SteamAPI_ISteamFriends_ActivateGameOverlay(IntPtr instancePt
 
         [DllImport("steam_api", EntryPoint = "SteamAPI_ISteamFriends_ActivateGameOverlay", CallingConvention = CallingConvention.Cdecl)]
         private static extern void SteamAPI_ISteamFriends_ActivateGameOverlay_32(IntPtr instancePtr, [MarshalAs(UnmanagedType.LPStr)] string pchDialog);
+        [DllImport("steam_api", EntryPoint = "SteamAPI_ISteamFriends_ActivateGameOverlayToWebPage", CallingConvention = CallingConvention.Cdecl)]
+        private static extern void SteamAPI_ISteamFriends_ActivateGameOverlayToWebPage_32(IntPtr instancePtr, [MarshalAs(UnmanagedType.LPStr)] string url, EActivateGameOverlayToWebPageMode mode);
 
         [DllImport("steam_api64", EntryPoint = "SteamAPI_Init", CallingConvention = CallingConvention.Cdecl)]
         private static extern bool SteamAPI_Init_64();
@@ -355,5 +396,7 @@ private static void SteamAPI_ISteamFriends_ActivateGameOverlay(IntPtr instancePt
 
         [DllImport("steam_api64", EntryPoint = "SteamAPI_ISteamFriends_ActivateGameOverlay", CallingConvention = CallingConvention.Cdecl)]
         private static extern void SteamAPI_ISteamFriends_ActivateGameOverlay_64(IntPtr instancePtr, [MarshalAs(UnmanagedType.LPStr)] string pchDialog);
+        [DllImport("steam_api64", EntryPoint = "SteamAPI_ISteamFriends_ActivateGameOverlayToWebPage", CallingConvention = CallingConvention.Cdecl)]
+        private static extern void SteamAPI_ISteamFriends_ActivateGameOverlayToWebPage_64(IntPtr instancePtr, [MarshalAs(UnmanagedType.LPStr)] string url, EActivateGameOverlayToWebPageMode mode);
     }
 }
diff --git a/src/csm/Mods/ModCompat.cs b/src/csm/Mods/ModCompat.cs
@@ -6,6 +6,7 @@
 using ColossalFramework.UI;
 using CSM.API;
 using CSM.Helpers;
+using CSM.Panels;
 using ICities;
 using UnityEngine;
 
@@ -68,6 +69,7 @@ public static bool HasDisableChirperMod {
         }
 
         private static bool? _hasDisableChirperMod;
+        private static bool _tmpeWarningShown;
 
         public static bool NeedsToBePresent(PluginManager.PluginInfo info)
         {
@@ -113,6 +115,8 @@ private static IEnumerable<ModSupportStatus> GetModSupport()
                 yield return new ModSupportStatus("DLC: " + name, name, DLCHelper.GetSupport(dlc), false);
             }
 
+            bool hasTmpeSyncMod = TmpeSupportHelper.HasTmpeSyncMod();
+
             foreach (PluginManager.PluginInfo info in Singleton<PluginManager>.instance.GetPluginsInfo())
             {
                 // Skip disabled mods
@@ -140,6 +144,13 @@ private static IEnumerable<ModSupportStatus> GetModSupport()
 
                 bool isClientSide = _clientSideMods.Contains(modInstanceName);
 
+                if (TmpeSupportHelper.IsTmpeMod(modInstanceName))
+                {
+                    ModSupportType tmpeState = hasTmpeSyncMod ? ModSupportType.Supported : ModSupportType.Unsupported;
+                    yield return new ModSupportStatus(modInstance?.Name, modInstanceName, tmpeState, isClientSide);
+                    continue;
+                }
+
                 // Explicitly supported mods
                 if (_disableChirperNames.Contains(modInstanceName))
                 {
@@ -173,6 +184,12 @@ private static IEnumerable<ModSupportStatus> GetModSupport()
             }
         }
 
+        private static bool NeedsTmpeSyncWarning(IEnumerable<ModSupportStatus> modSupport)
+        {
+            return modSupport.Any(status =>
+                status.Type == ModSupportType.Unsupported && TmpeSupportHelper.IsTmpeMod(status.TypeName));
+        }
+
         public static void BuildModInfo(UIPanel panel)
         {
             UIScrollablePanel modInfoPanel = panel.Find<UIScrollablePanel>("modInfoPanel");
@@ -182,6 +199,13 @@ public static void BuildModInfo(UIPanel panel)
             }
 
             List<ModSupportStatus> modSupport = GetModSupport().ToList();
+            if (!_tmpeWarningShown && NeedsTmpeSyncWarning(modSupport))
+            {
+                MessagePanel warningPanel = PanelManager.ShowPanel<MessagePanel>();
+                warningPanel?.DisplayTmpeSyncRequirement();
+                _tmpeWarningShown = true;
+            }
+
             if (!modSupport.Any())
             {
                 panel.width = 360;
@@ -265,10 +289,14 @@ public static void Init()
             Singleton<PluginManager>.instance.eventPluginsChanged += () =>
             {
                 _hasDisableChirperMod = null;
+                _tmpeWarningShown = false;
+                TmpeSupportHelper.InvalidateCache();
             };
             Singleton<PluginManager>.instance.eventPluginsStateChanged += () =>
             {
                 _hasDisableChirperMod = null;
+                _tmpeWarningShown = false;
+                TmpeSupportHelper.InvalidateCache();
             };
         }
     }
diff --git a/src/csm/Mods/TmpeSupportHelper.cs b/src/csm/Mods/TmpeSupportHelper.cs
@@ -0,0 +1,78 @@
+using System;
+using System.Linq;
+using ColossalFramework;
+using ColossalFramework.Plugins;
+using ICities;
+
+namespace CSM.Mods
+{
+    internal static class TmpeSupportHelper
+    {
+        public const string TmpeSyncWorkshopLink = "https://steamcommunity.com/sharedfiles/filedetails/?id=3600743038";
+
+        private static readonly string[] TmpeTypeNames =
+        {
+            "TrafficManager.Lifecycle.TrafficManagerMod"
+        };
+
+        private static readonly string[] TmpeSyncTypeNames =
+        {
+            "CSM.TmpeSync.Mod",
+            "CSM.TmpeSync.TmpeSyncMod"
+        };
+
+        private static bool? _hasTmpeSync;
+
+        public static bool IsTmpeMod(string typeName)
+        {
+            return !string.IsNullOrEmpty(typeName) && TmpeTypeNames.Contains(typeName);
+        }
+
+        public static bool HasTmpeSyncMod()
+        {
+            if (_hasTmpeSync.HasValue)
+            {
+                return _hasTmpeSync.Value;
+            }
+
+            foreach (PluginManager.PluginInfo info in Singleton<PluginManager>.instance.GetPluginsInfo())
+            {
+                if (!info.isEnabled)
+                {
+                    continue;
+                }
+
+                IUserMod modInstance = info.userModInstance as IUserMod;
+                string typeName = modInstance?.GetType().ToString();
+                if (IsTmpeSyncMod(typeName))
+                {
+                    _hasTmpeSync = true;
+                    return true;
+                }
+            }
+
+            _hasTmpeSync = false;
+            return false;
+        }
+
+        public static void InvalidateCache()
+        {
+            _hasTmpeSync = null;
+        }
+
+        private static bool IsTmpeSyncMod(string typeName)
+        {
+            if (string.IsNullOrEmpty(typeName))
+            {
+                return false;
+            }
+
+            if (TmpeSyncTypeNames.Contains(typeName))
+            {
+                return true;
+            }
+
+            return typeName.StartsWith("CSM.TmpeSync", StringComparison.Ordinal);
+        }
+    }
+}
diff --git a/src/csm/Panels/MessagePanel.cs b/src/csm/Panels/MessagePanel.cs
@@ -6,6 +6,7 @@
 using ColossalFramework.UI;
 using CSM.API;
 using CSM.Helpers;
+using CSM.Mods;
 using UnityEngine;
 
 namespace CSM.Panels
@@ -17,8 +18,10 @@ public class MessagePanel : UIPanel
         private string _title;
         private string _message;
 
-        private UIButton _closeButton, _githubButton;
-        private bool _githubShown = false;
+        private UIButton _closeButton, _actionButton;
+        private bool _actionButtonShown;
+        private string _actionButtonLabel = "Open Link";
+        private Action _actionButtonHandler;
 
         public override void Start()
         {
@@ -49,13 +52,10 @@ public override void Start()
 
             this.AddScrollbar(messagePanel);
 
-            // Github button
-            _githubButton = this.CreateButton("Open GitHub", new Vector2(60, -340));
-            _githubButton.eventClicked += (c, p) =>
-            {
-                Process.Start("https://github.com/CitiesSkylinesMultiplayer/CSM/releases");
-            };
-            _githubButton.isVisible = _githubShown;
+            // Generic action button (e.g. open links)
+            _actionButton = this.CreateButton(_actionButtonLabel, new Vector2(60, -340));
+            _actionButton.eventClicked += (c, p) => _actionButtonHandler?.Invoke();
+            _actionButton.isVisible = _actionButtonShown;
 
             // Close button
             _closeButton = this.CreateButton("Close", new Vector2(60, -410));
@@ -83,8 +83,29 @@ private void SetMessage(string message)
             if (_messageLabel)
                 _messageLabel.text = message;
 
-            if (_githubButton)
-                _githubButton.Hide();
+            HideActionButton();
+        }
+
+        private void HideActionButton()
+        {
+            _actionButtonShown = false;
+            _actionButtonHandler = null;
+
+            if (_actionButton)
+                _actionButton.Hide();
+        }
+
+        private void ShowActionButton(string label, Action handler)
+        {
+            _actionButtonLabel = label;
+            _actionButtonHandler = handler;
+            _actionButtonShown = true;
+
+            if (_actionButton)
+            {
+                _actionButton.text = _actionButtonLabel;
+                _actionButton.Show();
+            }
         }
 
         public void DisplayInvalidApiServer()
@@ -203,9 +224,7 @@ public void DisplayUpdateAvailable(Version current, Version latest)
                              "CSM/releases";
             SetMessage(message);
 
-            _githubShown = true;
-            if (_githubButton)
-                _githubButton.Show();
+            ShowActionButton("Open GitHub", () => Process.Start("https://github.com/CitiesSkylinesMultiplayer/CSM/releases"));
 
             Show(true);
         }
@@ -221,6 +240,25 @@ public void DisplayNoUpdateAvailable()
             Show(true);
         }
 
+        public void DisplayTmpeSyncRequirement()
+        {
+            SetTitle("TM:PE support requires an addon");
+
+            string message = "Traffic Manager: President Edition is currently\n" +
+                             "marked as unsupported in multiplayer because the\n" +
+                             "required CSM.TmpeSync addon is not enabled.\n\n" +
+                             "If you want to play with supported TM:PE, please\n" +
+                             "subscribe to the \"CSM.TmpeSync\" addon from the\n" +
+                             "Steam Workshop and enable it ingame.\n\n" +
+                             "Use the button below to open the workshop page\n" +
+                             "in the Steam overlay.";
+            SetMessage(message);
+
+            ShowActionButton("Subscribe", () => SteamHelpers.OpenOverlayToUrl(TmpeSupportHelper.TmpeSyncWorkshopLink));
+
+            Show(true);
+        }
+
         public void DisplayTroubleshooting(bool isHost, int port=4230, bool hasVpn=false)
         {
             SetTitle("Troubleshooting");

Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,11 @@ public static void Warn(string message)`
`64`	`64`	`Instance.Write(message, "Warn");`
`65`	`65`	`}`
`66`	`66`
	`67`	`+ public static void Warn(string message, Exception ex)`
	`68`	`+ {`
	`69`	`+ Instance.Write($"{message}: {ex}", "Warn");`
	`70`	`+ }`
	`71`	`+`
`67`	`72`	`public static void Info(string message)`
`68`	`73`	`{`
`69`	`74`	`Instance.Write(message, "Info");`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`using ColossalFramework.UI;`
`7`	`7`	`using CSM.API;`
`8`	`8`	`using CSM.Helpers;`
	`9`	`+using CSM.Panels;`
`9`	`10`	`using ICities;`
`10`	`11`	`using UnityEngine;`
`11`	`12`
`@@ -68,6 +69,7 @@ public static bool HasDisableChirperMod {`
`68`	`69`	`}`
`69`	`70`
`70`	`71`	`private static bool? _hasDisableChirperMod;`
	`72`	`+ private static bool _tmpeWarningShown;`
`71`	`73`
`72`	`74`	`public static bool NeedsToBePresent(PluginManager.PluginInfo info)`
`73`	`75`	`{`
`@@ -113,6 +115,8 @@ private static IEnumerable<ModSupportStatus> GetModSupport()`
`113`	`115`	`yield return new ModSupportStatus("DLC: " + name, name, DLCHelper.GetSupport(dlc), false);`
`114`	`116`	`}`
`115`	`117`
	`118`	`+ bool hasTmpeSyncMod = TmpeSupportHelper.HasTmpeSyncMod();`
	`119`	`+`
`116`	`120`	`foreach (PluginManager.PluginInfo info in Singleton<PluginManager>.instance.GetPluginsInfo())`
`117`	`121`	`{`
`118`	`122`	`// Skip disabled mods`
`@@ -140,6 +144,13 @@ private static IEnumerable<ModSupportStatus> GetModSupport()`
`140`	`144`
`141`	`145`	`bool isClientSide = _clientSideMods.Contains(modInstanceName);`
`142`	`146`
	`147`	`+ if (TmpeSupportHelper.IsTmpeMod(modInstanceName))`
	`148`	`+ {`
	`149`	`+ ModSupportType tmpeState = hasTmpeSyncMod ? ModSupportType.Supported : ModSupportType.Unsupported;`
	`150`	`+ yield return new ModSupportStatus(modInstance?.Name, modInstanceName, tmpeState, isClientSide);`
	`151`	`+ continue;`
	`152`	`+ }`
	`153`	`+`
`143`	`154`	`// Explicitly supported mods`
`144`	`155`	`if (_disableChirperNames.Contains(modInstanceName))`
`145`	`156`	`{`
`@@ -173,6 +184,12 @@ private static IEnumerable<ModSupportStatus> GetModSupport()`
`173`	`184`	`}`
`174`	`185`	`}`
`175`	`186`
	`187`	`+ private static bool NeedsTmpeSyncWarning(IEnumerable<ModSupportStatus> modSupport)`
	`188`	`+ {`
	`189`	`+ return modSupport.Any(status =>`
	`190`	`+ status.Type == ModSupportType.Unsupported && TmpeSupportHelper.IsTmpeMod(status.TypeName));`
	`191`	`+ }`
	`192`	`+`
`176`	`193`	`public static void BuildModInfo(UIPanel panel)`
`177`	`194`	`{`
`178`	`195`	`UIScrollablePanel modInfoPanel = panel.Find<UIScrollablePanel>("modInfoPanel");`
`@@ -182,6 +199,13 @@ public static void BuildModInfo(UIPanel panel)`
`182`	`199`	`}`
`183`	`200`
`184`	`201`	`List<ModSupportStatus> modSupport = GetModSupport().ToList();`
	`202`	`+ if (!_tmpeWarningShown && NeedsTmpeSyncWarning(modSupport))`
	`203`	`+ {`
	`204`	`+ MessagePanel warningPanel = PanelManager.ShowPanel<MessagePanel>();`
	`205`	`+ warningPanel?.DisplayTmpeSyncRequirement();`
	`206`	`+ _tmpeWarningShown = true;`
	`207`	`+ }`
	`208`	`+`
`185`	`209`	`if (!modSupport.Any())`
`186`	`210`	`{`
`187`	`211`	`panel.width = 360;`
`@@ -265,10 +289,14 @@ public static void Init()`
`265`	`289`	`Singleton<PluginManager>.instance.eventPluginsChanged += () =>`
`266`	`290`	`{`
`267`	`291`	`_hasDisableChirperMod = null;`
	`292`	`+ _tmpeWarningShown = false;`
	`293`	`+ TmpeSupportHelper.InvalidateCache();`
`268`	`294`	`};`
`269`	`295`	`Singleton<PluginManager>.instance.eventPluginsStateChanged += () =>`
`270`	`296`	`{`
`271`	`297`	`_hasDisableChirperMod = null;`
	`298`	`+ _tmpeWarningShown = false;`
	`299`	`+ TmpeSupportHelper.InvalidateCache();`
`272`	`300`	`};`
`273`	`301`	`}`
`274`	`302`	`}`