diff --git a/.vscode/settings.json b/.vscode/settings.json index 2ff4ec6..dc400bf 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,19 +1,14 @@ { "cSpell.words": [ "allmaps", - "anavoi", "Behaviour", "currentmap", "Dont", - "Gaboule", "gamemode", "GBSU", "gmenu", "hlapi", - "maplist", "netstandard", - "Newtonsoft", - "playercount", "protontricks", "rotationconfig", "serverip", diff --git a/Addons/GBSUClient.cs b/Addons/GBSUClient.cs deleted file mode 100644 index bdf45f1..0000000 --- a/Addons/GBSUClient.cs +++ /dev/null @@ -1,32 +0,0 @@ -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.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); - } -} diff --git a/Addons/GBSUGui.cs b/Addons/GBSUGui.cs index 367ef0a..d1447a3 100644 --- a/Addons/GBSUGui.cs +++ b/Addons/GBSUGui.cs @@ -1,6 +1,8 @@ -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; @@ -11,13 +13,28 @@ namespace GBSU.Addons; public class GBSUGui : MonoBehaviour { private bool menu_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 static string error_msg = "Unknown error!"; readonly IInputSystem inputSystem = UnityInput.Current; + string serverip = null; + int serverport = 0; + string currentmap; + int vsync_switch; + 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); + } + + vsync_switch = QualitySettings.vSyncCount; + } private void Update() { if (inputSystem.GetKeyDown(KeyCode.RightShift)) @@ -25,6 +42,8 @@ public class GBSUGui : MonoBehaviour //Plugin.Log.LogInfo("Toggling GBSU menu..."); ToggleMenu(); } + + currentmap = UnityEngine.SceneManagement.SceneManager.GetActiveScene().name; } private void ToggleMenu() @@ -46,7 +65,7 @@ public class GBSUGui : MonoBehaviour GUI.skin.label.alignment = TextAnchor.UpperLeft; GUILayout.Label($@"==Guide== -Set CLI arguments: -ip, -port (optionally -maplist) +Set CLI arguments: -ip, -port, -servername, -serverpassword [Hosting] 1. Create a config in Gang Beasts_Data/Config/Rotation/config.json @@ -59,53 +78,40 @@ Set CLI arguments: -ip, -port (optionally -maplist) { Application.Quit(0); } - if (GUI.Button(new Rect(320f, 45f, 55f, 30f), "Menu")) - { - Helper.SwitchToMenu(); - } - if (Helper.serverip != null) + if (serverip != null && serverport != default) { if (GUI.Button(new Rect(20f, 260f, 170f, 30f), "Host")) { if (LobbyManager.Instance.LobbyStates.SelfState == LobbyState.Game.Menu) { - if (File.Exists(Helper.GameConfigPath)) - { - try - { - 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 - { - PushError(@$"No config.json could be found in {Helper.RotationFolderPath} -Make sure to download a file from the examples given and rename it to config.json. -{Helper.FilesInRotationDir()}"); - } - } - else - { - PushError("Please stay on the main menu to begin hosting. Tip: You might need to exit your lobby."); + hosting = true; + + AudioListener.volume = 0; // mute game audio + + Plugin.AddServerComp(); // add custom GBSU server component + + 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.Instance.UNetManager.LaunchServer(serverConfig); // launch the server with the server config + MonoSingleton.Instance.UNetManager.GetComponent().ChangeRotationConfig(gameConfig, 0); // set server's rotationconfig } } if (GUI.Button(new Rect(195f, 260f, 170f, 30f), "Join")) { if (LobbyManager.Instance.LobbyStates.SelfState == LobbyState.Game.Online) { - GBSUClient.JoinServer(Helper.serverip, Helper.serverport); - } - else - { - PushError("Failed to join lobby! Please select the Online option in-game before joining."); + if (!hosting && serverip != null && serverport != 0) + { + 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.Instance.UNetManager.LaunchClient(serverip, serverport); + } + } } } - if (GUI.Button(new Rect(20f, 295f, 170f, 30f), "Cap FPS to 60")) { Application.targetFrameRate = 60; @@ -116,19 +122,21 @@ 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")) { - Helper.FlipVSync(); - } - if (Helper.hosting) - { - if (GUI.Button(new Rect(195f, 330f, 170f, 30f), "Stop server")) + if (vsync_switch == 0) { - GBSUServer.StopServer(); + vsync_switch = 1; + } + else + { + vsync_switch = 0; } - } + QualitySettings.vSyncCount = vsync_switch; + } + GUI.Label(new Rect(20f, 365f, 365f, 400f), $@" -Current map: {UnityEngine.SceneManagement.SceneManager.GetActiveScene().name} +Current map: {currentmap} Lobby State: {LobbyManager.Instance.LobbyStates.SelfState} VSync: {QualitySettings.vSyncCount} Target FPS: {Application.targetFrameRate} @@ -143,22 +151,9 @@ Please refer to the documentation for more information."); GUI.DragWindow(new Rect(0, 0, 10000, 10000)); } - private void ShowError(int window) - { - GUI.skin.label.alignment = TextAnchor.MiddleCenter; - - GUILayout.Label(error_msg); - - if (GUI.Button(new Rect(420f, 135f, 85f, 30f), "Close")) - { - error_shown = false; - } - - GUI.DragWindow(new Rect(0, 0, 10000, 10000)); - } private string UpdateScoreDisplay() { - if (Helper.hosting) + if (hosting) { string scoreString = "Score:\n"; foreach (var pair in Plugin.GameScore) @@ -170,25 +165,11 @@ Please refer to the documentation for more information."); return null; } - public static void PushError(string message) - { - Plugin.Log.LogError(message); - - // Push this error to the UI - error_msg = message; - error_shown = true; - } - public void OnGUI() { if (menu_shown) { - gmenu = GUILayout.Window(121, gmenu, ShowOurWindow, $"{MyPluginInfo.PLUGIN_NAME} [{MyPluginInfo.PLUGIN_VERSION}]"); - } - - if (error_shown) - { - error_dialog = GUILayout.Window(122, error_dialog, ShowError, "An error occurred!"); + gmenu = GUILayout.Window(121, gmenu, ShowOurWindow, $"{Plugin.PluginName} [{Plugin.PluginVersion}]"); } } -} +} \ No newline at end of file diff --git a/Addons/GBSUServer.cs b/Addons/GBSUServer.cs index 06ee5e8..0fa0a60 100644 --- a/Addons/GBSUServer.cs +++ b/Addons/GBSUServer.cs @@ -1,6 +1,3 @@ -using CoreNet.Config; -using GB.Config; -using GB.Core; using GB.Game; using HarmonyLib; using UnityEngine; @@ -26,45 +23,12 @@ 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); + 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.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 - Helper.SwitchToMenu(); - } /* public string GetRemainingRoundTime() { diff --git a/Addons/Helper.cs b/Addons/Helper.cs index 5a35ade..d53cef5 100644 --- a/Addons/Helper.cs +++ b/Addons/Helper.cs @@ -1,21 +1,9 @@ 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 = 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 @@ -29,90 +17,4 @@ public class Helper Plugin.Log.LogWarning("Failed to disable analytics: " + e.Message); } } - public static void CreateRotationFolder() - { - try - { - Plugin.Log.LogInfo("Creating rotation folder at " + RotationFolderPath); - Directory.CreateDirectory(RotationFolderPath); - } - catch (Exception e) - { - Plugin.Log.LogError("Could not create rotation folder path: " + e.Message); - } - } - public static string FilesInRotationDir() - { - // https://stackoverflow.com/a/14877330 - DirectoryInfo d = new(RotationFolderPath); - FileInfo[] files = d.GetFiles(); - int number = files.Length; - - // no files? - if (number == 0) - { - return @"No files were found in the directory."; - } - else - { - string names = ""; - - foreach (FileInfo file in files) - { - names = file.Name + " " + names; - } - - 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; - } - } -} +} \ No newline at end of file diff --git a/GBSU.csproj b/GBSU.csproj index ea614bf..2a42d53 100644 --- a/GBSU.csproj +++ b/GBSU.csproj @@ -4,7 +4,7 @@ netstandard2.0 GBSU Gang Beasts Server Utility - 1.1.0 + 1.0.2 true latest @@ -21,7 +21,7 @@ - + @@ -42,8 +42,5 @@ ref/UnityEngine.CoreModule.dll - - ref/Newtonsoft.Json.dll - diff --git a/Patches/ConfigLoader.cs b/Patches/ConfigLoader.cs deleted file mode 100644 index b34bfda..0000000 --- a/Patches/ConfigLoader.cs +++ /dev/null @@ -1,35 +0,0 @@ -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 - } -} diff --git a/Patches/MultiplayerPatches.cs b/Patches/MultiplayerPatches.cs index 647331f..c8b7f35 100644 --- a/Patches/MultiplayerPatches.cs +++ b/Patches/MultiplayerPatches.cs @@ -50,6 +50,7 @@ class HandleScorePatch Plugin.Log.LogDebug("Done processing all scores!"); } + Plugin.Log.LogInfo("Not letting HandleScore run..."); return false; } } diff --git a/Plugin.cs b/Plugin.cs index 973fe75..b98969d 100644 --- a/Plugin.cs +++ b/Plugin.cs @@ -1,108 +1,71 @@ -using System.Collections.Generic; -using System.Reflection; -using BepInEx; -using BepInEx.Logging; -using GBSU.Addons; -using HarmonyLib; -using HarmonyLib.Tools; -using UnityEngine; - -#pragma warning disable IDE0051 // Private member is unused - -namespace GBSU; - -[BepInPlugin(MyPluginInfo.PLUGIN_GUID, MyPluginInfo.PLUGIN_NAME, MyPluginInfo.PLUGIN_VERSION)] -[BepInProcess("Gang Beasts.exe")] -public class Plugin : BaseUnityPlugin -{ - public static Dictionary GameScore = []; - private static GameObject _gbsuCompContainer; - internal static ManualLogSource Log; - - public static GameObject GBSUCompContainer - { - get - { - if (_gbsuCompContainer == null) - { - _gbsuCompContainer = new GameObject("GBSUSingletons"); - } - - return _gbsuCompContainer; - } - set - { - Destroy(_gbsuCompContainer); - _gbsuCompContainer = value; - } - } - private void Awake() - { - // Plugin startup logic - Log = base.Logger; - Log.LogInfo($"\n------\nPlugin {MyPluginInfo.PLUGIN_NAME} [{MyPluginInfo.PLUGIN_VERSION}] is loaded!\n------\n"); - - HarmonyFileLog.Enabled = true; - var harmony = new Harmony(MyPluginInfo.PLUGIN_GUID); - harmony.PatchAll(Assembly.GetExecutingAssembly()); - - GBSUCompInit(); - - Helper.DisableAnalytics(); // thank me later - - // create server config path - 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() - { - // Create a container that wont lose our objects - GBSUCompContainer = new GameObject("GBSUSingletons"); - DontDestroyOnLoad(GBSUCompContainer); - GBSUCompContainer.hideFlags = HideFlags.DontUnloadUnusedAsset; - GBSUCompContainer.AddComponent(); - } - - public static void AddServerComp() - { - DestroyServerComp(); - Log.LogDebug("Adding GBSUServer component"); - GBSUCompContainer.AddComponent(); - } - - 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) - { - Log.LogDebug("GBSUServer component was found! Destroying it"); - Destroy(comp); - } - } - } -} +using System.Collections.Generic; +using System.Reflection; +using BepInEx; +using BepInEx.Logging; +using GBSU.Addons; +using HarmonyLib; +using HarmonyLib.Tools; +using UnityEngine; + +#pragma warning disable IDE0051 // Private member is unused + +namespace GBSU; + +[BepInPlugin(PluginGUID, PluginName, PluginVersion)] +[BepInProcess("Gang Beasts.exe")] +public class Plugin : BaseUnityPlugin +{ + public static Dictionary GameScore = []; + private static GameObject _gbsuCompContainer; + internal static ManualLogSource Log; + + public static GameObject GBSUCompContainer + { + get + { + if (_gbsuCompContainer == null) + { + _gbsuCompContainer = new GameObject("GBSUSingletons"); + } + + return _gbsuCompContainer; + } + set + { + Destroy(_gbsuCompContainer); + _gbsuCompContainer = value; + } + } + private void Awake() + { + // Plugin startup logic + Log = base.Logger; + Log.LogInfo($"\n------\nPlugin {PluginName} [{PluginVersion}] is loaded!\n------\n"); + + HarmonyFileLog.Enabled = true; + var harmony = new Harmony(PluginGUID); + harmony.PatchAll(Assembly.GetExecutingAssembly()); + + GBSUCompInit(); + + Helper.DisableAnalytics(); // thank me later + } + + private static void GBSUCompInit() + { + // Create a container that wont lose our objects + GBSUCompContainer = new GameObject("GBSUSingletons"); + DontDestroyOnLoad(GBSUCompContainer); + GBSUCompContainer.hideFlags = HideFlags.DontUnloadUnusedAsset; + GBSUCompContainer.AddComponent(); + } + + public static void AddServerComp() + { + GBSUCompContainer.AddComponent(); + } + + public const string PluginGUID = "com.gaboule.plugins.gbsu"; + public const string PluginName = "Gang Beasts Server Utility"; + public const string PluginVersion = "1.0.2"; +} diff --git a/README.md b/README.md index 2c366c7..ca415d8 100644 --- a/README.md +++ b/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,13 +31,11 @@ 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 `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. +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. 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. @@ -47,7 +45,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,10 +62,6 @@ 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). @@ -79,4 +73,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.304` \ No newline at end of file +- The mod is built using .NET SDK `9.0.103` \ No newline at end of file