Skip to content
This repository has been archived by the owner on Feb 11, 2024. It is now read-only.

Latest commit

 

History

History
290 lines (201 loc) · 9.84 KB

README.md

File metadata and controls

290 lines (201 loc) · 9.84 KB

War Brokers Mods (WBM)

WBM has been officially included into the game

Potentially outdated information (click to unfold)

what's this? discord invite video tutorial

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

WBM logo

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

Example Images (click to unfold)

Example 1

Example 2

Installation

Only Windows, MacOS, and Linux are officially supported. It does NOT work on browsers.

Usage of the WBM Installer is recommended.

Manual Installation Instruction (not recommended) (click to unfold)

1. Install BepInEx

  1. Download the latest version of BepInEx version 5.

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

  2. Extract all the contents to where the game is installed.

    How to find game location:
    how to find game location

    Now the folder structure should look like this:

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

  3. If you are using Linux or MacOS:

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

    2. Add launch option

      where to find game properties:
      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/
│   │       ├── WBM.dll
│   │       └── ...
│   ├── core/
│   └── ...
└── ...

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

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 it.
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 (does not interfere with breath holding)

Sound effects

OBS overlays

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 are 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 intended for developers.

Building instructions (click to unfold)

The guide is intentionally left incomplete. To prevent any regular developers from using this mod to develop hacks, I won't provide any help when it comes to building the mod from scratch.

This guide is only useful to people who's already familiar with reverse engineering, and can create hacks on their own anyway.

Assumes that working directory is project root.

  1. Install .NET sdk.

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

  3. Download and unzip BepInEx configuration manager v16 then copy the dll file to the WBM/dll directory.

  4. Create scripts/config.sh. This will be used to quickly test the mod without having to manually install it.

    #!/bin/bash

WB_PLUGINS_DIR="<PATH_TO_PLUGIN_INSTALL_DIRECTORY>"

  5. Install the zip cli. Most likely you already have it.

  6. Now you can run the scripts.

    • scripts/debug.sh: Builds WBM in debug mode and copy the files to the plugins directory.
    • scripts/release.sh: Creates a zip file that can be uploaded to 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! Alternatively, you can report the bug in my discord server.

Special thanks

  • l3lackShark for inspiration
  • REKT (discord: REKT#7777, 710249221609226320) for:
    • fps improvement by modifying boot.config
    • shader rework
    • video tutorial

License

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

Fonts: