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

updated README

Browse source 
- made badges bigger
- improved readability in general
- moved OBS related information to the WBM-Overlays repository
This commit is contained in:
Kim, Jimin 2022-03-08 13:22:53 +09:00
parent d509a618b4
commit b517914b45
4 changed files with 43 additions and 54 deletions
Download patch file Download diff file Expand all files Collapse all files

97
README.md
View file

@ -1,15 +1,17 @@
# [War Brokers Mods (WBM)](https://github.com/War-Brokers-Mods/WBM)
![License: MIT](https://img.shields.io/github/license/War-Brokers-Mods/WBM?style=flat-square&color=blue)
[![discord invite](https://img.shields.io/badge/Discord-5865F2?style=flat-square&logo=discord&logoColor=white)](https://discord.gg/aQqamSCUcS)
![License: MIT](https://img.shields.io/github/license/War-Brokers-Mods/WBM?style=for-the-badge&color=blue)
[![discord invite](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/aQqamSCUcS)
> **IF YOU USE THIS TO DEVELOP HACKS YOUR MOM IS GAY.**
<p align="center">
<strong>IF YOU USE THIS TO DEVELOP HACKS YOUR MOM IS GAY.</strong>
</p>
<p align="center">
<img src="images/WBM.png" alt="WBM logo"/>
</p>
**W**ar **B**rokers **M**ods, AKA **WBM** is a unofficial mod for [War Brokers](https://store.steampowered.com/app/750470).<br />
**W**ar **B**rokers **M**ods, AKA **WBM** is a mod for [War Brokers](https://store.steampowered.com/app/750470).<br />
<details>
<summary>Example Images (click to unfold)</summary>
@ -22,38 +24,38 @@
## Installation
Only Windows, MacOS, and Linux are officially supported. It is **NOT** compatible with browsers.
Only Windows, MacOS, and Linux are officially supported. It does **NOT** work on browsers.
Usage of the [WBM Installer](https://github.com/War-Brokers-Mods/WBM-installer/releases) is recommended.
<details>
<summary>Manual Installation Instruction (click to unfold)</summary>
<summary>Manual Installation Instruction (not recommended) (click to unfold)</summary>
### 1. Install BepInEx
1. Download the latest version of BepInEx **version 5** from [here](https://github.com/BepInEx/BepInEx/releases). It is important that you download the right version.
1. Download the latest version of [BepInEx](https://github.com/BepInEx/BepInEx/releases) **version 5**.
| Platform | Filename |
| ------------: | :---------------------------- |
| Linux & MacOS | BepInEx\_**unix_5**.Y.Z.W.zip |
| Windows | BepInEx\_**x86_5**.Y.Z.W.zip |
2. Extract (Unzip) the content**S** to where the game is installed.
2. Extract all the contents to where the game is installed.
How to find game location:<br />
![how to find game location](./images/local_files.png)
The folder structure should look like this after unzipping the file:
Now the folder structure should look like this:
```
WarBrokers/
├── BepInEx/
│ ├── core/
│ └── other files...
└── other files...
│ └── ...
└── ...
```
3. **If you are using Linux or MacOS**, you must also perform the following setup:
3. **If you are using Linux or MacOS:**
1. make `run_bepinex.sh` executable: `chmod u+x run_bepinex.sh`
2. Add launch option
@ -82,7 +84,7 @@ Usage of the [WBM Installer](https://github.com/War-Brokers-Mods/WBM-installer/r
### 2. Install WBM
1. [Download](https://github.com/War-Brokers-Mods/WBM/releases/latest) 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.
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:
@ -92,26 +94,15 @@ Usage of the [WBM Installer](https://github.com/War-Brokers-Mods/WBM-installer/r
│ ├── plugins/
│ │ └── WBM
│ │ ├── assets/
│ │ ├── other files...
│ │ └── WBM.dll
│ │ ├── WBM.dll
│ │ └── ...
│ ├── core/
│ └── other files...
└── other files...
│ └── ...
└── ...
```
That's it! You can open War Brokers now.
### 3. Set up OBS (optional)
1. [Download](https://github.com/War-Brokers-Mods/WBM-Overlays/archive/refs/heads/master.zip) the overlays and Unzip it anywhere. (Source code can be found [here](https://github.com/War-Brokers-Mods/WBM-Overlays))
2. Create a new browser source in OBS studio.
![OBS source](./images/obs_source.png)
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-overlays).
![OBS source property](./images/obs_source_props.png)
### Updating
Simply go through the installation process again and replace existing files. You don't have to reinstall BepInEx to reinstall WBM.
@ -122,13 +113,14 @@ Simply go through the installation process again and replace existing files. You
### Warning
The order of keystroke matters.
For example, pressing <kbd>RShift</kbd>+<kbd>A</kbd> is different from pressing <kbd>A</kbd>+<kbd>RShift</kbd>. This is to prevent situation where <kbd>RShift</kbd>+<kbd>A</kbd> fires when the user intended to press <kbd>LCtrl</kbd>+<kbd>RShift</kbd>+<kbd>A</kbd>.
The order of keystroke matters.<br />
For example, pressing <kbd>RShift</kbd>+<kbd>A</kbd> is different from pressing <kbd>A</kbd>+<kbd>RShift</kbd>.<br/>
This is to prevent situation where <kbd>RShift</kbd>+<kbd>A</kbd> fires when the user intended to press <kbd>LCtrl</kbd>+<kbd>RShift</kbd>+<kbd>A</kbd>.
### Default shortcuts
- Hold down <kbd>LCtrl</kbd> or <kbd>RShift</kbd> to show shortcuts in-game.
- Press F1 to show menu. Click outside the menu to close.
- Press F1 to show menu. Click outside the menu to close it.
| Function | Default Shortcut |
| ------------------------------------------ | --------------------------------------------------- |
@ -211,11 +203,7 @@ For example, pressing <kbd>RShift</kbd>+<kbd>A</kbd> is different from pressing
- 50 kill streak: ["godlike"](./assets/audio/godlike.wav)
- 69 kill streak: ["nice"](./assets/audio/nice.wav)
### OBS overlays
- kills and games Elo (size: 355x140)
![Elo overlay](./images/elo.png)
### [OBS overlays](https://github.com/War-Brokers-Mods/WBM-Overlays)
### Etc
@ -228,7 +216,7 @@ For example, pressing <kbd>RShift</kbd>+<kbd>A</kbd> is different from pressing
WBM is not a hack.
WBM will not include any features that will give unfair advantages.
These features include but not limited to:
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.
@ -238,46 +226,47 @@ 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.**
**This is only intended for developers.**
<details>
<summary>Building instructions (click to unfold)</summary>
<br />
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. 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](https://github.com/BepInEx/BepInEx.ConfigurationManager/releases) and put the dll file in `WBM/dll` directory. Other file(s) in the zip file can be deleted.
5. Create `scripts/config.sh`.
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](https://github.com/BepInEx/BepInEx.ConfigurationManager/releases) 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.
```bash
#!/bin/bash
WB_PLUGINS_DIR="<PATH_TO_PLUGINS_DIRECTORY_HERE>"
WB_PLUGINS_DIR="<PATH_TO_PLUGIN_INSTALL_DIRECTORY>"
```
6. Now you can run the scripts.
5. 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.
- `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.
</details>
## 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](https://github.com/War-Brokers-Mods/WBM/issues) and open a new issue!
## Contributing
- use the github pull request.
- use vscode and install [recommended extensions](.vscode/extensions.json). This is required for code formatting.
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](https://github.com/War-Brokers-Mods/WBM/issues) and open a new issue! Alternatively, you can report the bug in my [discord server](https://discord.gg/aQqamSCUcS).
## Special thanks
- [inorganik](https://github.com/inorganik) for [countUp.js](https://github.com/inorganik/countUp.js)
- [l3lackShark](https://github.com/l3lackShark) for [inspiration](https://github.com/l3lackShark/gosumemory)
- [jassper0](https://github.com/jassper0) for [Elo overlay design](https://github.com/l3lackShark/static/tree/master/Simplistic)
## License

BIN
images/elo.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 24 KiB

BIN
images/obs_source.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 18 KiB

BIN
images/obs_source_props.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 18 KiB