Version: 1.3 Written by: GaB|Mindcrime (in real life Remy Wetzels ) Copyright: 2002-2005 by Remy Wetzels Mindcrime's IRC Live Reporter Bot. ================================== CONTENTS: --------- 1. Website 2. General Description 3. Features 3.1 What YOU must do! 3.2 What it can do! 3.3 What it can't do! 4. System Info 4.1 System requirements 4.2 System impact/Resource usage 5. Known Issues 6. Command line usage 1. WEBSITE: =========== For the latest version of the bot check my website at: http://www.gab-clan.com/downloads/rtcw/rtcwbot/ (Thanks to the Geh aB Clan) 2. GENERAL DESCRIPTION: ======================= IMPORTANT: You either HAVE to get this program RUNNING on the SERVER (that means that you have to have access (on Unix shell access) to the server or that your game provider installs it for you) OR you have to BE A PLAYER/SPECTATOR yourself to effectively use this program (the only other option only shows you almost same information that programs like ASE (All Seeing Eye) already does). The bot currently supports the following games: 1) Return to Castle Wolfenstein (RTCW) for client and server mode 2) Soldier of Fortune 2 (SOF2) for client and server mode 3) Star Trek: Voyager - Elite Forces (STEF) for client mode only 4) Medal of Honor: Allied Assault (MOHAA) for client mode and server mode 5) Return to Castle Wolfenstein: Enemy Territory (ET) for client and server mode 6) Call of Duty (COD) for server mode 7) Quake3 (Q3) for client/server mode 8) FarCry (FC) for client mode 9) HALO Custom Edition (HALO) for server mode The Bot has four modes of running: 1) You can run it on a (logfile of a) server and the bot shows (depending on the game, game type and mod) - real-time frags - objective status information - dynamite/bomb plants, defuses - side wins - time left/elapsed - player statistics (frags, deaths, ping, damage given/received, teamkills, killed by teammate, selfkills) - weapon accuracy statistics on an IRC channe.l (This is what I call SERVER mode) 2) You can run it locally (on a logfile) and when you start playing or spectating (possibly under wolftv) on a server the bot shows real-time frags and player stats on an IRC channel. (This is what I call REGULAR CLIENT mode) 3) You can run it locally and the bot shows real-time the current ping and score of players of a remote server on an IRC channel. (This is what I call REMOTE CLIENT mode) 4) You can run the bot locally on an old logfile and it will show the frags and player stats which occured in that logfile on an IRC channel. (This is what I call REPLAY CLIENT mode) Since 3 and 4 are in fact the same as 2, any text referring to client mode do refer to these modes too. 3. FEATURES =========== RTCW - RtCW 1.0-1.41 Client Logfile support. - RtCW 1.0-1.41 Server Logfile support. - OSP (Client/Server) mod 0.20-0.90 beta support. - BANI (Server) mod support. RTCW: ET - RtCW 2.55-2.56 Client Logfile support. - RtCW 2.55-2.56 Server Logfile support. - ETpro 2.X.X-3.X Client Logfile support. - ETpro 2.X.X-3.X Server Logfile support. SOF2 - SOF2 1.0-1.03 Client Logfile support. - SOF2 1.0-1.03 Server Logfile support. - OSP (Client) mod 0.2q-beta support. STEF - STEF Client Logfile support. HALO - HALO Custom Edition Server Logfile support. MOHAA - MOHAA 1.0-1.11 Client Logfile support. - MOHAA 1.0-1.11 Server Logfile support. Q3 - Basic Q3 Client Logfile support. - Basic Q3 Server Logfile support. - Basic OSP Client Logfile support. - Basic OSP Server Logfile support. COD - COD 1.0-1.5 Server Logfile support. - PAM mod 1.0x Server Logfile support. FarCry - FarCry beta support. - FarCry 1.0-1.2 support. For mIrc users I've include a livebot.mrc script for controlling the bot via irc. The Windows version saves certain settings in the registry via it's front-end WOLFBOT.EXE / SOF2BOT.EXE / STEFBOT.EXE / MOHABOT.EXE / CODBOT.EXE. The key under which it saves this is: \\HKEY_LOCAL_MACHINE\SOFTWARE\WH\WolfBot\ or \\HKEY_LOCAL_MACHINE\SOFTWARE\WH\SOF2Bot\ or \\HKEY_LOCAL_MACHINE\SOFTWARE\WH\STEFBot\ or \\HKEY_LOCAL_MACHINE\SOFTWARE\WH\MOHAABot\ or \\HKEY_LOCAL_MACHINE\SOFTWARE\WH\CoDBot\ So if you uninstall/remove the software, remove this key via regedit. 3.1 WHAT YOU MUST DO! --------------------- Please read the QUICK_EN.TXT (English) or QUICK_DE.TXT (German) for a step by step guide how to make the bot report a live match on IRC. If you have any trouble, first read the KNOWN ISSUES below, especially the one about Q3 Engine and game MODS like OSP. The program reads the rtcwconsole.log (RTCW) or qconsole.log (SOF2/STEF/Q3/MOHAA) or etconsole.log (ET) or games_mp.log (COD) or log.txt (FC) YOU generated and sents the available information to the IRC Channel. You can let your client/server generate a logfile by doing one of these things: CLIENT MODE (if you are connecting to a server): 1) start RTCW/ET/SOF2/STEF/MOHAA/COD/Q3/FarCry 2) type into the console: /logfile 2 (for MOHAA only 'logfile 2' without the slash '/') or put in your multiplayer wolf/sof2 configuration file: seta logfile "2" if you play FarCry type into the console: /log_verbosity 1 (or 8) SERVER MODE (if you are running a server): 1) start RTCW/ET/SOF2/MOHAA/COD/Q3 with these options: +set g_log rtcw.log (or "sof2.log"/"games_mp.log") +set g_logSync 1 +set logfile 2 or put in your server.cfg: seta g_log "rtcw.log" (or "sof2.log"/"games_mp.log") seta g_logsync "1" seta logfile "2" ATTENTION for MOHAA windows server, use the extra option: +set developer 2 ATTENTION for RTCW: Don't call the g_log file rtcwconsole.log!!! On servers the rtcwconsole.log is a file the server creates which is not quite the same format as the game logfile. if you play HALO set this server setting: sv_log_enabled 1 For Linux/FreeBSD servers this is a nice script to start the bot in server mode: -- begin -- #!/bin/sh # # Example of a SERVER MODE startup script for 1.3 # # Please set a password using "botpass" in irccolors_XXXX.cfg (as # specified by COLORFILE). # You can also specify a bouncer or Quakenet authentication there. # # Change these! # LOGFILE=/path/to/rtcw.log # XXXX = rtcw, cod, mohaa, q3, stef, q3 XMLMAPFILE=/path/to/mapinfo_XXXX.xml # XXXX = rtcw, cod, mohaa, q3, stef, q3 COLORFILE=/path/to/irccolors_XXXX.cfg # XXXX = wolf, cod, moha, sof2, stef, q3 BOTPROG=/path/to/binary/XXXXbot IRCSERVER=irc.quakenet.org IRCPORT=6667 IRCCHANNEL='#rtcwlivebot' IRCNICK='RTCWLiveBot' # # You might want to change this # # langout = 0 English/1 German/2 Dutch LANGOUT=0 # # # ATTENTION!!! # If you have an ET server you MUST SET THIS to '-E' # If you have a another server YOU MUST SET THIS to '' # # for RTCW Enemy territory #ET='-E' # for any other game ET='' # # OSP (0.8X)/ET/SOF2/Q3 server options: # # to turn OSP support on (preferred): OSP='-o' # to turn OSP support off: #OSP='' # #RTCW/ET: Objective Destroyed (default ON): add 1 to the sum to turn on #RTCW/ET: Dyna Planted/Defused (default ON): add 2 to the sum to turn on #RTCW/ET: Medic Revives (default OFF): add 4 to the sum to turn on #RTCW/ET: MG-42 Engineer Repairs (default OFF): add 8 to the sum to turn on #ET: Covert-Op Disguise (default ON): add 16 to the sum to turn on #ET/Q3: Server Votes (default OFF): add 32 to the sum to turn on OSPOPTIONS=19 # # ET server options: # # if you use the -c (show playerstats [kills/deaths] during each frag line) # option you can show extra information if you are running an ET server. # # If you want to show: # The player's class : add 1 to the sum of ETOPTIONS # The player's rank : add 2 to the sum of ETOPTIONS # The player's skills : add 4 to the sum of ETOPTIONS # The player's number of medals : add 8 to the sum of ETOPTIONS ETOPTIONS=3 # # # Leave this! # $BOTPROG -v $ET $OSP -g -Q \ -n $IRCNICK -k $LANGOUT -x $XMLMAPFILE -y $COLORFILE \ -O $OSPOPTIONS -T $ETOPTIONS -p $IRCPORT \ $IRCSERVER $IRCCHANNEL $LOGFILE > /dev/null & -- end -- For Windows servers: The wolfbot.exe (sof2bot.exe, stefbot.exe or mohabot.exe) is just a simple front-end made for easier configuration of the bot (and keeping the settings in the registry). The real bot is the windows 32 (DOS) application wolfcmd.exe (sof2cmd.exe, stefcmd.exe or mohacmd.exe) which runs is a DOS box. All options in the front-end (and probably more) can be set using command-line arguments. It might be easier - and more server console friendlier - to generate a batch file (just like the Unix shell script) which starts the bot. All the command-line options are described below in section 6. Here's an example of a batch file you could use for a Windows RTCW/ET server: REM REM REM Example of a SERVER MODE for startup script for 1.3 REM REM Please set a password using "botpass" in irccolors_rtcw.cfg (as REM specified by COLORFILE). REM You can also specify a bouncer or Quakenet authentication there. REM REM Change these! REM set LOGFILE="c:\rtcw.log" set XMLMAPFILE="mapinfo_rtcw.xml" set COLORFILE="irccolors_rtcw.cfg" set IRCBOT=wolfcmd.exe set SERVER=1.2.3.4 set PORT=27960 set IRCSERVER="irc.quakenet.org" set IRCPORT=6667 set IRCCHANNEL="#rtcwlivebot" set IRCNICK="RTCWLiveBot" REM REM You might want to change this REM REM langout = 0 English/1 German/2 Dutch set LANGOUT=0 REM REM REM ATTENTION!!! REM If you have an ET server you MUST SET THIS to '-E' REM If you have another server YOU MUST SET THIS to '' REM REM for RTCW Enemy territory REM REM set ET=-E REM REM for ANY OTHER GAME set ET= REM REM RTCW/SOF2 OSP (0.8X)/ET server options: REM REM to turn OSP support on (preferred, automattically on in ET): set OSP=-o REM to turn OSP support off: REM REM set OSP= REM REM Objective Destroyed (default ON): add 1 to the sum to turn on REM Dyna Planted/Defused (default ON): add 2 to the sum to turn on REM Medic Revives (default OFF): add 4 to the sum to turn on REM MG-42 Engineer Repairs (default OFF): add 8 to the sum to turn on REM ET: Covert-Op Disguise (default ON): add 16 to the sum to turn on REM ET: Server Votes (default OFF): add 32 to the sum to turn on set OSPOPTIONS=19 REM REM ET server options: REM REM if you use the -c (show playerstats [kills/deaths] during each frag line) REM option you can show extra information if you are running an ET server. REM REM If you want to show: REM The player's class : add 1 to the sum of ETOPTIONS REM The player's rank : add 2 to the sum of ETOPTIONS REM The player's skills : add 4 to the sum of ETOPTIONS REM The player's number of medals : add 8 to the sum of ETOPTIONS set ETOPTIONS=3 REM REM REM Leave this! REM ECHO starting %IRCBOT% %IRCBOT% -v %ET% %OSP% -g -Q -w %SERVER% -d %PORT% -n %IRCNICK% -k %LANGOUT% -x %XMLMAPFILE% -y %COLORFILE% -O %OSPOPTIONS% -T %ETOPTIONS% -p %IRCPORT% %IRCSERVER% %IRCCHANNEL% %LOGFILE% 3.2 WHAT IT CAN DO! ------------------- What can it show depends on the game, logfile, game type and mod: - global messages. - frags. - timelimit hit. - red/blue team eliminated. - objective info: documents taken/secured, dyna planted/defused, cannons blown up, etc. - objective reached. - time left on known maps. (server mode or (approximation by) client) - time passed on unknown maps. (server mode or (approximation by) client) - player statistics after each round: (server mode) kills, deaths, teamkills, selfkills, killed by teammates score, ping, the team the player resides on (Axis/Allies/Spectator). - player statistics: (client mode) kills, deaths, teamkills, selfkills, killed by teammates. (depends on info available) score, ping, the team the player resides on. - mapname. - gametype. - roundlength. - scorelimit. - server name. - player joins/disconnects. - when a game starts. - total team scores for blue (Allies) and red (Axis) team. - show team mates in the same color (Axis red, Allies blue). - language support for Dutch, German, English. (seperately for input and output) - some options can be changed via IRC on run-time. - some options can be changed via the game console. (client mode) - briefcase taken/dropped/returned/escaped (client mode) - bomb taken/dropped/planted/defused (client mode) - CTF flags taken/dropped/returned (client mode) - Axis/Allies win or draw. 3.3 WHAT IT CAN'T DO!!! ----------------------- This program reads a client or server RTCW/ET/SOF2/STEF/MOHAA/COD/Q3/FC console logfile and tries to interpret the data it finds and sends it to an IRC Channel. It therefore can only show on IRC what is logged in the logfile! Also, in client mode (and in MOHAA the server mode too) the time used is an APPROXIMATION of the real playing time. Keep this in mind when viewing a game. Hopefully this will change in the future. Also, you either HAVE to RUN/START this program on the server OR you have to be a player/spectator yourself to effectively use this program (the only other option only shows you the same information that programs like ASE already does). 4. SYSTEM INFO ============== 4.1 System Requirements: ------------------------ There are binary versions available for FreeBSD, Linux and Windows (NT/2000/XP). It might work under 95/98 too, but I have not tested that. I've got reports that it works ok under Windows 98SE and, but I also had some negative and positive reports on Windows ME. The sources will probably become available in due time. 4.2 System impact/Resource usage: --------------------------------- System impact in the client mode should be minimal. Using /logfile 2 will increase the general resource usage by RTCW/SOF2/STEF/MOHAA/COD somewhat, since it sets the game engine to unbuffered logging. However, I never experienced any system performance degradation while playing clanwars. System impact in the server mode is minimal while the bot is running. Since the bot has to parse/read the entire logfile on startup it might use a lot of cpu time during that time. Since client mode logfile tend to be small this is not an issue on client, but rather one in the server mode. There are three solutions to this issue: first you can use the -Q option switch to tell the bot to go directly to the end of the logfile without parsing the entire logfile. Secondly, on Linux/FreeBSD you can turn on the -i (nice mode) option on startup which makes the bot use less cpu time during recovery/parsing of the logfile, but it also make it take more time before it is at the end of the logfile. The other (obvious) solution is for you to prevent the bot having to parse large logfile by taking care that your logfiles don't grow to be that big. The bot reads a couple of thousand logfile lines a second (depending on the system performance naturally), so it normal should not take long for the bot to catch up. It will use about 95% cpu time during that period if you are not using the nice mode. Using the nice mode will make that cpu usage drop to less than 5% (if I remember correctly it was even less) but the bot will take relatively longer to catch up. I have to note here that during the tests I made it never actually interfered with the gameplay on the server even during recovery. So don't be alarmed about the figures above, it's not as bad as it might look to you. The bot has run on several server for weeks on end without having to be restarted. As long as the server game is up and running it does not need to be restarted. The network traffic the bot generates is minimal compared to the network traffic that players will generate. Since it connects to only 1 channel (unless you use the "unsupported" multichannel support) on an IRC server it will receive only network traffic generated by that IRC channel/server and it will send only packages if it has (or must) info to send to that channel. The bot can be controlled via the IRC channel but I've kept certain security aspects in mind. To my knowledge all possible buffer overflows are prevented, and any option which could be a potential security hazzard can not be set via IRC. 5. Known Issues: ================ - MOHAA console log: MOHAA only logs certain information in it's qconsole.log. Allthough it does log a lot of information and allthough it is a bit better organized than in the other games it does NOT however log what you type in the console. That unfortunately means you CAN NOT use the bot's console commands described here. So any '/lbot command arguments' do not work as normally intended. You can use CONSOLE commands to influence the bot (via iprint). It has certain security issues which you should consider (read it in CONSOLECOMMANDS.TXT under the section MOHAA specific). By default this is turned OFF. You can turn it on by setting useiprint=1 in the irccolors_mohaa.cfg. - MOHAA Localization file: The way frags are logged in the qconsole.log in MOHAA is different from the other games. The logging is dependant on the server where you connect to. The bot can understand only 3 language versions (EN/DE/NL) and ALSO requires the servers to have "pure" localization files. That means that any server running a changed (or superseded by other .pk3 files) version might automatically produce unknown kills for the bot. The general global/localization.txt file can be found in the main/Pak0.pk3 file. For example: The Dutch version of MOHAA is delivered with an extra main/Pak6NL.pk3 which has an localization.txt file which supersedes the original. WARNING: DO NOT EDIT THIS FILE UNLESS YOU KNOW WHAT YOU ARE DOING. IT WILL OR MIGHT GET YOU KICKED ON PURE SERVERS IF YOU CHANGE IT! - Q3 Engine and game MODs like OSP: The Q3 Engine has the (at least for me unwanted) "feature" that if you connect to a server running a MOD (like for example OSP) it will change it's current working directory from "main/" to that MOD's directory (so "osp/" for OSP). If you happen to type /logfile 2 AFTER you have connected to the server, it will then OPEN the logfile (rtcwconsole.log/qconsole.log/rtcw.log/sof2.log) in THAT SPECIFIC DIRECTORY. This happens for BOTH client and server mode. If you run a server it will start logging in the MOD directory and not in the "main" directory. For client mode, if you type /logfile 2 BEFORE connecting to the server it will open the logfile in the "main" directory. That's kind of awkward, but there is not really anything I can do about it. Since only the DIRECTORY changes where the logfile is opened I've made an irc command called "!logdir" which you can use to change the (the last!) directory of the path to the logfile. See IRCCOMMANDS.TXT for more information. This might prevent you from having to restart the bot completely. - SOF2 console log put Red/Blue team wins, suitcase escape and bomb exploded statements BEFORE the last kill: This leads to the problem that the last kill in a round is in fact shown AFTER the score and round win statement. Which leads to people believing that a player was killed 2 times in the same round. So, the first kill after the end of a round shown on the IRC channel MAY be the last kill of the previous round. Unfortunately I have not made a fix for this problem yet, since it is not really trivial to make a fix for it in the current design of the program. - Client mode existing rtcwconsole.log/qconsole.log: If you have started this program when there already was an old logfile present and then start RtCW and start logging, RTCW will remove the old logfile and start a new one. But since the bot is parsing the old file no data will be seen or send from the new logfile towards the IRC Channel. Since version 0.6 beta I included the -a option which let's the program wait for one minute to give you enough time to start up RTCW and open a new logfile. Another way to get the program to read the newly created logfile is to restart the bot using the IRC private message query '!restart' command. Since version 1.0 I included the option 'delete before opening' in the Windows version. This will delete the old logfile BEFORE the bot tries to open it. Since version 1.2 you can influence the logdirectory a bit without having to stop and restart the bot completely. Use the !logdir irc command to change the (last) directory path to the logfile. - Flood Excess Kick: On some rare occassions the bot is being kicked for flood excess after having run for several hours/days/weeks without any problems. I don't know the reason for this kick. It might have something to do with buffered (network) cache, which spits out the bot's output in a burst at certain moments, so that an IRC server thinks it's flooding the IRC channel. Since version 1.1 you can turn on floodprotect (it is automatically off by default) to prevent the bot from getting kicked. You might want to change the value of 'byterate' (or 'waitmillisecs') in the irccolors configuration file. If the bot start to lag behind because of this flood protection try setting flood protection to 'skip'. Read more about it in the command line options section. - Bot starting to lag behind the actual gameplay: Following a match with a lot of players (RTCW: 40 or so) might lead to a bot which lags more and more behind. This has to do with the fact that if my bot does not wait after writing each line on the IRC Channel it will get kicked for Excess Flooding. Turning of the "global/team messages" option prevents further lag. You might also want to increase the 'statsafter' value or turn it off completely by setting it to 0. - Difference in RTCW player stats: Since server console logfiles are completely different from client console logfile there is also a difference in the player stats which are shown on the IRC Channel. When using a server log the player stats are reset at the begin of each game. In CLIENT MODE bot will show the following stats: Kil/Dth KDR [TK/SK/KT] PlayerName Kil = The number of KILLS the player made Dth = The number of times the player was KILLED KDR = Kill-Death Ratio = Kil/Dth TK = The number of TEAMKILLS the player made SK = The number of times the player KILLED HIMSELF KT = The number of times the player was KILLED BY TEAMMATES In SERVER MODE the bot will show the following stats: T Sco Kil/Dth KDR [TK/SK/KT] Png PlayerName T = The TEAM the players is in at the end of the level (Red = Axis, Blue = Allies, Spectator) Sco = The SCORE of the player at the end of the level Kil = The number of KILLS the player made Dth = The number of times the player was KILLED KDR = Kill-Death Ratio = Kil/Dth TK = The number of TEAMKILLS the player made SK = The number of times the player KILLED HIMSELF KT = The number of times the player was KILLED BY TEAMMATES Png = The PING of the player at the end of the level 6. Command line usage: ====================== (the RTCW/ET version is shown here) GaB|Mindcrime's RTCW/ET LiveBot v1.3 www.gab-clan.org Usage: ,/wolfbot [-a] [-b pass] [-c] [-d port] [-e nick] [-f pass] [-g] [-h] [-i] [-j key] [-k language] [-l language] [-m] [-n nick] [-o] [-p port] [-q] [-r #lines] [-s #frags] [-t] [-u user] [-v] [-w host] [-x mapfile] [-y colorfile] [-z] [-A] [-B pass] [-C] [-E] [-F] [-G] [-I] [-O osp_options] [-P] [-Q] [-T et_options] [-V view] [-W] [-L leaguefile] [-Z] [host #channel logfile] host: irc host to connect to. #channel: irc channel to join to. logfile: the RTCW/ET logfile. -a wait 1 minute before starting. -b password: use this pass to authorize the owner on IRC. -c show playerstats [kills/deaths] during each frag line. -d port: RTCW/ET server UDP port. [default: 27960] -e qnick: nickname used for Quakenet Q auth. [default -n nick] -f qpass: password used for Quakenet Q auth. -g start sending info from the end of the logfile. -h this help. -i turn nice mode on. -j key: the key to join the IRC channel. -k output language. EN=0/DE=1/NL=2. [default: 0] -l logfile language. EN=0/DE=1/NL=2. [default: 0] -m turn on team/global messages. -n nick: nickname to use on irc channel. [default: RTCWLiveBot] -o turn OSP mode on. -p port: irc port to connect to. [default: 6667] -q quiet mode. -r #lines: start after processing #lines. -s #frags: show stats after processing #frags. Must be greater or equal than 20 or 0. [default: 80] -t turn TEAM mode on. -u user: username to use on irc host. [default: MindBot] -v turn server mode on. -w host: RTCW/ET server. -x mapfile: path to the map info file. [default: mapinfo_rtcw.xml] -y colorfile: path to the irc color file. [default: irccolors_rtcw.cfg] -z use time on client side -A turn bouncer mode on. -B password: use this password to authorize to your bouncer/irc server -C use clantags to team up the players -E turn RTCW: Enemy Territory support to ON -F set showfrags to OFF -G start in OSP as if entering during a match (ospfight on) -I set irc floodprotect to ON -L leaguefile: path to the league info file. [default: league_rtcw.cfg] -O osp_options: turn on some server side OSP options -P set showplay to OFF -Q go quickly to the end of the logfile -T et_options: turn on some server side ET options -U turn Call of Duty: United Offensive support to ON -V mode: set viewmode to simple|normal -W set showweaponstats to ON -Z get host, channel and logfile from irccolors_rtcw.cfg ATTENTION Linux/FreeBSD BASH USERS: When using the command line and not the script to start the bot, remember that the '#' sign is a special character within a bash shell, so escape it with an '\', so for example use \#rtcwlivebot Typical command line usage (server): ./wolfbot -o -v -g -Q -b ircpass -n LiveBot irc.quakenet.org \#rtcwlivebot rtcw.log Typical command line usage (client): ./wolfbot -o -z -g -b ircpass -n LiveBot irc.quakenet.org \#rtcwlivebot rtcwconsole.log host ---- (required. WINDOWS default: irc.quakenet.org) This is the name or ip number of the IRC server you wish to connect to. N00B TIP: Leave this on the default value. channel ------- (required. WINDOWS default: #rtcwlivebot) This is the IRC channel you wish to join with the bot. N00B TIP: For testing purposes use the above channel. logfile ------- (required. WINDOWS default: rtcwconsole.log or qconsole.log) This is the place where your logfile is (being created). N00B TIP: Select with 'Browse' the 'main' folder of your RTCW installation and append 'rtcwconsole.log' to it. wait one minute (-a) -------------------- (optional) This let's the program wait one minute before starting and reading the logfile. N00B TIP: Don't use this option. bot password (-b) ----------------- (optional) Set this to a password if you want to control the bot via the IRC channel. Check IRCCOMMANDS.TXT for more info. N00B TIP: Don't use this option. playerstats (-c) ---------------- Set this if you want the see (like most CS bots) the number of kills and deaths each player has on each frag line. N00B TIP: Turn this on. server port (-d) ---------------- (optional. default: 27960, for MOHAA: 12203) The UDP port the RTCW/SOF2 server you wish to connect to. N00B TIP: You can fill in the part after ':' of the server you want to play on. Quakenet Q nickname (-e) ------------------------ (optional. default -n nickname value) If you want the bot to authorize himself to Quakenet's Q service and you use another nickname to authorize it than you are using on the channel you have to use this option. Normally you only need to use the -n nick option and the -f password to authorize to Q successfully. N00B TIP: Leave this alone! Quakenet Q password (-f) ------------------------ (optional) If you want the bot to authorize himself to Quakenet's Q service you have to use this option. N00B TIP: Leave this alone! automatic start from the end of the logfile (-g) ------------------------------------------------ (optional) If you want the bot to continue from the end of the logfile use this. This will prevent the bot from start all over again. The -r option (recovery) will be ignored if you use this option. See also the -Q option to do it quickly . N00B TIP: Use this. help (-h) --------- (optional) Don't know this option. Check the help file for more info. N00B TIP: Your favourite option! nice recovery (-i) ------------------ (optional. UNIX ONLY) This prevents high CPU usage during recovery (see -r option). Drawback is the slower performance which prevents the bot from catching up to "real-time" earlier. Normal CPU usage of the bot during normal runtime is very low (0.00% tested on both FreeBSD and Linux) but during recovery it can go up to 99% unless you use this option. Once it has recovered CPU usage will drop back down to it's normal (0.00%) level. N00B TIP: Leave this alone! You're too dumb to run a decent OS like Unix! channel join key/password (-j) ------------------------------ (optional) If your IRC channel is protected by a password, use this option. N00B TIP: Leave this alone! output language (-k) -------------------- (optional) Turn on this language on the IRC channel. This sends the output in the selected language to the IRC channel. Choose the value of 1 for German and 2 for Dutch or don't use it for the English (0, default) language. N00B TIP: If you can't read this and you live in Germany. Try this option. logfile language (-l) --------------------- (optional) Turn on this language. This is for parsing the logfile correctly (in client mode). Choose the value of 1 for German and 2 for Dutch or don't use it for the English (0, default) language. N00B TIP: If you don't get any output allthough the bot connect to the IRC and you live in Germany. Try this option. global player messages (-m) --------------------------- (optional) This show ALL global (client & server) messages sent by people in the game. On server with a lot of people this can cause the bot to "lag" behind... N00B TIP: Leave this alone! nickname (-n) ------------- (optional. default: RTCWLiveBot or SOF2LiveBot) THIS SHOULD BE CHANGED!!! The nickname you wish the bot to use on the IRC channel. N00B TIP: Write you lastname there. OSP mode (-o) ------------- (optional. RTCW client/server, SOF2 client) FOR RTCW: Turn on OSP. This is incompatible with the normal game since it will shows no warmup kills and waits for the FIGHT! command to pass by... FOR SOF2/Q3: Turn on OSP. This is compatible with the normal game, but the bot will be able to recognize some extra information. Recommended if you are playing on an OSP server. FOR ET/STEF/MOHAA/COD/FARCRY: This option has no effect. For more info on OSP: http://www.orangesmoothie.com/ N00B TIP: Check this if you want to connect to an OSP server. port (-p) --------- (optional. default: 6667) This is the port of the IRC server your wish to connect to. N00B TIP: Leave this on the default value. quiet mode (-q) --------------- (optional.) Prevents the command-line interface from sending (allmost all) data to standard output. N00B TIP: Leave this alone! recovery (-r) ------------- (optional) This is for skipping a number of lines in the logfile that the bot will not send to the IRC Channel (but it WILL parse the data). N00B TIP: Leave this alone! show stats after #frags (-s) ---------------------------- (optional. default: 80. CLIENT MODE ONLY) Statistics will be shown at the end of each round (if the bot can figure out if this happened). This option will show statistics of the match played after every #frags. If you enter a value of 0 it will NOT show any statistics. The minimum #frags it accepts 20. Any value between 1 and 19 will be changed to 20. If you have turned on the -c option you should set this to 0. FOR RTCW/ET: If you have OSP turned on then it will show the player statistics at the end of a round if 'show stats after' is set to a value greater than 0. If it is set to 0 it will NOT show the player statistics. Also N00B TIP: If the player statistics are shown too often set this to a higher number, 120 for example. team mode (-t) ---------------- (optional) Turn on team mode. On a server this will show all Axis/Red in color red and all Allies/Blue in color blue. On a client it might be the other way around! However, if you use the -w and -d option on an OSP 0.3 or later server the client will be able to tell the correct team after a certain amount of time has passed... N00B TIP: Leave this alone! You're too dumb to run a server! user (-u) --------- (optional. default: MindBot) This is for IRC server authentication. It's different than an IRC nickname. You don't need to change it unless you are connecting to a bouncer or a protected IRC server. N00B TIP: Leave this alone! server mode (-v) ---------------- (optional. SERVER MODE ONLY) Turn on server mode. This is incompatible with the client mode since the logfile is TOTALLY different from the N00B TIP: Leave this alone! You're too dumb to run a server! server name/ip (-w) ------------------- (optional) The name or ip number of the RTCW/SOF2/STEF/MOHAA server you will connect to. FOR RTCW: In client mode it is often better NOT to fill in the server IP. Only if you are running OSP and teammode it might come in handy (since OSP server gives you team information). FOR SOF2: It is best to allways enter this. Since this will make sure the bot has the CORRECT SCORES all the time. N00B TIP: You can fill in the part before ':' of the server you want to play on. map information file (-x) ------------------------- (optional. default mapinfo_rtcw.xml or mapinfo_sof2.xml) The path to the map information file. It contains information about maps in the game. Read more about it in the MAPINFO.TXT. WINDOWS USERS: Be sure that you entered the FULL PATH (or selected the file by 'browse') N00B TIP: Leave this alone! color information file (-y) --------------------------- (optional. default irccolors_rtcw.cfg irccolors_sof2.cfg) The path to the color information file. It contains information about the colors the bot uses. Read more about it in the COLORINFO.TXT. WINDOWS USERS: Be sure that you entered the FULL PATH (or selected the file by 'browse') N00B TIP: Leave this alone! use time on client side (-z) ---------------------------- (optional. CLIENT MODE ONLY. MOHAA CLIENT/SERVER MODE) This turns on the a timer which tries to simulate the time when frags occurred during play. Test have shown that it can be pretty accurate if the gameplay sent to the channel is not interrupted too much by the sending of player statistics. N00B TIP: You might want to try this. turn bouncer on (-A) -------------------- (optional) If you would like to connect through a bouncer, turn this on. Set the bounceruser (or -u option) and bouncerpass (or -B option) in the irccolors_XXXX.cfg. (This has been tested with psybnc only) N00B TIP: Leave this alone! set bouncer password (-B) ------------------------- (optional) This sets the password for either your bouncer or - if you connect to a protected IRC server - your irc server. N00B TIP: Leave this alone! turn clantag team checking on (-C) ---------------------------------- (optional) This turns on clantag team checking. You must have defined a red clan tag and/or a blue clan tag in order to let this work successfully. The bot will check, whenever it finds a new player name, if it has one of these tags in it's name and it will then set the team of that player accordingly. turn RTCW: Enemy Territory support on (-E) ---------------------------------- (optional. RTCW/ET CLIENT/SERVER ONLY) This turns on support for Enemy Territory. This MUST be set ON when running an RTCW: ET server and MUST be set OFF when running an RTCW server. When running the bot in client mode you MAY turn it on in RTCW (and must) turn it on in RTCW: ET. N00B TIP: Turn this on when playing RTCW or RTCW: ET! set SHOWFRAGS OFF (-F) --------------------- (optional) This turns any game frags off. The bot will not show any frags/kills in the channel. If SHOWPLAY is set to OFF, this option is automatically set to OFF. N00B TIP: Leave this alone. set OSPFIGHT ON (-G) -------------------- (optional. RTCW/ET CLIENT ONLY) This lets the bot know that you are about to enter a game/match in progress. The bot will not wait for "FIGHT!" to start showing frags, but will show them immediately. set FLOODPROTECTION ON (-I) --------------------------- (optional) This turns off the bot's floodprotection. Flood protection will prevent the bot from being kicked by IRC for possible flood excesses. Flood protection works in combination with the settings "byterate" and "waitmillisecs". If you set the "byterate" (which you can define in irccolors_XXX.cfg) to YYY it will try to send a maximum rate of YYY bytes per minute. If the amount of information sent to IRC exceeds that rate, it will make the bot wait for an extra ZZZ millisecs where ZZZ is defined in "waitmillisec" (in irccolors_XXX.cfg) and thus lowering the current rate. If you set flood protection to skip it will also skip (a less) important line (like frags and stats) if the byterate has been higher three consecutive lines in a row. Use this only if the bot start to lag behind because it continuously waits due to exceeding byterate. You might better try to raise the byterate somewhat if that does not get the bot kicked. The default byterate is 3072 bytes/minute. N00B TIP: Leave this alone. league configuration file (-L) ------------------------------ (optional. default league_cod.cfg (COD/MOHAA ONLY)) The path to the league information file. It contains information about all the different league settings. See the !league, !loadleague and the league_cod.cfg file itself for more information. WINDOWS USERS: Be sure that you entered the FULL PATH (or selected the file by 'browse') N00B TIP: Leave this alone! set OSP options (-O) -------------------- (optional. RTCW SERVER MODE ONLY) This turns on some server side notices. The extra argument you give is the sum of the values of each option you would like to turn on. Default the sum is 19 (1+2+16), which turns on Objective Destroyed (1), Dyna Planted/Defused (2) and Show Covert-Ops Disguised (16) option. Possible options are: Show Objective Destroyed (default ON): add 1 to the sum to turn on Show Dyna Planted/Defused (default ON): add 2 to the sum to turn on Show Medic Revives (default OFF): add 4 to the sum to turn on Show MG-42 Engineer Repairs (default OFF): add 8 to the sum to turn on ET only: Covert-Op Disguise (default ON): add 16 to the sum to turn on ET/Q3 only: Server Votes (default OFF): add 32 to the sum to turn on N00B TIP: Leave this alone. set SHOWPLAY OFF (-P) --------------------- (optional) This turns any game play information off. The bot will only show statistics in the channel. N00B TIP: Leave this alone. quickly go to the end of the logfile on startup (-Q) ---------------------------------------------------- (optional) If you selected the -g option you can tell by this switch that the bot should go directly to the end of the logfile without parsing/reading the entire logfile first. This saves a lot of system resources and time during startup, especially on servers with large logfiles. N00B TIP: Leave this alone. set ET options (-T) -------------------- (optional. ET SERVER MODE ONLY) This turns on some server side options. The extra argument you give is the sum of the values of each option you would like to turn on. Default the sum is 3 (1+2), which turns on show classes (1) and show rank (2) option. Possible options are: 1. The player's class : add 1 to the sum 2. The player's rank : add 2 to the sum 3. The player's skills : add 4 to the sum 4. The player's number of medals : add 8 to the sum This ONLY works if PLAYERSTATS was set to ON (see -c option). PLAYERSTATS normally shows [XX/YY] behind each players names denoting the kills (XX) and deaths (YY) of the player at that time. If you enable any of the above it will also show an extra [ZZZZZ] with the following info: 1. - If you enable show classes, a letter denoting the player's class: M = medic, F = field ops, E = engineer, S = soldier, C = covert-ops, ? = currently-unknown. 2. - If you enable show rank, a number denoting the player's rank: rank# Axis Allies 0 Oberschutze Private 1st Class 1 Gefreiter Corporal 2 Feldwebel Sergeant 3 Leutnant Lieutenant 4 Hauptmann Captain 5 Major Major 6 Oberst Colonel 7 Generalmajor Brigadier General 8 Generalleutnant Lieutenant General 9 General General 3. - If you enable show skills, a letter denoting the skill and a number denoting the player's level for a certain skill: The levels ranks from 0-4. The skills are: B = battle sense, E = engineering, F = first aid, S = signals, L =light weapons, H = heavy weapons and I = intelligence So something like: S(E3H2) means: skills: engineering level 3, heavy weapons level 2. 4. - If you enable show medals, a letter denoting the skill and a number denoting the number of medals the player got for that skill: The skills are: B = battle sense, E = engineering, F = first aid, S = signals, L =light weapons, H = heavy weapons and I = intelligence So something like: M(E3H2) means: skills: engineering 3 medals, heavy weapons 2 medals. ATTENTION: Taking it al together would give you something like: N00B [C1S(I1)][ 0/15] was stabbed by Mindcrime [M9S(B4F4S4L4)M(B3F2S1L1)][15/ 0]'s knife. meaning: N00B is a Covert-Ops of Rank 1 (Gefreiter/Corporal) with Intelligence on skill level 1 and NO medals who killed 0 times and was killed 15 times and who just was stabbed by Mindcrime who is a Medic Rank 9 (General) with Battle-Sense level 4, First Aid level 4, Signals level 4 and Light Weapons level 4 (rest 0) who earned 3 Battle Sense medals, 2 First Aid medals, 1 Signals medal and 1 Light Weapons medal who killed 15 times and never (0) died... Notice that the information part is very long!!!! So default it will show something like: N00B [C1][ 0/15] was stabbed by Mindcrime [M9][15/ 0]' knife. N00B TIP: Leave this alone. turn Call of Duty: United offensive support on (-U) --------------------------------------------------- (optional. COD SERVER ONLY) This turns on support for United Offensive. This MUST be set ON when running an COD:UO server and MAY be set OFF when running an COD server . N00B TIP: Turn this on when playing COD or COD:UO! set view mode (-V) -------------------------- (optional) This determines the way how the frags are shown, currently there are two types of view mode: fixed = XXXX killed YYYYYY - mp40 fixed = ZZZZZZ killed AA - mp40 simple = XXXX killed YYYY - mp40 normal = YYYY was killed by XXXX's mp40 in the head note the difference that the player's names have fixed lengths in fixed mode and are displayed as being in team mode (Axis red/Allies blue). note the difference that the players have switched positions between fixed/simple and normal mode. N00B TIP: Leave this alone. set SHOWWEAPONSTAT ON (-W) -------------------------- (optional. RTCW/ET server) At the end of the round on the server it will show (EXTENSIVE!) weapon accuracy information for all players. Do not use it unless you do not care that the gameplay will lag seriously! N00B TIP: Leave this alone. get host, channel and logfile from the irccolors_XXX.cfg config file (-Z) ------------------------------------------------------------------------- (optional) You can configure the default irc server (host), irc channel (channel) and logfile via the irccolors_XXX.cfg. If you want to use these set this option N00B TIP: Leave this alone.