Gaboule/GBSU
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases 5 Activity

docs: clarify readme and add new instructions

Browse source
This commit is contained in:
anavoi 2025-03-15 21:34:59 +01:00
commit 32080028d6
1 changed files with 24 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

50
README.md
View file

@ -1,5 +1,5 @@
# GBSU (Gang Beasts Server Utility) # GBSU (Gang Beasts Server Utility)
This mod allows you to connect to a Gang Beast server in recent versions (through LAN or Internet) by utilizing developer methods found in the game assembly. This mod allows you to connect to a Gang Beasts server in recent versions (through LAN or Internet) by utilizing developer methods found in the game assembly.
**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!** **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!**
@ -8,48 +8,46 @@ This mod allows you to connect to a Gang Beast server in recent versions (throug
- Custom score handling made by the server (we don't want to use the game's score handler) - Custom score handling made by the server (we don't want to use the game's score handler)
# Installation # Installation
The mod is made for the game version **1.17.39_WS_8af7688** running on Unity **v2020.3.5.8426922** (check your version in the Settings menu in-game) 1. Check your game version in the "Settings" menu in-game. If the version is **1.17.39_WS_8af7688**, we fully support it.
Other versions *MIGHT* work with the mod. Try at your own risk.* 2. Check whether your game is Mono or IL2CPP: Go to 'Gang Beasts_Data'
- If you have a folder called `MonoBleedingEdge` or the `Gang Beasts_Data/Managed` folder contains a file called 'Assembly-CSharp.dll': your game is **Mono**. Continue to [Mono instructions](#mono).
1. Check whether your game is Mono or IL2CPP: Go to 'Gang Beasts_Data' - If you have a il2cpp_data folder: your game is **IL2CPP**. Continue to [IL2CPP instructions](#il2cpp).
- If you have a il2cpp_data folder: your game is **IL2CPP**
- If you have a folder called `MonoBleedingEdge` or the `Gang Beasts_Data/Managed` folder contains a file called 'Assembly-CSharp.dll': your game is **Mono**
2. **Follow the instructions based on the game type:**
## Mono ## Mono
Go to https://github.com/BepInEx/BepInEx/releases and get the latest stable release for Mono x64 (on Windows). 1. [Download the latest **BepInEx 5 stable** release for Mono x64](https://github.com/BepInEx/BepInEx/releases). As of March 2025, we recommend getting `BepInEx_win_x64_5.4.23.2.zip`
2. Extract the zip file contents into your root game folder (where the Gang Beasts.exe file is, and not in the 'Gang Beasts_Data' folder!)
1. As of March 2025, what we recommend doing is getting `BepInEx_win_x64_5.4.23.2.zip`.
2. Extract the zip file contents into your root game folder (not in the 'Gang Beasts_Data' folder!)
3. Launch the game once. 3. Launch the game once.
4. Get the mod from our releases page. 4. Get the mod from our [releases page](https://git.gaboule.com/Gaboule/GBSU/releases).
5. Put the .dll file in the `BepInEx/plugins` folder. 5. Put the .dll file in the `BepInEx/plugins` folder.
6. Launch the game with launch arguments `-ip 1.2.3.4` and `-port 5999` with the IP address and port of the server you want to host or connect to. 6. Launch the game with launch arguments `-ip 1.2.3.4` and `-port 5999` with the IP address and port of the server you want to host or connect to.
7. You're good to go! Learn how to use the mod in [usage](#usage) - To set those arguments on Steam, [please refer to this guide](https://help.steampowered.com/en/faqs/view/7D01-D2DD-D75E-2955).
7. You're good to go! Learn how to use the mod in [usage](#usage).
## IL2CPP ## IL2CPP
**WIP**: The mod will be ported to MelonLoader and recent game versions in the future. **WIP**: You're currently out of luck! The mod doesn't support your game version at the moment. It will be ported to MelonLoader in the future. Try downgrading your game by getting older versions in Steam Betas or by using [DepotDownloader](https://github.com/SteamRE/DepotDownloader).
# Usage # Usage
Press `Right Shift` to open the mod GUI. Because of how the game is made, you need to be very careful when executing the steps else you will need to restart it. (will be fixed in future versions) Press `Right Shift` to open the mod GUI. Because of how the game is made, you need to be very careful when executing the steps else you will need to restart it. (will be fixed in future versions)
## Server (host) ## Server (host)
1. Open the mod menu and press **Host** while you're in the main menu. ### Setting up the server
2. Don't pay attention to what's displayed on the game. It will be an infinite loading screen after the first round. 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`
### 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.
### Launching the server
Once the config file is in place, host your server by pressing the **Host** button in the mod menu. Don't pay attention to what's displayed on the game. It will be an infinite loading screen after the first round.
## Client (player) ## Client (player)
1. In the game menu, choose **Online**. 1. In the game menu, choose **Online**.
2. Make sure to 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**. 3. Open the mod menu and press **Join**.
# Known Issues
- Scores tab on the server is expected be wrong. This is a temporary implementation and the scores will be reworked.
- The server is not headless.
- If you want to play on your server, you need to launch a different game instance. It is not possible to connect to the server after launching it at the moment.
- Getting the current scene isn't the most efficient way at the moment.
# Troubleshooting # Troubleshooting
## I press the Host/Join button and nothing works! ## I press the Host/Join button and nothing works!
1. Make sure you're in Online mode if you're **joining** a server. 1. Make sure you're in Online mode if you're **joining** a server.