war-brokers-mods/WBM
1
0
Fork 0
Code Issues 24 Releases 30 Activity
WBM/README.md

8.5 KiB
Raw Blame History

War Brokers Mods (WBM)

License: MIT discord invite

IF YOU USE THIS TO DEVELOP HACKS YOUR MOM IS GAY.

WBM logo

War Brokers Mods, AKA WBM is a unofficial mod for War Brokers.

Example Images (click to unfold)

Example 1

Example 2

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

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

  2. Extract (Unzip) the contents to where the game executable is located.

    How to find game location: how to find game location

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

    https://docs.bepinex.dev/v5.4.11/articles/advanced/steam_interop.html

  4. [ IMPORTNT ] Run the game at least once to generate the plugins folder as well as other necessary files.

2. Install WBM

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

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

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

  2. Create a new browser source in OBS studio.

    OBS source

  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.

    OBS source property

Updating

Simply go through the installation process again and replace existing files. You don't have to reinstall BepInEx to reinstall WBM.

Usage

Default shortcuts

  • Hold down LCtrl or RShift to show shortcuts in-game.
  • Press F1 to show menu. Press outside the menu to close.
Function Default Shortcut
Show Menu F1

Move GUI 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 Elo visibility on leaderboard RShift+E
Squad server visibility RShift+S
Testing servers visibility RShift+T
Kill streak sound effect RShift+F
Clear chat RShift+Z
Clear Messages (kills and death log) RShift+X

Toggle shift to crouch RShift+C

Warning

The order of keystroke matter. 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.

Features

  • in-game menu
  • reconfigure shortcut keys
  • clear chat
  • clear game messages (kills, deaths, missile launch, bomb diffuse, etc.)

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)

Elo overlay

Etc

  • persistent configuration
  • kill streak sound effect
  • Quickly change settings with keyboard shortcut

Limitations

WBM is not a hack. WBM will not include any features that will give unfair advantage. 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 damage it.

Building

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

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/ to WBM/dll/. Create directory if it does not exist.

  4. Copy BepInEx.dll from <WB install path>/BepInEx/core to WBM/dll/. Create directory if it does not exist.

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

  6. Create scripts/config.sh.

    #!/bin/bash

WB_PLUGINS_DIR="<PATH_TO_PLUGINS_DIRECTORY_HERE>"

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

Special thanks

License

This project is licenced under the MIT License.

Fonts: