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
This commit is contained in:
parent
4771a41fa7
commit
8132f69ed2
8 changed files with 69 additions and 14 deletions
2
.vscode/settings.json
vendored
2
.vscode/settings.json
vendored
|
|
@ -10,7 +10,9 @@
|
|||
"GBSU",
|
||||
"gmenu",
|
||||
"hlapi",
|
||||
"maplist",
|
||||
"netstandard",
|
||||
"Newtonsoft",
|
||||
"playercount",
|
||||
"protontricks",
|
||||
"rotationconfig",
|
||||
|
|
|
|||
|
|
@ -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);
|
||||
|
||||
|
|
|
|||
|
|
@ -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<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
|
||||
|
|
|
|||
|
|
@ -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);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -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>
|
||||
|
|
|
|||
35
Patches/ConfigLoader.cs
Normal file
35
Patches/ConfigLoader.cs
Normal file
|
|
@ -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
|
||||
}
|
||||
}
|
||||
|
|
@ -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()
|
||||
|
|
|
|||
12
README.md
12
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?
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue