# 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.

**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
- Custom score handling made by the server (we don't want to use the game's score handler)

# 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)
Other versions *MIGHT* work with the mod. Try at your own risk.*

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**
    - 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
Go to https://github.com/BepInEx/BepInEx/releases and get the latest stable release for Mono x64 (on Windows).

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.
4. Get the mod from our releases page.
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.
7. You're good to go! Learn how to use the mod in [usage](#usage)

## IL2CPP
**WIP**: The mod will be ported to MelonLoader and recent game versions in the future.

# 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)

## Server (host)
1. Open the mod menu and press **Host** while you're in the main menu.
2. Don't pay attention to what's displayed on the game. It will be an infinite loading screen after the first round.

## Client (player)
1. In the game menu, choose **Online**.
2. Make sure to use a different color than your friends.
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
## I press the Host/Join button and nothing works!
1. Make sure you're in Online mode if you're **joining** a server.
2. Make sure you're in the Main Menu if you're **hosting** a server.
3. Make sure you've passed the `-ip` and `port` arguments correctly to the game.
4. Is the host port accessible? Behind NAT? Use a tunneling software like Zerotier or port-forward.

## On Linux, my game doesn't load with the mod
If you're running Linux, I suggest using the Windows version of the game and running it with Wine/Proton. Then launch the game with the `WINEDLLOVERRIDES="winhttp.dll=n,b"` environment variable set.

On Steam, simply put `WINEDLLOVERRIDES="winhttp.dll=n,b" %command%` in your launch arguments.

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").

# Developer information
- 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`