Improve bootstrap flow: in-game TOML config, map init detection, and reliable save upload for dedicated server

Source/Client/EarlyInit.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Collections.Generic;
 using System.Reflection;
 using HarmonyLib;
 using Multiplayer.Client.Patches;
@@ -12,7 +11,6 @@ namespace Multiplayer.Client;
 public static class EarlyInit
 {
     public const string RestartConnectVariable = "MultiplayerRestartConnect";
-    public const string RestartConfigsVariable = "MultiplayerRestartConfigs";
 
     internal static void ProcessEnvironment()
     {
@@ -22,11 +20,7 @@ internal static void ProcessEnvironment()
             Environment.SetEnvironmentVariable(RestartConnectVariable, ""); // Effectively unsets it
         }
 
-        if (!Environment.GetEnvironmentVariable(RestartConfigsVariable).NullOrEmpty())
-        {
-            Multiplayer.restartConfigs = Environment.GetEnvironmentVariable(RestartConfigsVariable) == "true";
-            Environment.SetEnvironmentVariable(RestartConfigsVariable, "");
-        }
+        SyncConfigs.Init();
     }
 
     internal static void EarlyPatches(Harmony harmony)

Source/Client/EarlyPatches/SettingsPatches.cs

@@ -1,6 +1,4 @@
 using System.Collections.Generic;
-using System.IO;
-using System.Linq;
 using System.Reflection;
 using HarmonyLib;
 using Multiplayer.Client.Patches;
@@ -104,74 +102,4 @@ static IEnumerable<MethodBase> TargetMethods()
 
         static bool Prefix() => !TickPatch.Simulating;
     }
-
-    // Affects both reading and writing
-    [EarlyPatch]
-    [HarmonyPatch(typeof(LoadedModManager), nameof(LoadedModManager.GetSettingsFilename))]
-    static class OverrideConfigsPatch
-    {
-        private static Dictionary<(string, string), ModContentPack> modCache = new();
-
-        static void Postfix(string modIdentifier, string modHandleName, ref string __result)
-        {
-            if (!Multiplayer.restartConfigs)
-                return;
-
-            if (!modCache.TryGetValue((modIdentifier, modHandleName), out var mod))
-            {
-                mod = modCache[(modIdentifier, modHandleName)] =
-                    LoadedModManager.RunningModsListForReading.FirstOrDefault(m =>
-                        m.FolderName == modIdentifier
-                        && m.assemblies.loadedAssemblies.Any(a => a.GetTypes().Any(t => t.Name == modHandleName))
-                    );
-            }
-
-            if (mod == null)
-                return;
-
-            if (JoinData.ignoredConfigsModIds.Contains(mod.ModMetaData.PackageIdNonUnique))
-                return;
-
-            // Example: MultiplayerTempConfigs/rwmt.multiplayer-Multiplayer
-            var newPath = Path.Combine(
-                GenFilePaths.FolderUnderSaveData(JoinData.TempConfigsDir),
-                GenText.SanitizeFilename(mod.PackageIdPlayerFacing.ToLowerInvariant() + "-" + modHandleName)
-            );
-
-            __result = newPath;
-        }
-    }
-
-    [EarlyPatch]
-    [HarmonyPatch]
-    static class HugsLib_OverrideConfigsPatch
-    {
-        public static string HugsLibConfigOverridenPath;
-
-        private static MethodInfo MethodToPatch = AccessTools.Method("HugsLib.Core.PersistentDataManager:GetSettingsFilePath");
-
-        static bool Prepare() => MethodToPatch != null;
-
-        static MethodInfo TargetMethod() => MethodToPatch;
-
-        static void Prefix(object __instance)
-        {
-            if (!Multiplayer.restartConfigs)
-                return;
-
-            if (__instance.GetType().Name != "ModSettingsManager")
-                return;
-
-            var newPath = Path.Combine(
-                GenFilePaths.FolderUnderSaveData(JoinData.TempConfigsDir),
-                GenText.SanitizeFilename($"{JoinData.HugsLibId}-{JoinData.HugsLibSettingsFile}")
-            );
-
-            if (File.Exists(newPath))
-            {
-                __instance.SetPropertyOrField("OverrideFilePath", newPath);
-                HugsLibConfigOverridenPath = newPath;
-            }
-        }
-    }
 }

Source/Client/Multiplayer.cs

@@ -75,7 +75,6 @@ public static class Multiplayer
         public static Stopwatch harmonyWatch = new();
 
         public static string restartConnect;
-        public static bool restartConfigs;
 
         public static ModContentPack modContentPack;
 

Source/Client/MultiplayerStatic.cs

@@ -87,6 +87,7 @@ static MultiplayerStatic()
             MpConnectionState.SetImplementation(ConnectionStateEnum.ClientJoining, typeof(ClientJoiningState));
             MpConnectionState.SetImplementation(ConnectionStateEnum.ClientLoading, typeof(ClientLoadingState));
             MpConnectionState.SetImplementation(ConnectionStateEnum.ClientPlaying, typeof(ClientPlayingState));
+            MpConnectionState.SetImplementation(ConnectionStateEnum.ClientBootstrap, typeof(ClientBootstrapState));
 
             MultiplayerData.CollectCursorIcons();
 

Source/Client/Networking/JoinData.cs

@@ -1,12 +1,10 @@
-using System;
 using System.Collections;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
 using HarmonyLib;
 using Ionic.Zlib;
-using Multiplayer.Client.EarlyPatches;
+using Multiplayer.Client.Util;
 using Multiplayer.Common;
 using RimWorld;
 using Steamworks;
@@ -49,7 +47,7 @@ public static byte[] WriteServerData(bool writeConfigs)
             data.WriteBool(writeConfigs);
             if (writeConfigs)
             {
-                var configs = GetSyncableConfigContents(
+                var configs = SyncConfigs.GetSyncableConfigContents(
                     activeModsSnapshot.Select(m => m.PackageIdNonUnique).ToList()
                 );
 
@@ -126,93 +124,13 @@ public static ModMetaData GetInstalledMod(string id)
             return ModLister.GetModWithIdentifier(id);
         }
 
-        [SuppressMessage("ReSharper", "StringLiteralTypo")]
-        public static string[] ignoredConfigsModIds =
-        {
-            // todo unhardcode it
-            "rwmt.multiplayer",
-            "hodlhodl.twitchtoolkit", // contains username
-            "dubwise.dubsmintmenus",
-            "dubwise.dubsmintminimap",
-            "arandomkiwi.rimthemes",
-            "brrainz.cameraplus",
-            "giantspacehamster.moody",
-            "fluffy.modmanager",
-            "jelly.modswitch",
-            "betterscenes.rimconnect", // contains secret key for streamer
-            "jaxe.rimhud",
-            "telefonmast.graphicssettings",
-            "derekbickley.ltocolonygroupsfinal",
-            "dra.multiplayercustomtickrates", // syncs its own settings
-            "merthsoft.designatorshapes", // settings for UI and stuff meaningless for MP
-            //"zetrith.prepatcher",
-        };
-
-        public const string TempConfigsDir = "MultiplayerTempConfigs";
-        public const string HugsLibId = "unlimitedhugs.hugslib";
-        public const string HugsLibSettingsFile = "ModSettings";
-
-        public static List<ModConfig> GetSyncableConfigContents(List<string> modIds)
-        {
-            var list = new List<ModConfig>();
-
-            foreach (var modId in modIds)
-            {
-                if (ignoredConfigsModIds.Contains(modId)) continue;
-
-                var mod = LoadedModManager.RunningModsListForReading.FirstOrDefault(m => m.PackageIdPlayerFacing.ToLowerInvariant() == modId);
-                if (mod == null) continue;
-
-                foreach (var modInstance in LoadedModManager.runningModClasses.Values)
-                {
-                    if (modInstance.modSettings == null) continue;
-                    if (!mod.assemblies.loadedAssemblies.Contains(modInstance.GetType().Assembly)) continue;
-
-                    var instanceName = modInstance.GetType().Name;
-
-                    // This path may point to configs downloaded from the server
-                    var file = LoadedModManager.GetSettingsFilename(mod.FolderName, instanceName);
-
-                    if (File.Exists(file))
-                        list.Add(GetConfigCatchError(file, modId, instanceName));
-                }
-            }
-
-            // Special case for HugsLib
-            if (modIds.Contains(HugsLibId) && GetInstalledMod(HugsLibId) is { Active: true })
-            {
-                var hugsConfig =
-                    HugsLib_OverrideConfigsPatch.HugsLibConfigOverridenPath ??
-                    Path.Combine(GenFilePaths.SaveDataFolderPath, "HugsLib", "ModSettings.xml");
-
-                if (File.Exists(hugsConfig))
-                    list.Add(GetConfigCatchError(hugsConfig, HugsLibId, HugsLibSettingsFile));
-            }
-
-            return list;
-
-            ModConfig GetConfigCatchError(string path, string id, string file)
-            {
-                try
-                {
-                    var configContents = File.ReadAllText(path);
-                    return new ModConfig(id, file, configContents);
-                }
-                catch (Exception e)
-                {
-                    Log.Error($"Exception getting config contents {file}: {e}");
-                    return new ModConfig(id, "ERROR", "");
-                }
-            }
-        }
-
         public static bool CompareToLocal(RemoteData remote)
         {
             return
                 remote.remoteRwVersion == VersionControl.CurrentVersionString &&
                 remote.CompareMods(activeModsSnapshot) == ModListDiff.None &&
                 remote.remoteFiles.DictsEqual(modFilesSnapshot) &&
-                (!remote.hasConfigs || remote.remoteModConfigs.EqualAsSets(GetSyncableConfigContents(remote.RemoteModIds.ToList())));
+                (!remote.hasConfigs || remote.remoteModConfigs.EqualAsSets(SyncConfigs.GetSyncableConfigContents(remote.RemoteModIds.ToList())));
         }
 
         internal static void TakeModDataSnapshot()

Source/Client/Networking/State/ClientBootstrapState.cs

@@ -0,0 +1,35 @@
+using Multiplayer.Common;
+using Multiplayer.Common.Networking.Packet;
+
+namespace Multiplayer.Client;
+
+/// <summary>
+/// Client connection state used while configuring a bootstrap server.
+/// The server is in ServerBootstrap and expects upload packets; the client must keep the connection alive
+/// and handle bootstrap completion / disconnect packets.
+/// </summary>
+[PacketHandlerClass(inheritHandlers: true)]
+public class ClientBootstrapState(ConnectionBase connection) : ClientBaseState(connection)
+{
+    public new void HandleDisconnected(ServerDisconnectPacket packet)
+    {
+        // If bootstrap completed successfully, show success message before closing the window
+        if (packet.reason == MpDisconnectReason.BootstrapCompleted)
+        {
+            OnMainThread.Enqueue(() => Verse.Messages.Message(
+                "Bootstrap configuration completed. The server will now shut down; please restart it manually to start normally.",
+                RimWorld.MessageTypeDefOf.PositiveEvent, false));
+        }
+
+        // Close the bootstrap configurator window now that the process is complete
+        OnMainThread.Enqueue(() =>
+        {
+            var window = Verse.Find.WindowStack.WindowOfType<BootstrapConfiguratorWindow>();
+            if (window != null)
+                Verse.Find.WindowStack.TryRemove(window);
+        });
+
+        // Let the base class handle the disconnect
+        base.HandleDisconnected(packet);
+    }
+}

Source/Client/Networking/State/ClientJoiningState.cs

@@ -10,15 +10,24 @@
 namespace Multiplayer.Client
 {
 
-    [PacketHandlerClass(inheritHandlers: false)]
+    // We want to inherit the shared typed packet handlers from ClientBaseState (keepalive, time control, disconnect).
+    // Disabling inheritance can cause missing core handlers during joining and lead to early disconnects / broken UI.
+    [PacketHandlerClass(inheritHandlers: true)]
     public class ClientJoiningState : ClientBaseState
     {
         public ClientJoiningState(ConnectionBase connection) : base(connection)
         {
         }
 
         [TypedPacketHandler]
-        public new void HandleDisconnected(ServerDisconnectPacket packet) => base.HandleDisconnected(packet);
+        public void HandleBootstrap(ServerBootstrapPacket packet)
+        {
+            // Server informs us early that it's in bootstrap/configuration mode.
+            // Full UI/flow is handled on the client side; for now we just persist the flag
+            // so receiving the packet doesn't error during join (tests rely on this).
+            Multiplayer.session.serverIsInBootstrap = packet.bootstrap;
+            Multiplayer.session.serverBootstrapSettingsMissing = packet.settingsMissing;
+        }
 
         public override void StartState()
         {
@@ -122,6 +131,15 @@ void Complete()
 
                 void StartDownloading()
                 {
+                    if (Multiplayer.session.serverIsInBootstrap)
+                    {
+                        // Server is in bootstrap/configuration mode: don't request world data.
+                        // Instead, show a dedicated configuration UI.
+                        connection.ChangeState(ConnectionStateEnum.ClientBootstrap);
+                        Find.WindowStack.Add(new BootstrapConfiguratorWindow(connection));
+                        return;
+                    }
+
                     connection.Send(Packets.Client_WorldRequest);
                     connection.ChangeState(ConnectionStateEnum.ClientLoading);
                 }