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.

Example Images (click to unfold)

Installation

Only Windows, MacOS, and Linux are officially supported. It is NOT compatible with browsers.

Usage of the WBM Installer is recommended.

Manual Installation Instruction (click to unfold)

1. Install BepInEx

1. Download the latest version of BepInEx version 5 from here. It is important that you download the right version.

   Platform	Filename
   Linux & MacOS	BepInEx_unix_5.Y.Z.W.zip
   Windows	BepInEx_x86_5.Y.Z.W.zip

2. Extract (Unzip) the contentS to where the game is installed.

   How to find game location:
   

   The folder structure should look like this after unzipping the file:

   WarBrokers/
   ├── BepInEx/
   │   ├── core/
   │   └── other files...
   └── other files...
   

3. If you are using Linux or MacOS, you must also perform the following setup:

   1. make run_bepinex.sh executable: chmod u+x run_bepinex.sh

   2. Add launch option

      where to find game properties:
      

      If you're using linux, set the launch option to:

      ./run_bepinex.sh %command%
      

      If you're using Mac, open a terminal in the game folder and run

      pwd
      

      This will print the full path to the game folder. Copy it, then set the launch option to:

      "PWD_RESULT_HERE/run_bepinex.sh" %command%
      

2. Install WBM

1. Download the latest version of WBM. (WBM.zip file)

2. Unzip it in the <Game folder>/BepInEx/plugins folder. Create one if it doesn't exist.

   The folder structure should look like this after unzipping the file:

   WarBrokers/
   ├── BepInEx/
   │   ├── plugins/
   │   │   └── WBM
   │   │       ├── assets/
   │   │       ├── other files...
   │   │       └── WBM.dll
   │   ├── core/
   │   └── other files...
   └── other files...
   

That's it! You can open War Brokers now.

3. Set up OBS (optional)

1. Download the overlays and Unzip it anywhere. (Source code can be found here)

2. Create a new browser source in OBS studio.

   

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

Warning

The order of keystroke matters. For example, pressing RShift+A is different from pressing A+RShift. This is to prevent situation where RShift+A fires when the user intended to press LCtrl+RShift+A.

Default shortcuts

• Hold down LCtrl or RShift to show shortcuts in-game.
• Press F1 to show menu. Click outside the menu to close.

Function	Default Shortcut
Show Menu	F1
Move GUI (long press)	LCtrl+LShift+Arrow
Move GUI by one pixel	LCtrl+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 kills Elo visibility on leaderboard	RShift+E
Toggle squad server visibility	RShift+S
Toggle Testing servers visibility	RShift+T
Toggle kill streak sound effect	RShift+F
Clear chat	RShift+Z
Clear kills and death log	RShift+X
Toggle shift to crouch	RShift+C

Features

A list of all the features in WBM (click to unfold)

• in-game menu
• custom shortcut keys
• clear chat
• clear game messages (kills, deaths, missile launch, bomb diffuse, etc.)
• Extended fps limit (5~240 => disabled~1000) (may be buggy)

in-game overlays

• Leaderboard

  • kills Elo for each player

• 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

• kill streak sound effect
• Quickly change settings with keyboard shortcuts

Limitations

WBM is not a hack. WBM will not include any features that will give unfair advantages. These features include but not limited to: extended minimap zoom, quick weapon swap, instant zoom, extended field of view, audio filter, etc.

WBM will not include any custom skins. Micro-transaction accounts for a significant portion of the developers' income, and WBM will not include any feature that will affect it.

Building

If you are a casual user, this is completely unnecessary. This is only recommended for developers.

Building instructions (click to unfold)

Assumes that working directory is project root.

1. Install .NET sdk.

2. Clone this repository.

3. Copy all DLL files from <WB install path>/war_brokers_Data/Managed/ and <WB install path>/BepInEx/core to WBM/dll/. Create directory if it does not exist.

4. Download BepInEx configuration manager v16 and put the dll file in WBM/dll directory. Other file(s) in the zip file can be deleted.

5. Create scripts/config.sh.

   #!/bin/bash
   
   WB_PLUGINS_DIR="<PATH_TO_PLUGINS_DIRECTORY_HERE>"
   

6. 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 the github 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

The source code for this project is available under the MIT License.

Fonts:

• https://fonts.google.com/specimen/Architects+Daughter : OFL (used in WBM logo)