.vscode | ||
assets/audio | ||
images | ||
scripts | ||
WBM | ||
.gitignore | ||
LICENSE | ||
README.md | ||
WBM.sln |
War Brokers Mods (WBM)
IF YOU USE THIS TO DEVELOP HACKS YOUR MOM IS GAY.
War Brokers Mods, AKA WBM is a unofficial mod for War Brokers.
Installation
Only Windows, MacOS, and Linux are officially supported. It is Not compatible with browsers.
WARNING
I do not upload WBM anywhere other than github. If you find it elsewhere, IT IS NOT UPLOADED BY ME.
1. Install BepInEx
-
Download the latest version of BepInEx version 5 from here.
Platform Filename Linux & MacOS BepInEx_unix_5.Y.Z.W.zip Windows BepInEx_x86_5.Y.Z.W.zip -
Extract (Unzip) the contents to where the game executable is located.
-
If you are using Linux or MacOS, you must also perform the following setup:
https://docs.bepinex.dev/v5.4.11/articles/advanced/steam_interop.html
-
[ IMPORTNT ] Run the game at least once to generate the plugins folder as well as other necessary files.
2. Install WBM
-
Download the latest version of WBM. (
WBM.zip
file) -
Unzip it in the
<Game folder>/BepInEx/plugins
folder.It should look like this:
plugins └── WBM ├── assets │ └── audio │ └── ... └── WBM.dll
3. Set up OBS (optional)
-
Download the overlays and Unzip it anywhere. (Source code can be found here)
-
Create a new browser source in OBS studio.
-
Check the
Local file
checkbox and use a.html
file of the overlay you want to use. Width and height of the overlays can be found here.
Updating
Simply go through the installation process again and replace existing files. You don't have to reinstall BepInEx to reinstall WBM.
Usage
- Hold down LCtrl or RShift to show shortcuts in-game.
Function | Shortcut |
---|---|
Move GUI by one pixel at a time | LCtrl+Arrow |
Move GUI (long press) | LCtrl+LShift+Arrow |
Reset GUI position | LCtrl+R |
Toggle All GUI visibility | RShift+A |
Toggle Player statistics visibility | RShift+P |
Toggle Weapon statistics visibility | RShift+W |
Toggle Team statistics visibility | RShift+L |
Toggle Elo visibility on leaderboard | RShift+E |
Squad server visibility | RShift+S |
Testing servers visibility | RShift+T |
Toggle shift to crouch | RShift+C |
Reset everything | RShift+R |
Features
in-game overlays
-
Tab Leaderboard
- show kills Elo
-
Player statistics
- KDR
- kills Elo
- kills Elo earned/lost
- games Elo
- games Elo earned/lost
- total damage dealt
- longest kill
- points earned
- headshot count
- kill streak
-
Weapon statistics
- fire timer
- reload timer
- cooldown timer
- bullet speed
- current zoom
-
Team statistics
- in-game nick
- kdr
- points earned
- damage dealt
- total damage dealt
- total deaths
- total kills
Controls
- Shift to crouch
Sound effects
- 10 kill streak: "rampage"
- 20 kill streak: "killing spree"
- 30 kill streak: "unstoppable"
- 50 kill streak: "godlike"
- 69 kill streak: "nice"
OBS overlays
- kills and games Elo (size: 355x140)
Etc
- persistent configuration
- kill streak sound effect
- Quickly change settings with keyboard shortcut
Building
If you are a casual user, this is completely unnecessary. This is only recommended for developers.
Assumes that working directory is project root.
-
Install .NET sdk.
-
Clone this repository.
-
Copy all DLL files from
<WB install path>/war_brokers_Data/Managed/
to./WBM/dll/
. Create directory if it does not exist. -
Create
scripts/config.sh
.#!/bin/bash WB_PLUGINS_DIR="<PATH_TO_PLUGINS_DIRECTORY_HERE>"
-
Now you can run the scripts.
scripts/debug.sh
: Build WBM in debug mode and copy the files to the plugins directory.scripts/release.sh
: Create a zip file that can be uploaded in the gh release section.
Bug reports / Suggestions
If you have a cool idea that will make WBM better, or if WBM misbehaves in any way (no matter how minor the problem is), feel free go to the Issues page and open a new issue!
Contributing
- use GH pull request
- use vscode and install recommended extensions. This is required for code formatting.
Special thanks
- inorganik for countUp.js
- l3lackShark for inspiration
- jassper0 for Elo overlay design
License
This project is licenced under the MIT License.
Fonts:
- https://fonts.google.com/specimen/Architects+Daughter : OFL (used in WBM logo)