Name of Mod : The Jumbot File Name : jumbot05.zip Version : 0.5 Date : September 10, 1999 E-mail : thefatal@telefragged.com Web Site : http://www.telefragged.com/thefatal/ Additional Credits : Thanks to all the people who've helped me and given me support, especially people like Strider and news sites like the Bot Epidemic. I appreciate all of the support. Thanks to Brian McClelland and Adam Smith for helping test the bot and informing me of various bugs. Thanks to John Crickett (author of the Oak bot) for the helpful information on file I/O. AUTHOR INFO ----------- I'm also the author of the Famkebot, Head Soccer, and many other things. TYPE OF MOD ----------- This is a DeathMatch, Teamplay, and Cooperative bot for Half-Life. Programming : All of it. Sound : Nope. MDL : Nope. Maps : Nope. Graphics : Nope. VERSION HISTORY --------------- 0.5: Fixed tripmine avoidance. Added bot yaw speed option. Bots try harder not to blow themselves up. Fixed leader-following AI to work better. Bots no longer ignore pain while using HEV/health chargers. Fixed a bug in the bot's enemy-tracking AI. Corrected a bug which was causing developer mode to generate problems as well as causing crashes on some systems in both dev and non-dev modes. 0.4: Added waypoint option for bots to jump at certain locations. Fixed delay which made execbots.cfg not work properly. Added item-getting troubleshooting methods. Fixed a bug in the waypoint code that may have been causing bad edict errors on some systems. Added troubleshooting routines to the scientist killing scripts in cooperative mode for if the bot can't get to the desired distance. Bots now try to place tripmines strategically through the level (though there's only so much they can do to try to find a good place). Bots no longer shoot their own tripmines or tripmines that belong to teammates in teamplay mode. Bot weapon priority numbers can now be set in the jumbot.cfg file. Bots will now gauss-jump to get to items they cannot normally reach. Made an extremely large speed increase in the advanced bot routines. speedup 0 should provide an acceptable framerate on most systems now. Added "speedup 2" option to only disable the things which take a heavy amount of CPU power. This keeps things like edge clipping to get items and such enabled. Added a "delayed reaction" option, which is used for enemies, mines, etc. The first time I saw a bot kill another bot with a tripmine, it just gave me a nice warm feeling. --- 0.35: RPG dot bug finally fixed. Various speed optimizations. Added a waypoint value to the jumbot.cfg file to disable use of waypoints. Improved the bot's non-waypoint roaming significantly. Added auto-adjust option for bot millisecond update value (this is now defaulted to). Problem with client slots not being freed over level changes is now fixed. Fixed bots attacking monster corpses in coop. --- 0.3: Bots have full use of ladders now. Bug where RPG dot stayed after bots dying is fixed. Bots are attacked by snarks and the hornet gun now. Hopefully fixed the problem with some systems crashing after chatting was enabled for a while. Fixed problem with real clients not being able to chat with eachother while running the bot. Fixed bug that allowed bots to chat to non-client entities. Hopefully fixed bug that caused keeping speedup set at 0 to crash some systems. Bots perform better with waypoints under water. --- 0.2: All known stability problems fixed. Windows NT incompatibility problem fixed. Weapon selection bug fixed (bots ignored many of the regular weapons even if they had them). Bots now use secondary fire much more intelligently. Added Jumbot.cfg file to be executed on startup so that your personal preferences do not have to be typed in each time you load the bot (execution of the file can be disabled through a cvar). There is now a cvar to set the name of the file which the bot's name, model, etc. is read in through, so you can have an endless number of bot configuration files. Chat support is now fully working. Chat files are selectable just as bot configuration files are. bot_num cvar added to maintain a constant number of bots on the server. This is useful for dedicated servers and such. Quotes can now be used in the bots.cfg file to indicate that a name has a space in it (e.g. "Lera Yvette" instead of Lera_Yvette). Chat files can now have anywhere from 3 to an infinite number of lines for each section (they are no longer limited to 30 lines each). Added edge clipping for items, combat, etc (bots will not jump off of uncrossable ledges after items and will not fall off of ledges while strafing to avoid fire during combat). Cooperative play support added. See the "STARTING A COOP GAME" section for details on how to use it. ---- 0.1: First release. Features include standard server-side client emulation, full weapon support, a new full level navigation system, and more. INSTALLATION AND USE -------------------- If you have a previous version of the Jumbot installed, then delete your old Jumbot folder before doing anything. You may wish to back up your existing config files and such for the bot first. Extract the zip file WITH DIRECTORY STRUCTURE directly to your Half-Life directory. If you did it correctly, you'll have a new "jumbot" folder under your Half-Life folder. Now start Half-Life with the console (-console at the command line). Once in the menu, use the custom game option to activate the Jumbot. Now just start a regular LAN game through the menu (note that if you want to use the bots on teams, just set up the game to use Teamplay as you normally would) and use the console (~ key) to enter commands and change values (which are listed below). If there is no waypoint file for the bot, you'll need to place waypoints yourself and save them to a file once you're happy with their placement. See below for the various waypoint management commands and values. Before getting into a game with the bot, you'll probably also want to edit the jumbot.cfg file in your hl\jumbot folder and change it to fit your own preferences. TROUBLESHOOTING AND PERFORMANCE ISSUES -------------------------------------- You should note that the Jumbot uses some fairly advanced navigation routines that require a good amount of processor speed. However, the bot can still get around levels quite well without the use of those routines, so there is an option to disable them for those of you with slower computers. Simply use the speedup cvar in the console, which you can read more about below. Also note that increasing the bot's thinking speed to a higher value (also done through a cvar, see below) can take more load off of the processor because the bot does not need to do as many calculations per second. These settings would be optimal for both compatibility and for performance: waypoints 0 speedup 1 bot_thinkspeed 1 However, I would still recommend keeping waypoints set at 1. It doesn't cause that much CPU power to be used up and improves the bot's navigational ability greatly (although it does require the level to have a JRF file for it, which you can make yourself as shown in the waypointing section of this file). If you're experiences crashes or Half-Life exits to your desktop after a certain amount of time, try setting msec_max to a lower value, such as 30 or so. CUSTOM BOT CONFIG FILES ----------------------- The Jumbot comes with 2 custom bot configuration files. bots.cfg, and execbots.cfg. The information in bots.cfg is read and used if nobotcfg is not set to 1 each time a bot is added. To use execbots.cfg, type "exec execbots.cfg" in the Half-Life console. It will set nobotcfg to 1 and use the information in the file. Both files can be edited and added to freely using any standard text editor. CUSTOM CHAT CONFIG FILES ------------------------ Custom chat files can be specified using the chatfile cvar (see below). By default, botchat.cfg will be used. This file can be edited and such to your liking with any standard text editor. Each chat file holds a total of 60 comments (30 for dying, 30 for killing). All chat files should be placed in the Jumbot directory located under your Half-Life directory. As an example, if you have a bot chat file called "chat2.cfg" that you want to use instead of botchat.cfg, then you can simply type "chatfile chat2.cfg" in the Half-Life console. From then on, all bot chat comments will be read from chat2.cfg instead of botchat.cfg. STARTING A COOP GAME -------------------- First, start a regular DM game. Now, bring down the console, and type the following: disconnect deathmatch 1 coop 1 sv_cheats 1 map If you want to load another level, repeat the same process. should be the level that you want to load. However, it is important to note that coop support was never even actually finished in Half-Life. So, it is more than likely that you'll get errors or crashes if you try to play on the original single player levels. I recommend using some of the many available "scientist death maps" or any single player level that isn't cut up into sections. After you've started the game, you can use the coop_scikill and coop_killmeth cvars to change how the bot behaves. Details on using the cvars are below under "SETTINGS AND COMMANDS". SETTINGS AND COMMANDS --------------------- nostartexec (cvar): Default is 0. Setting to 1 causes the jumbot.cfg file to not be executed at the start of each level. addbot (command): Adds a bot into the server. removebot (command): Removes the last created bot from the server. bot_num (cvar): Sets a constant number of bots in the game (useful for servers running the mod and such). waypoints (cvar): Default is 1. Setting to 0 disables use of waypoints. botfov (cvar): Sets the bot's field of vision. Works just like the player's "fov" cvar. Default is 90. botusefov (cvar): Default is 1. Setting to 0 tells the bot not to limit its view to its field of vision. bothearing (cvar): Default is 1. Setting to 0 disables the bot's ability to detect things by hearing them instead of viewing them. botpain (cvar): Default is 1. Setting to 0 will disable the bot's ability to detect an enemy by figuring out which direction it is feeling pain from (even if it cannot hear or see its enemy). botaccuracy (cvar): Allows you to set the accuracy of the bot. The default is 10. The lowest is 0, which is perfect, and the highest is 160, which is extremely bad. bot_tripmines (cvar): Enables and disables allowing bots to place tripmines. Default is 1 (enabled). bot_gauss (cvar): Enables and disables allowing bots to gauss jump to get to high-up items. Default is 1 (enabled). botspeed (cvar): Allows you to increase or decrease the bot's running speed (higher increases, negative value decreases). bot_crowbar (cvar): Toggles the bot's use of the crowbar only on and off. 1 is on, 0 is off. Default is 0. bot_yawspeed (cvar): Changes how fast the bot can turn. Higher is faster, lower is slower. Default is 25. botmsec (cvar): Changes bot physics update speed. Default is 0, which means to auto-adjust. msec_min (cvar): Minimum value the msec value can reach when botmsec is set to auto-adjust. msec_max (cvar): Maximum value the msec value can reach when botmsec is set to auto-adjust. botcfgfile (cvar): Changes the name of the file used to get bot names, models, etc. from in your Jumbot directory. The default is bots.cfg. botchat (cvar): Default is 0. Setting to 1 enables bot chatting. chatfreq_died (cvar): Sets how often a bot will speak after it dies. Should be between 0.1 and 10. 0.1 would be hardly ever, 10 would be every time. chatfreq_killed (cvar): Sets how often a bot will speak after it kills someone else. Should be between 0.1 and 10. 0.1 would be hardly ever, 10 would be every time. chatfile (cvar): Default is "botchat.cfg". This allows you to specify the name of the file that contains the comments the bot will use to chat. All bot chat files should be placed in the Jumbot directory under your Half-Life directory to be used. speedup (cvar): The default for this is 0 (disabled). When set to 1, it will disable some of the bot's advanced navigation routines and take a significant load off of the processor. The bots will still be able to navigate levels well, but will not do some of the more advanced things that they normally do in exchange for less processor usage. When set to 2, some things will be disabled while others that would be disabled with speedup 1 remain enabled. Using speedup 2 will still give you a good speed boost, though. bot_ai (cvar): The default for this is 1 (enabled). Setting to 0 completely disables the bot's AI. bot_thinkspeed (cvar): The default for this is 0.1. It can be a value anywhere between 0 and 1. This adjusts the speed at which the bot thinks, reacts, etc. This factors into reaction time as well as slightly into accuracy. bot_viewdelay (cvar): Sets whether or not the bot will delay after noticing things. Default is 1 (enabled). bot_angleupdate (cvar): Sets whether or not the bot will change angles each from or when it thinks. Default is 1 (enabled). nobotcfg (cvar): This is 0 (disabled) by default. Setting it to 1 will disable the use of the bots.cfg file, and you'll need to use the bot information cvars (below) to customize the bot. b_name (cvar): The bot being added uses this value as its name if nobotcfg is set to 1. This is also used after the bots.cfg file runs out of profiles. b_model (cvar): The bot being added uses this value as its model if nobotcfg is set to 1. This is also used after the bots.cfg file runs out of profiles. b_topcolor (cvar): The bot being added uses this value as its shirt color if nobotcfg is set to 1. This is also used after the bots.cfg file runs out of profiles. b_bottomcolor (cvar): The bot being added uses this value as its pants color if nobotcfg is set to 1. This is also used after the bots.cfg file runs out of profiles. coop_scikill (cvar): Can be a value from 0 to 2. 0 disables killing of scientists and barneys, 1 enables scientist and barney killing with scripted murdering, and 2 treats scientists and barneys as normal enemies. The default is 1. coop_killmeth (cvar): Can be a value between 0 and 5. Default is 0. If you have coop_scikill set to 1, this will allow you to change the bot's behaviour when killing scientists. The following values are usable: 0 - Random murder. 1 - Crouch down, shoot upwards in face with shotgun. 2 - Back away, shoot in neck or skull with crossbow. 3 - Run up to and shoot directly into stomach with magnum. 4 - Rapid fire directly into stomach with glock. 5 - Crouch down and shoot upwards in skull with magnum. *WAYPOINT MANAGEMENT COMMANDS AND CVARS* waypoints (cvar): Enables and disables waypoints. Default is 1 (enabled). wp_autoplace (cvar): Default is 1. Setting to 0 will disable attempts to automatically place waypoints behind you when you're constructing a waypoint table to be saved to a JRF file. makewp (command): This will add a waypoint at your current location, it is used while constructing a waypoint file for a level (see below). writewpfile (command): Use this after you've finished placing waypoints for a level to save the waypoint data to a file for later use. CONSTRUCTING WAYPOINT (JRF) FILES --------------------------------- When you load up a level that doesn't have a JRF file for it in your Jumbot\wpfiles directory, you will automatically begin placing waypoints (which will be visible to you in the form of crossbow bolts) whenever it is determined by the checks in the program that one should be placed. The program is often incorrect in its assumptions as to where they need to go and will sometimes neglect to place one in an area where it is needed. If you see this happening, use the makewp console command to place a waypoint manually. Here are some good tips for creating waypoint files: 1. Always make sure each waypoint is visible from the previous waypoint and the next waypoint. 2. Make sure you stay crouched while placing waypoints in areas that require the player to crouch to avoid certain obstacles. 3. Try not to go off any ledges that you can't climb back up. 4. Try to place a waypoint close to each side of a door. 5. Place waypoints close to buttons that need to be used, so the bots will know to use them. 6. Place waypoints close to health/HEV suit rechargers if you want the bots to use them. 7. When using ladders, place a waypoint at the head and foot of the ladder. 8. Be careful with jumping. When you jump a waypoint will be placed. When the bot gets to that waypoint, it will also jump. You can get the bot to do some nice stunts to get to certain items like this. 9. Don't get killed. After you've finished constructing your waypoint file, use the writewpfile command to save the waypoints to a JRF file and then restart the level. The JRF will be automatically loaded each time the level is loaded from now on. If you don't like the job you did on the JRF and want to redo it, simply delete it from your Jumbot\wpfiles directory and reload the level. Each JRF file will have the same name as the level it is for (boot_camp.bsp is boot_camp.jrf, etc). BUGS, ETC. ---------- There are currently no bugs that I know of that are very serious. Please don't send bug reports, since I have people to test the bot for me under pretty much all conditions and I'll eventually find a bug if it exists. If you're having odd obvious problems, make sure you have the latest version of Half-Life. There may be a couple problems around, but there's always some way around them. COPYRIGHT/PERMISSIONS --------------------- The bot may only be distributed if this file and all the other files that came with it are included in the redistribution, and no money is charged for the product being distributed. This excludes such things as video game magazines which include a CD and things such as that, which are permitted to include this bot (provided they meet the requirements above) as long as they notify me before doing so and get my permission through e-mail or some other form.