///BBQ Bot by Marko & Kennie///
///http://www.gamedesign-online.com///
///Version v1.0///

INSTALLATION:
-----------------------------

Go to your ET dir. example: 
cd /home/etserver/

Download the BBQ_v0.1.tar.gz
Extract the tarball by using the command:
tar -xzvf BBQ_v0.1.tar.gz

Set the permissions:
chmod +x BBQbot
chmod +x rcon

Edit the configs in the config dir.

Run the BBQbot by doing the command:
./BBQbot

The bot will now start on connect to IRC and read the LogFile.



WARNINGS:
-----------------------------
 - Not all server hosts will allow connections to irc servers, so ask your hosting company first.
 - You will need to have logs enabled in your ET server config AND the "log sync" will have to be 
set to 1 otherwise stats will only be printed at end of rounds
- In order to have the KICK / BAN functions working, you will need to have Punkbuster enabled on 
your server


NOTES:
-----------------------------
1. BBQ can be installed anywhere. If you put it in your ET folder, all you need is a relative 
path to your server logs (you just put something like "etpro/server.log" or "shrub/ouput.log"...). 
On the other hand, if BBQ is running from somewhere else, you'll need the full path to your log 
file (like "e:\games\Enemy Territory\etmain\server.log"

-2. If you toggle the IRC off, the bot will run "locally", meaning it will not require any
connection to an IRC network or server to run (ideal for people with locked ports)

-3. Set the UseLogFromStart field in the config file to OFF. Turning it to OFF means it will only 
analyse new events. Turning it to on will analyse the log from scratch, which is only for 
debugging pruposes...

TROUBLESHOOTING:
-----------------------------
-1. If you would like to check your bot is interacting correctly with the server you'll need to use 
the !stats function in game and see if the bot answers you

-2. If your bot is not working, make sure you have the following things set correctly:
* log path must be correct
* log_sync must be set to 1 in your server config file
* server logging must be enabled
* the server IP & rcon password must be filled in
If you miss one of those lines out, BBQ will not work correctly. For further questions, please post your questions directly on http://www.gamedesign-online.com/forums/

