ci: bump SDK version

This avoids restarting the game when encountering an unknown issue.

.vscode/settings.json

@@ -10,7 +10,9 @@
         "GBSU",
         "gmenu",
         "hlapi",
+        "maplist",
         "netstandard",
+        "Newtonsoft",
         "playercount",
         "protontricks",
         "rotationconfig",

Addons/GBSUClient.cs

@@ -0,0 +1,32 @@
+using GB.Core;
+using GB.Networking.Utils;
+using GB.Platform.Lobby;
+using UnityEngine;
+
+namespace GBSU.Addons;
+
+public class GBSUClient : MonoBehaviour
+{
+    public static void JoinServer(string serverip, int serverport)
+    {
+        if (!Helper.hosting)
+        {
+            LobbyManager.Instance.LobbyStates.IP = serverip;
+            LobbyManager.Instance.LobbyStates.Port = serverport;
+            LobbyManager.Instance.LobbyStates.CurrentState = LobbyState.State.Ready | LobbyState.State.InGame;
+            LobbyManager.Instance.LocalBeasts.SetupNetMemberContext(true);
+            MonoSingleton<Global>.Instance.UNetManager.LaunchClient(serverip, serverport);
+        }
+        else
+        {
+            GBSUGui.PushError("You are currently hosting a game! Please stop your server before attempting to join.");
+        }
+    }
+
+    // this method should be used when something has went wrong
+    // because players can just use the escape menu to exit
+    public static void DisconnectFromServer()
+    {
+        GBNetUtils.DisconnectSelf(false);
+    }
+}

Addons/GBSUGui.cs

@@ -1,10 +1,6 @@
 using System;
 using System.IO;
 using BepInEx;
-using CoreNet.Config;
-using GB.Config;
-using GB.Core;
-using GB.Game;
 using GB.Platform.Lobby;
 using UnityEngine;
 
@@ -15,28 +11,13 @@ namespace GBSU.Addons;
 public class GBSUGui : MonoBehaviour
 {
     private bool menu_shown;
-    private bool error_shown;
+    private static bool error_shown;
     //private string _currentMap;
     public Rect gmenu = new(Screen.width / 2, 0, 385f, 690f);
     public Rect error_dialog = new(Screen.width / 2, 0, 520f, 175f);
-    private string error_msg = "Unknown error!";
+    private static string error_msg = "Unknown error!";
 
     readonly IInputSystem inputSystem = UnityInput.Current;
-    string serverip = null;
-    int serverport = 5999;
-    string currentmap;
-    bool hosting = false;
-    private void Start()
-    {
-        if (CommandLineParser.Instance.KeyExists("-ip"))
-        {
-            serverip = CommandLineParser.Instance.GetValueForKey("-ip", true);
-        }
-        if (CommandLineParser.Instance.KeyExists("-port"))
-        {
-            int.TryParse(CommandLineParser.Instance.GetValueForKey("-port", true), out serverport);
-        }
-    }
     private void Update()
     {
         if (inputSystem.GetKeyDown(KeyCode.RightShift))
@@ -44,8 +25,6 @@ public class GBSUGui : MonoBehaviour
             //Plugin.Log.LogInfo("Toggling GBSU menu...");
             ToggleMenu();
         }
-
-        currentmap = UnityEngine.SceneManagement.SceneManager.GetActiveScene().name;
     }
 
     private void ToggleMenu()
@@ -67,7 +46,7 @@ public class GBSUGui : MonoBehaviour
         GUI.skin.label.alignment = TextAnchor.UpperLeft;
 
         GUILayout.Label($@"==Guide==
-Set CLI arguments: -ip, -port
+Set CLI arguments: -ip, -port (optionally -maplist)
 
 [Hosting]
 1. Create a config in Gang Beasts_Data/Config/Rotation/config.json
@@ -80,30 +59,26 @@ Set CLI arguments: -ip, -port
         {
             Application.Quit(0);
         }
-        if (serverip != null)
+        if (GUI.Button(new Rect(320f, 45f, 55f, 30f), "Menu"))
+        {
+            Helper.SwitchToMenu();
+        }
+        if (Helper.serverip != null)
         {
             if (GUI.Button(new Rect(20f, 260f, 170f, 30f), "Host"))
             {
                 if (LobbyManager.Instance.LobbyStates.SelfState == LobbyState.Game.Menu)
                 {
-                    if (File.Exists(Helper.RotationFolderPath + "config.json"))
+                    if (File.Exists(Helper.GameConfigPath))
                     {
-                        hosting = true;
-
-                        AudioListener.volume = 0; // mute game audio
-
-                        Plugin.AddServerComp(); // add custom GBSU server component
-                        
                         try
                         {
-                            RotationConfig gameConfig = GBConfigLoader.LoadRotationConfig("config.json", true); // load rotation config from Config/Rotation/config.json
-                            ServerConfig serverConfig = NetConfigLoader.LoadServerConfig(); // load default server config, because it can be overridden by args like -ip and -port
-                            MonoSingleton<Global>.Instance.UNetManager.LaunchServer(serverConfig); // launch the server with the server config
-                            MonoSingleton<Global>.Instance.UNetManager.GetComponent<GameManagerNew>().ChangeRotationConfig(gameConfig, 0); // set server's rotationconfig
+                            GBSUServer.StartServer();
                         }
                         catch (Exception e)
                         {
                             PushError("Looks like you've caught a bug! Please send your log file to us :)\n" + e);
+                            GBSUServer.StopServer();
                         }
                     }
                     else
@@ -122,18 +97,7 @@ Make sure to download a file from the examples given and rename it to config.jso
             {
                 if (LobbyManager.Instance.LobbyStates.SelfState == LobbyState.Game.Online)
                 {
-                    if (!hosting)
-                    {
-                        LobbyManager.Instance.LobbyStates.IP = serverip;
-                        LobbyManager.Instance.LobbyStates.Port = serverport;
-                        LobbyManager.Instance.LobbyStates.CurrentState = LobbyState.State.Ready | LobbyState.State.InGame;
-                        LobbyManager.Instance.LocalBeasts.SetupNetMemberContext(true);
-                        MonoSingleton<Global>.Instance.UNetManager.LaunchClient(serverip, serverport);
-                    }
-                    else
-                    {
-                        PushError("You are currently hosting a match! Please restart the game before attempting to join.");
-                    }
+                    GBSUClient.JoinServer(Helper.serverip, Helper.serverport);
                 }
                 else
                 {
@@ -141,10 +105,6 @@ Make sure to download a file from the examples given and rename it to config.jso
                 }
             }
         }
-        else
-        {
-            PushError("Couldn't find the -ip CLI argument. Please refer to the documentation.");
-        }
 
         if (GUI.Button(new Rect(20f, 295f, 170f, 30f), "Cap FPS to 60"))
         {
@@ -156,19 +116,19 @@ Make sure to download a file from the examples given and rename it to config.jso
         }
         if (GUI.Button(new Rect(20f, 330f, 170f, 30f), "Toggle VSync"))
         {
-            if (QualitySettings.vSyncCount == 0)
+            Helper.FlipVSync();
+        }
+        if (Helper.hosting)
+        {
+            if (GUI.Button(new Rect(195f, 330f, 170f, 30f), "Stop server"))
             {
-                QualitySettings.vSyncCount = 1;
-            }
-            else
-            {
-                QualitySettings.vSyncCount = 0;
+                GBSUServer.StopServer();
             }
         }
 
         GUI.Label(new Rect(20f, 365f, 365f, 400f), $@"
 
-Current map: {currentmap}
+Current map: {UnityEngine.SceneManagement.SceneManager.GetActiveScene().name}
 Lobby State: {LobbyManager.Instance.LobbyStates.SelfState}
 VSync: {QualitySettings.vSyncCount}
 Target FPS: {Application.targetFrameRate}
@@ -198,7 +158,7 @@ Please refer to the documentation for more information.");
     }
     private string UpdateScoreDisplay()
     {
-        if (hosting)
+        if (Helper.hosting)
         {
             string scoreString = "Score:\n";
             foreach (var pair in Plugin.GameScore)
@@ -210,7 +170,7 @@ Please refer to the documentation for more information.");
         return null;
     }
 
-    private void PushError(string message)
+    public static void PushError(string message)
     {
         Plugin.Log.LogError(message);
 

Addons/GBSUServer.cs

@@ -1,3 +1,6 @@
+using CoreNet.Config;
+using GB.Config;
+using GB.Core;
 using GB.Game;
 using HarmonyLib;
 using UnityEngine;
@@ -23,12 +26,45 @@ public class GBSUServer : MonoBehaviour
         //_gmInit = AccessTools.Method(typeof(GameMode), "Init");
         localSingleGang = Traverse.Create(nameof(GameMode)).Field("localSingleGang");
         gameTimer = Traverse.Create(nameof(GameMode)).Field("timer");
+
+        AudioListener.volume = 0; // mute game audio
     }
     void SetLocalGangToOff()
     {
         localSingleGang?.SetValue(false);
     }
 
+    public static void StartServer()
+    {
+        if (!Helper.hosting)
+        {
+            Helper.hosting = true;
+
+            Plugin.AddServerComp(); // add custom GBSU server component
+
+            RotationConfig gameConfig = GBConfigLoader.LoadRotationConfig(null); // the argument doesn't matter as we do stuff in the method
+            ServerConfig serverConfig = NetConfigLoader.LoadServerConfig(); // load default server config, because it can be overridden by args like -ip and -port
+            MonoSingleton<Global>.Instance.UNetManager.LaunchServer(serverConfig); // launch the server with the server config
+            MonoSingleton<Global>.Instance.UNetManager.GetComponent<GameManagerNew>().ChangeRotationConfig(gameConfig, 0); // set server's rotationconfig
+        }
+    }
+
+    public static void StopServer()
+    {
+        // WIP: At the moment the only way to stop the server is to exit/kill the game
+        Helper.hosting = false;
+
+        AudioListener.volume = Helper.saved_volume; // restore volume
+
+        // stop network listener
+        MonoSingleton<Global>.Instance.UNetManager.StopServer();
+
+        // destroy GBSU server comp
+        Plugin.DestroyServerComp();
+
+        // go back to main menu
+        Helper.SwitchToMenu();
+    }
     /*
     public string GetRemainingRoundTime()
     {

Addons/Helper.cs

@@ -1,13 +1,21 @@
 using System;
 using System.IO;
+using GB.Core;
+using GB.Networking.Utils;
+using GB.Platform.Lobby;
 using UnityEngine;
 using UnityEngine.Analytics;
+using UnityEngine.SceneManagement;
 
 namespace GBSU.Addons;
 public class Helper
 {
-    public static string RotationFolderPath = Application.dataPath + "/Config/Rotation/";
+    public static string RotationFolderPath = BepInEx.Paths.BepInExRootPath + "/config/GBSU/";
     public static string GameConfigPath = RotationFolderPath + "config.json";
+    public static string serverip = null;
+    public static int serverport = 5999;
+    public static bool hosting = false;
+    public static float saved_volume;
     public static void DisableAnalytics()
     {
         // Try disabling analytics https://docs.unity3d.com/ScriptReference/Analytics.Analytics-deviceStatsEnabled.html
@@ -49,7 +57,7 @@ public class Helper
         {
             string names = "";
 
-            foreach(FileInfo file in files)
+            foreach (FileInfo file in files)
             {
                 names = file.Name + " " + names;
             }
@@ -57,4 +65,54 @@ public class Helper
             return $"There are {number} files: {names}";
         }
     }
+
+    public static void FlipVSync()
+    {
+        if (QualitySettings.vSyncCount == 0)
+        {
+            QualitySettings.vSyncCount = 1;
+        }
+        else
+        {
+            QualitySettings.vSyncCount = 0;
+        }
+    }
+
+    public static void CheckCustomRotationPath()
+    {
+        // Did the host request to use their own rotation config path?
+        if (CommandLineParser.Instance.KeyExists("-maplist"))
+        {
+            GameConfigPath = CommandLineParser.Instance.GetValueForKey("-maplist");
+            Plugin.Log.LogInfo("Set custom rotation config path at " + GameConfigPath);
+        }
+    }
+
+    public static void SwitchToMenu()
+    {
+        if (hosting)
+        {
+            GBSUGui.PushError("Please press the Stop server button instead!");
+        }
+        else
+        {
+            // uhm, time to panic!
+
+            // let's begin by disconnecting if theres an active connection
+            try
+            {
+                GBNetUtils.DisconnectSelf(false);
+            }
+            catch (Exception e)
+            {
+                Plugin.Log.LogWarning("Couldn't disconnect from server:\n" + e);
+            }
+
+            // go back to main menu
+            SceneManager.LoadScene(Global.MENU_SCENE_NAME);
+
+            // make sure our lobby state is menu
+            LobbyManager.Instance.LobbyStates.SelfState = LobbyState.Game.Menu;
+        }
+    }
 }

GBSU.csproj

@@ -4,7 +4,7 @@
     <TargetFramework>netstandard2.0</TargetFramework>
     <AssemblyName>GBSU</AssemblyName>
     <Product>Gang Beasts Server Utility</Product>
-    <Version>1.0.3</Version>
+    <Version>1.1.0</Version>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <LangVersion>latest</LangVersion>
     <RestoreAdditionalProjectSources>
@@ -42,5 +42,8 @@
   <Reference Include="UnityEngine.CoreModule">
     <HintPath>ref/UnityEngine.CoreModule.dll</HintPath>
   </Reference>
+  <Reference Include="Newtonsoft.Json.dll">
+    <HintPath>ref/Newtonsoft.Json.dll</HintPath>
+  </Reference>
   </ItemGroup>
 </Project>

Patches/ConfigLoader.cs

@@ -0,0 +1,35 @@
+using System;
+using System.IO;
+using GB.Config;
+using GBSU.Addons;
+using HarmonyLib;
+using Newtonsoft.Json;
+
+namespace GBSU.Patches;
+
+[HarmonyPatch]
+class ConfigLoaderPatch
+{
+    [HarmonyPatch(typeof(GBConfigLoader), "LoadRotationConfig")]
+    private static bool Prefix(ref RotationConfig __result)
+    {
+        string text = ""; // contents of file
+
+        Plugin.Log.LogInfo("Loading custom rotation config...");
+
+        // Reading from file
+        try
+        {
+            text = File.ReadAllText(Helper.GameConfigPath);
+            Plugin.Log.LogDebug("Provided rotation config:\n" + text);
+            RotationConfig rc = JsonConvert.DeserializeObject<RotationConfig>(text);
+            __result = rc;
+        }
+        catch (Exception e)
+        {
+            GBSUGui.PushError("Couldn't read game config file. A few details:\n" + e);
+        }
+
+        return false; // skip
+    }
+}

Patches/MultiplayerPatches.cs

@@ -50,7 +50,6 @@ class HandleScorePatch
             Plugin.Log.LogDebug("Done processing all scores!");
         }
 
-        Plugin.Log.LogInfo("Not letting HandleScore run...");
         return false;
     }
 }

Plugin.cs

@@ -1,4 +1,4 @@
-using System.Collections.Generic;
+using System.Collections.Generic;
 using System.Reflection;
 using BepInEx;
 using BepInEx.Logging;
@@ -54,6 +54,26 @@ public class Plugin : BaseUnityPlugin
         Helper.CreateRotationFolder();
 
         Log.LogDebug("Server game config should be found at " + Helper.GameConfigPath);
+
+        // Parse CLI arguments
+        if (CommandLineParser.Instance.KeyExists("-ip"))
+        {
+            Helper.serverip = CommandLineParser.Instance.GetValueForKey("-ip", false);
+        }
+        else
+        {
+            GBSUGui.PushError("Couldn't find the -ip CLI argument. Please refer to the documentation.");
+        }
+        if (CommandLineParser.Instance.KeyExists("-port"))
+        {
+            int.TryParse(CommandLineParser.Instance.GetValueForKey("-port", false), out Helper.serverport);
+        }
+
+        // "-maplist" CLI
+        Helper.CheckCustomRotationPath();
+
+        // store app volume in a variable to restore it if needed
+        Helper.saved_volume = AudioListener.volume;
     }
 
     private static void GBSUCompInit()
@@ -66,19 +86,23 @@ public class Plugin : BaseUnityPlugin
     }
 
     public static void AddServerComp()
+    {
+        DestroyServerComp();
+        Log.LogDebug("Adding GBSUServer component");
+        GBSUCompContainer.AddComponent<GBSUServer>();
+    }
+
+    public static void DestroyServerComp()
     {
         Component[] comps = GBSUCompContainer.GetComponents(typeof(Component));
         foreach (var comp in comps)
         {
             Log.LogDebug("iterating thru singleton comps");
-            if(comp is GBSUServer)
+            if (comp is GBSUServer)
             {
                 Log.LogDebug("GBSUServer component was found! Destroying it");
                 Destroy(comp);
             }
         }
-
-        Log.LogDebug("Adding GBSUServer component");
-        GBSUCompContainer.AddComponent<GBSUServer>();
     }
 }

README.md

@@ -4,7 +4,7 @@ This mod allows you to connect to a Gang Beasts server in recent versions (throu
 **NOTICE: This is not a "Cement" mod, and we don't want to be affiliated with their developers. This mod is standalone, and will work best on its own!**
 
 # Features
-- LAN (ethernet switches at LAN parties) and Online (port forwarding, ZeroTier, Wireguard) multiplayer
+- LAN (Ethernet switches at LAN parties) and Online (port forwarding, ZeroTier, Wireguard) multiplayer
 - Custom score handling made by the server (we don't want to use the game's score handler)
 
 # Installation
@@ -31,11 +31,13 @@ Press `Right Shift` to open the mod GUI. Because of how the game is made, you ne
 
 ## Server (host)
 ### Setting up the server
-1. Open the `Gang Beasts_Data` folder in the "server" game instance files.
-2. Create two new folders: `Config/Rotation`
-3. Download the [one of the config files](https://git.gaboule.com/Gaboule/GBSU/src/branch/main/docs/configs) and place it inside the `Rotation` folder.
+1. Open the `BepInEx` folder in the "server" game instance files.
+2. Create a `GBSU` folder in `config`.
+3. Download the [one of the config files](https://git.gaboule.com/Gaboule/GBSU/src/branch/main/docs/configs) and place it inside the `GBSU` folder.
 4. Rename the file to `config.json`
 
+**Tip: your config file can also be anywhere else! Use the -maplist argument followed by the path to the file,** for example `-ip 192.168.1.2 -port 5999 -maplist "/home/user/mycustomconfig.json"`
+
 ### Configuring your custom server settings
 * If you set `"random": true`, the map order will be randomized.
 * Some maps may have different names in-game compared to their actual titles. Make sure to refer to the [`allmaps` configs](https://git.gaboule.com/Gaboule/GBSU/src/branch/main/docs/configs) for the map names.
@@ -45,7 +47,7 @@ Once the config file is in place, host your server by pressing the **Host** butt
 
 ## Client (player)
 1. In the game menu, choose **Online**.
-2. If you're planning to team up with friends, make sure your [server config]() is set to the `gang` gamemode and choose a shared color. Otherwise, use a different color than your friends.
+2. If you're planning to team up with friends, make sure your server config is set to the `gang` gamemode and choose a shared color. Otherwise, use a different color than your friends.
 3. Open the mod menu and press **Join**.
 
 # Troubleshooting
@@ -62,6 +64,10 @@ On Steam, simply put `WINEDLLOVERRIDES="winhttp.dll=n,b" %command%` in your laun
 
 If it's still not working, try using `winecfg` for your prefix or `protontricks` and go to the libraries tab in Wine Configuration. Simply add `winhttp` as an override and check if it's correctly set as "native, then builtin" (or "n,b").
 
+# Known issues
+- This mode uses the game's netcode. It is poorly made, and you get noticeable latency on localhost (RTT is 10ms). It seems that there's no client-side prediction.
+- The custom score handler only tracks through colors, and is only visible on the host side.
+
 # Contact us
 ## Need help?
 Ask us on [Matrix](https://matrix.to/#/#gbsu:gaboule.com).
@@ -73,4 +79,4 @@ Want a new feature? Found a bug? [Open an issue!](https://git.gaboule.com/Gaboul
 - The mod is made for BepInEx 5
 - The targeted Unity version is `2020.3.5f1`
 - The TFM is `netstandard2.0`
-- The mod is built using .NET SDK `9.0.103`
+- The mod is built using .NET SDK `9.0.304`