From e8d7e4f9c75de46997703e6ff6d83d90e77d18dd Mon Sep 17 00:00:00 2001 From: ineedbots Date: Wed, 2 Jun 2021 22:42:49 -0600 Subject: [PATCH] First draft --- README.md | 175 ++++++++++++++++++++++++++++++++++++++++ raw/bw_assets/wpedit.md | 1 + 2 files changed, 176 insertions(+) create mode 100644 raw/bw_assets/wpedit.md diff --git a/README.md b/README.md index e69de29..1112c7d 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,175 @@ +![GitHub Logo](/raw/bw-assets/bw-logo.png) + +# PlutoniumIW5 Bot Warfare +Bot Warfare is a GSC mod for the [PlutoniumIW5 project](https://plutonium.pw/). + +It aims to add playable AI to the multiplayer games of Modern Warfare 3. + +You can find the ModDB release post [here](https://www.moddb.com/mods/bot-warfare/downloads/piw5-bot-warfare-latest). + +## Contents +- [Features](#Features) +- [Installation](#Installation) +- [Documentation](#Documentation) +- [Changelog](#Changelog) +- [Credits](#Credits) + +## Features +- A Waypoint Editor for creating and modifying bot's waypoints of traversing the map. Have a look at [Using the Waypoint editor](/raw/bw-assets/wpedit.md). + +- A clean and nice menu, you can edit every bot DVAR within in-game. + +- Everything can be customized, ideal for both personal use and dedicated servers. Have a look at [Documentation](#Documentation) to see whats possible! + +- This mod does not edit ANY stock .gsc files, meaning EVERY other mod is compatible with this mod. Mod doesn't add anything unnecessary, what you see is what you get. + +- Loading waypoints from CSV files, and if the CSV file is missing, will download the CSV from [this repo](https://github.com/ineedbots/piw5_waypoints) automatically. + +- Adds AI clients to multiplayer games to simulate playing real players. (essentially Combat Training for MW2) + - Bots move around the maps with native engine input. (all normal maps, most to all custom maps) + - Bots press all the buttons with native engine input (ads, sprint, jump, etc) + - Bots play all gamemodes/objectives, they capture flags, plant, defuse bombs, etc. ( all normal modes, most custom modes) + - Bots use all killstreaks. Including AC130 and chopper gunner. + - Bots target killstreaks, use stingers and other weapons to take out all killstreaks. ( even sentry guns) + - Bots can capture and steal care packages. + - Bots target equipment, and can even camp TIs. + - Bots can camp randomly or when about to use the laptop. + - Bots can follow others on own will. + - Bots have smooth and realistic aim. + - Bots respond smartly to their surroundings, they will go to you if you shoot, uav, etc. + - Bots use all deathstreaks, perks and weapons. (including javelin) + - Bots difficulty level can be customized and are accurate. (hard is hard, easy is easy, etc.) + - Bots each all have different classes, traits, and difficulty and remember it all. + - Bots switch from between primaries and secondaries. + - Bots can grenade, place claymores and TIs, they even use grenades and tubes in preset map locations. + - Bots use grenade launchers and shotgun attachments. + - Bots can melee people and sentry guns. + - Bots can run! + - Bots can climb ladders! + - Bots jump shot and drop shot. + - Bots detect smoke grenades, stun grenades, flashed and airstrike slows. + - Bots will remember their class, killstreak, skill and traits, even on multiround based gametypes. + - Bots can throwback grenades. + - ... And pretty much everything you expect a Combat Training bot to have + +## Installation +0. Make sure that [PlutoniumIW5](https://forum.plutonium.pw/topic/8262/how-to-install-plutonium-iw5) is installed, updated and working properly. + - Download the [latest release](https://github.com/ineedbots/piw5_bot_warfare/releases) of Bot Warfare. +1. Locate your IW4x install folder. +2. Move the files/folders found in 'Move files to root of IW4x folder' from the Bot Warfare release archive you downloaded into the root of your IW4x install folder. + - The folder/file structure should follow as '.IW4x game folder\mods\bots\z_svr_bots.iwd'. +3. The mod is now installed, now run your game. + - If you are a dedicated server, you will need to set the DVAR 'fs_game' to 'mods/bots' + - If you are not a dedicated server, open the 'Mods' option from the main menu of the game and select 'bots' and then 'Launch'. +4. The mod should be loaded! Now go start a map and play! + +## Documentation + +### Menu Usage +- You can open the menu by pressing the Action Slot 2 key (default '5'). + +- You can navigate the options by pressing your movement keys (default WASD), and you can select options by pressing your jump key (default SPACE). + +- Pressing the menu button again closes menus. + +### DVARs +- bots_manage_add - an integer amount of bots to add to the game, resets to 0 once the bots have been added. + - for example: 'bots_manage_add 10' will add 10 bots to the game. + +- bots_manage_fill - an integer amount of players/bots (depends on bots_manage_fill_mode) to retain on the server, it will automatically add bots to fill player space. + - for example: 'bots_manage_fill 10' will have the server retain 10 players in the server, if there are less than 10, it will add bots until that value is reached. + +- bots_manage_fill_mode - a value to indicate if the server should consider only bots or players and bots when filling player space. + - 0 will consider both players and bots. + - 1 will only consider bots. + +- bots_manage_fill_kick - a boolean value (0 or 1), whether or not if the server should kick bots if the amount of players/bots (depends on bots_manage_fill_mode) exceeds the value of bots_manage_fill. + +- bots_manage_fill_spec - a boolean value (0 or 1), whether or not if the server should consider players who are on the spectator team when filling player space. + +--- + +- bots_team - a string, the value indicates what team the bots should join: + - 'autoassign' will have bots balance the teams + - 'allies' will have the bots join the allies team + - 'axis' will have the bots join the axis team + - 'custom' will have bots_team_amount bots on the axis team, the rest will be on the allies team + +- bots_team_amount - an integer amount of bots to have on the axis team if bots_team is set to 'custom', the rest of the bots will be placed on the allies team. + - for example: there are 5 bots on the server and 'bots_team_amount 3', then 3 bots will be placed on the axis team, the other 2 will be placed on the allies team. + +- bots_team_force - a boolean value (0 or 1), whether or not if the server should enforce periodically the bot's team instead of just a single team when the bot is added to the game. + - for example: 'bots_team_force 1' and 'bots_team autoassign' and the teams become to far unbalanced, then the server will change a bot's team to make it balanced again. + +- bots_team_mode - a value to indicate if the server should consider only bots or players and bots when counting players on the teams. + - 0 will consider both players and bots. + - 1 will only consider bots. + +--- + +- bots_skill - value to indicate how difficult the bots should be. + - 0 will be mixed difficultly + - 1 will be the most easy + - 2-6 will be in between most easy and most hard + - 7 will be the most hard. + - 8 will be custom. + +- bots_skill_axis_hard - an integer amount of hard bots on the axis team. +- bots_skill_axis_med - an integer amount of medium bots on the axis team. +- bots_skill_allies_hard - an integer amount of hard bots on the allies team. +- bots_skill_allies_med - an integer amount of medium bots on the allies team + - if bots_skill is 8 (custom). The remaining bots on the team will become easy bots + - for example: having 5 bots on the allies team, 'bots_skill_allies_hard 2' and 'bots_skill_allies_med 2' will have 2 hard bots, 2 medium bots, and 1 easy bot on the allies team. + +--- + +- bots_loadout_reasonable - a boolean value (0 or 1), whether or not if the bots should filter out bad create a class selections (like no miniuzi bling with acog rapidfire and hardline for example) + +- bots_loadout_allow_op - a boolean value (0 or 1), whether or not if the bots are allowed to use deathstreaks, noobtubes, rpg, laststand, etc. + +- bots_loadout_rank - an integer number, bots will be around this rank, -1 is average of all players in game, 0 is all random + +- bots_loadout_prestige - an integer number, bots will be this prestige, -1 is the same as player, -2 is all random + +- bots_play_move - a boolean value (0 or 1), whether or not if the bots will move +- bots_play_knife - a boolean value (0 or 1), whether or not if the bots will use the knife +- bots_play_fire - a boolean value (0 or 1), whether or not if the bots will fire their weapons +- bots_play_nade - a boolean value (0 or 1), whether or not if the bots will grenade +- bots_play_take_carepackages - a boolean value (0 or 1), whether or not if the bots will take carepackages +- bots_play_obj - a boolean value (0 or 1), whether or not if the bots will play the objective +- bots_play_camp - a boolean value (0 or 1), whether or not if the bots will camp +- bots_play_jumpdrop - a boolean value (0 or 1), whether or not if the bots will jump shot or drop shot +- bots_play_target_other - a boolean value (0 or 1), whether or not if the bots will target claymores, killstreaks, etc. +- bots_play_killstreak - a boolean value (0 or 1), whether or not if the bots will use killstreaks +- bots_play_ads - a boolean value (0 or 1), whether or not if the bots will ads + +--- + +- bots_main - a boolean value (0 or 1), enables or disables the mod + +- bots_main_firstIsHost - a boolean value (0 or 1), the first player to connect is considered a host + +- bots_main_GUIDs - a list of GUIDs (comma separated) of players who will be considered a host + +- bots_main_waitForHostTime - a float value, how long in seconds to wait for the host player to connect before adding in bots + +- bots_main_menu - a boolean value (0 or 1), enables or disables the menu + +- bots_main_debug - a boolean value (0 or 1), enables or disables the waypoint editor + +## Changelog +- v2.0.2 + - soon + +## Credits +- Plutonium Team - https://plutonium.pw/ +- CoD4x Team - https://github.com/callofduty4x/CoD4x_Server +- INeedGames(me) - http://www.moddb.com/mods/bot-warfare +- tinkie101 - https://web.archive.org/web/20120326060712/http://alteriw.net/viewtopic.php?f=72&t=4869 +- PeZBot team - http://www.moddb.com/mods/pezbot +- apdonato - http://rsebots.blogspot.ca/ +- Ability +- Salvation + +Feel free to use code, host on other sites, host on servers, mod it and merge mods with it, just give credit where credit is due! + -INeedGames/INeedBot(s) @ ineedbots@outlook.com diff --git a/raw/bw_assets/wpedit.md b/raw/bw_assets/wpedit.md new file mode 100644 index 0000000..58df056 --- /dev/null +++ b/raw/bw_assets/wpedit.md @@ -0,0 +1 @@ +soon \ No newline at end of file