diff --git a/README.md b/README.md index fb90309..3142cd4 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,35 @@ Bot Warfare is a GSC mod for the [PlutoniumT6 project](https://plutonium.pw/). ## Installation + 0. Make sure that [PlutoniumT6](https://plutonium.pw/docs/install/) is installed, updated and working properly. - - Download [this repository](https://github.com/ineedbots/t6_bot_warfare/archive/refs/heads/master.zip). -1. Open the Bot Warfare archive you downloaded. -2. Extract/move the files/folders into your `%LOCALAPPDATA%\Plutonium\storage\t6` folder. + - Download [this repository](https://github.com/ineedbots/t6_bot_warfare/archive/refs/heads/master.zip). +1. Open the Bot Warfare archive you downloaded, then open the `t6_bot_warfare-master` folder. +2. Drag the `scripts` folder found inside to `%LOCALAPPDATA%\Plutonium\storage\t6` folder. 3. The mod is now installed, now run your game. 4. The mod should be loaded! Now go start a map and play! + +## Documentation + +### DVARs + +| Dvar | Description | Default Value | +|----------------------------------|---------------------------------------------------------------------------------------------|--------------:| +| bots_main | Enable this mod. | 1 | +| bots_main_waitForHostTime | How many seconds to wait for the host player to connect before adding bots to the match. | 10 | +| bots_main_kickBotsAtEnd | Kick the bots at the end of a match. | 0 | +| bots_manage_add | Amount of bots to add to the game, once bots are added, resets back to `0`. | 0 | +| bots_manage_fill | Amount of players/bots (look at `bots_manage_fill_mode`) to maintain in the match. | 0 | +| bots_manage_fill_mode | `bots_manage_fill` players/bots counting method.