From 8132f69ed26790c397d8e84c511d49738aac51ab Mon Sep 17 00:00:00 2001 From: anavoi Date: Sun, 13 Jul 2025 23:32:42 +0200 Subject: [PATCH 1/3] fix(breaking): better handling of the server rotation config The config path was also changed to `BepInEx/config/GBSU/config.json` Tracks the -maplist argument --- .vscode/settings.json | 2 ++ Addons/GBSUGui.cs | 10 +++++----- Addons/GBSUServer.cs | 2 +- Addons/Helper.cs | 12 +++++++++++- GBSU.csproj | 3 +++ Patches/ConfigLoader.cs | 35 +++++++++++++++++++++++++++++++++++ Plugin.cs | 7 +++++-- README.md | 12 +++++++----- 8 files changed, 69 insertions(+), 14 deletions(-) create mode 100644 Patches/ConfigLoader.cs diff --git a/.vscode/settings.json b/.vscode/settings.json index 3a66143..2ff4ec6 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -10,7 +10,9 @@ "GBSU", "gmenu", "hlapi", + "maplist", "netstandard", + "Newtonsoft", "playercount", "protontricks", "rotationconfig", diff --git a/Addons/GBSUGui.cs b/Addons/GBSUGui.cs index 1d72761..2e6cd6e 100644 --- a/Addons/GBSUGui.cs +++ b/Addons/GBSUGui.cs @@ -11,11 +11,11 @@ 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; private void Update() @@ -46,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 @@ -65,7 +65,7 @@ Set CLI arguments: -ip, -port { if (LobbyManager.Instance.LobbyStates.SelfState == LobbyState.Game.Menu) { - if (File.Exists(Helper.RotationFolderPath + "config.json")) + if (File.Exists(Helper.GameConfigPath)) { Helper.hosting = true; @@ -176,7 +176,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); diff --git a/Addons/GBSUServer.cs b/Addons/GBSUServer.cs index 2ab58be..7f7302b 100644 --- a/Addons/GBSUServer.cs +++ b/Addons/GBSUServer.cs @@ -34,7 +34,7 @@ public class GBSUServer : MonoBehaviour public static void StartServer() { - RotationConfig gameConfig = GBConfigLoader.LoadRotationConfig("config.json", true); // load rotation config from Config/Rotation/config.json + 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.Instance.UNetManager.LaunchServer(serverConfig); // launch the server with the server config MonoSingleton.Instance.UNetManager.GetComponent().ChangeRotationConfig(gameConfig, 0); // set server's rotationconfig diff --git a/Addons/Helper.cs b/Addons/Helper.cs index daa4d4b..454b68f 100644 --- a/Addons/Helper.cs +++ b/Addons/Helper.cs @@ -6,7 +6,7 @@ using UnityEngine.Analytics; 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; @@ -72,4 +72,14 @@ public class Helper 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); + } + } } \ No newline at end of file diff --git a/GBSU.csproj b/GBSU.csproj index 10a02a9..e892787 100644 --- a/GBSU.csproj +++ b/GBSU.csproj @@ -42,5 +42,8 @@ ref/UnityEngine.CoreModule.dll + + ref/Newtonsoft.Json.dll + diff --git a/Patches/ConfigLoader.cs b/Patches/ConfigLoader.cs new file mode 100644 index 0000000..10f6c83 --- /dev/null +++ b/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(text); + __result = rc; + } + catch (Exception e) + { + GBSUGui.PushError("Couldn't read game config file. A few details:\n" + e); + } + + return false; // skip + } +} \ No newline at end of file diff --git a/Plugin.cs b/Plugin.cs index 5b2b533..c4a2a57 100644 --- a/Plugin.cs +++ b/Plugin.cs @@ -58,12 +58,15 @@ public class Plugin : BaseUnityPlugin // Parse CLI arguments if (CommandLineParser.Instance.KeyExists("-ip")) { - Helper.serverip = CommandLineParser.Instance.GetValueForKey("-ip", true); + Helper.serverip = CommandLineParser.Instance.GetValueForKey("-ip", false); } if (CommandLineParser.Instance.KeyExists("-port")) { - int.TryParse(CommandLineParser.Instance.GetValueForKey("-port", true), out Helper.serverport); + int.TryParse(CommandLineParser.Instance.GetValueForKey("-port", false), out Helper.serverport); } + + // "-maplist" CLI + Helper.CheckCustomRotationPath(); } private static void GBSUCompInit() diff --git a/README.md b/README.md index a1dbf6c..30548cb 100644 --- a/README.md +++ b/README.md @@ -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 @@ -64,7 +66,7 @@ If it's still not working, try using `winecfg` for your prefix or `protontricks` # 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 is broken +- The custom score handler only tracks through colors, and is only visible on the host side. # Contact us ## Need help? From 962bcaf199db617665d886e40b47ace0c74728ce Mon Sep 17 00:00:00 2001 From: anavoi Date: Sun, 13 Jul 2025 23:33:10 +0200 Subject: [PATCH 2/3] perf: removed useless info logging --- Patches/MultiplayerPatches.cs | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/Patches/MultiplayerPatches.cs b/Patches/MultiplayerPatches.cs index c8b7f35..76c486e 100644 --- a/Patches/MultiplayerPatches.cs +++ b/Patches/MultiplayerPatches.cs @@ -49,8 +49,7 @@ class HandleScorePatch Plugin.Log.LogDebug("Done processing all scores!"); } - - Plugin.Log.LogInfo("Not letting HandleScore run..."); + return false; } } From 5eedbf2f1e6738476209149127b0a2bf32d23944 Mon Sep 17 00:00:00 2001 From: anavoi Date: Sun, 13 Jul 2025 23:47:40 +0200 Subject: [PATCH 3/3] feat: start/stop server handling The original app volume is also restored when the server is stopped. --- Addons/GBSUGui.cs | 15 ++++++++------- Addons/GBSUServer.cs | 23 +++++++++++++++++++++++ Addons/Helper.cs | 1 + Plugin.cs | 3 +++ 4 files changed, 35 insertions(+), 7 deletions(-) diff --git a/Addons/GBSUGui.cs b/Addons/GBSUGui.cs index 2e6cd6e..cac5917 100644 --- a/Addons/GBSUGui.cs +++ b/Addons/GBSUGui.cs @@ -67,20 +67,14 @@ Set CLI arguments: -ip, -port (optionally -maplist) { if (File.Exists(Helper.GameConfigPath)) { - Helper.hosting = true; - - AudioListener.volume = 0; // mute game audio - try { - Plugin.AddServerComp(); // add custom GBSU server component GBSUServer.StartServer(); } catch (Exception e) { PushError("Looks like you've caught a bug! Please send your log file to us :)\n" + e); - Helper.hosting = false; - Plugin.DestroyServerComp(); + GBSUServer.StopServer(); } } else @@ -131,6 +125,13 @@ Make sure to download a file from the examples given and rename it to config.jso { Helper.FlipVSync(); } + if (Helper.hosting) + { + if (GUI.Button(new Rect(195f, 330f, 170f, 30f), "Stop server")) + { + GBSUServer.StopServer(); + } + } GUI.Label(new Rect(20f, 365f, 365f, 400f), $@" diff --git a/Addons/GBSUServer.cs b/Addons/GBSUServer.cs index 7f7302b..2197a47 100644 --- a/Addons/GBSUServer.cs +++ b/Addons/GBSUServer.cs @@ -4,6 +4,7 @@ using GB.Core; using GB.Game; using HarmonyLib; using UnityEngine; +using UnityEngine.SceneManagement; #pragma warning disable IDE0051 // Private member is unused @@ -34,11 +35,33 @@ public class GBSUServer : MonoBehaviour public static void StartServer() { + Helper.hosting = true; + AudioListener.volume = 0; // mute game audio + + 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.Instance.UNetManager.LaunchServer(serverConfig); // launch the server with the server config MonoSingleton.Instance.UNetManager.GetComponent().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.Instance.UNetManager.StopServer(); + + // destroy GBSU server comp + Plugin.DestroyServerComp(); + + // go back to main menu + SceneManager.LoadScene("Menu"); + } /* public string GetRemainingRoundTime() { diff --git a/Addons/Helper.cs b/Addons/Helper.cs index 454b68f..16b4a19 100644 --- a/Addons/Helper.cs +++ b/Addons/Helper.cs @@ -11,6 +11,7 @@ public class Helper 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 diff --git a/Plugin.cs b/Plugin.cs index c4a2a57..ed90b37 100644 --- a/Plugin.cs +++ b/Plugin.cs @@ -67,6 +67,9 @@ public class Plugin : BaseUnityPlugin // "-maplist" CLI Helper.CheckCustomRotationPath(); + + // store app volume in a variable to restore it if needed + Helper.saved_volume = AudioListener.volume; } private static void GBSUCompInit()