
Version: 1.3
Written by: ]GaB-Mindcrime[ (in real life Remy Wetzels <mindcrime@chello.nl>)
Copyright: 2002-2004 by Remy Wetzels

Mindcrime's IRC Live Reporter Bot.
==================================

The main focus of this document will be on the RTCW version, but since the SOF2 version is
not that different from the RTCW version you can use this document too...

Since the first beta versions of this reporter bot a lot of (bug)fixes and features have
been added. The problem with adding features is that for first-time users or for users with
little knowledge of the working of RTCW/SOF2 game engine and it's available modifications
(in short mods, like OSP, BANImod, SHRUB (all available for RTCW)) a programs tends to
become to difficult to use. This document is my effort to try and help you getting the bot
to work in a step by step guide without (hopefully) paying too much attention to all the
features this program has which only distracts you from the ultimate goal:

- Showing a game LIVE on an IRC channel for all your (clan)mates and (hopefully) showing
  to these (clan)mates what a great player you are!

From this point on I will try to explain to you how to use the bot as if you were a person
who - is using some version of the Windows Operation System (XP, 2000, ME, NT, W98) and
wants to run the bot in client mode (don't ask! this is a dummy guide on how to use this
bot and running the bot in server mode is beyond the scope of this document) - has just
downloaded the bot and never has tried it before and you never have done anything with
RTCW/SOF2 console commands.
What I do ask from you is that you have a general knowledge of how to use IRC. (how to get
on an IRC server/channel, how to send private messages to a person on IRC) Knowing how to
work with a program like mIRC should be enough...
I also expect that you already downloaded the bot, you unzipped it and - if you have
downloaded the setup version you have - run the setup.exe program.


FIRST TIME SETUP
----------------

The bot in itself is a simple program. It just reads a logfile generated by RTCW and send
information it finds in there to an IRC channel...
For the bot to be capable to do that it needs to able to do two things:

1. The bot must be able to read the logfile generated by RTCW.
2. The bot must be able to connect to the IRC channel.

Let us first tackle the problem of generating a logfile. To do this you have to take the
following steps:

1. Start RTCW
2. Connect to a server
3. Wait untill you have connected to a server and you get into the limbo mode (the mode
   where you can choose sides, choose you function and weapons.
4. Open the console window of RTCW, the default key to get the console window is the
   backtick "`" (left of the 1 on the keyboard, just below the escape key). The console
   window should come scrolling down on the screen. At the prompt type the following
   command and then press the enter key:
   /logfile 2
5. Wait a second, if all goes well a statement should follow saying something like:
   Logfile opened on April 01 2002 12:12:12
6. Go play on the server for a couple of minutes or just be a spectator.
7. Quit RTCW

If all went well RTCW (SOF2) will have generated a file called rtcwconsole.log
(and in SOF2 a file called qconsole.log).

Now we tackle the problem of getting onto the IRC channel...

Go to the folder where you installed the bot. When you installed the bot it should
have two executables:

1. WolfBot.exe
2. WolfCMD.exe

WolfCMD.exe is beyond the scope of this document. Let me just say that WolfBot.exe
is just a simple front-end - for running the bot, setting up the bot correctly and
being able to save these settings - for WolfCMD.exe, which has really all the
bot's intelligence.

1. Start WolfBot.exe

When you start WolfBot.exe for the first time you will see something like the picture
images/wolfbot01.jpg. What you see is the front-end of the bot which enables you to
configure some settings of the bot.
In the top left part of the window you see the IRC OPTIONS. These options are all
about getting onto an IRC channel. And that is the part which we need here.

- As you (should) know IRC really consists of several independant IRC networks, each of
them having a list of servers connected to each other to which you (with your mIRC
IRC client) can connect to. Unfortunately there is not one worldwide IRC network
dedicated to game players all over the world, but several. Most notably are (as far
as I know it) the Quakenet IRC and the EnterTheGame IRC network.
So first you should know on which network you usually connect to, to chat with fellow
gamers. In Europe this probably will be Quakenet, in the US it might be EnterTheGame.
If you are using mIRC you can check it by looking at File -> Options -> Connect and
then click on Edit. You will see a box with (for the bot) two important fields:
IRC Server and Port(s). Write down these two values. For the purpose of this guide I
will use Irc.Quakenet.Org and 6667 for IRC server and port.
Fill in these two values in the WolfBot where it says IRC Server and IRC Port.

- As you (also should) know you chat on IRC in so called channels which start with
the number sign "#" and then a sequence of characters. For the purpose of this guide
suppose you want to connect to #rtcwlivebot. Please be carefull when selecting a
channel for test, since a lot of people tend to start using strange/special
characters which are not accepted as a character for a channel. Use a simple
channelname for these tests. If you connect to the Quakenet IRC use #rtcwlivebot,
since I keep this channel open 24hrs/day for you to test it. Fill in the channel
(including the #) in the field IRC Channel.

- The IRC Chankey field is beyond the scope of this document and should be left empty!
(It is used for channels who are protected by a password/key. You can fill in the
password/key in this field).

- As you (also should) know you chat on IRC using a fake name or so-called nick name.
Like a channel this nick name also has some limitation in the characters which may
be used. For this purpose please use a simple name, but be sure it is unique. Since
nick names must be unique on an IRC network try, for this testing purpose, to have
a nick starting with a letter and then a random sequence of 10 digits, for example
c1274939020 or g4763782211. Please do this, I've had to answer too many question
of people stating they could not connect, while all the time they were using an
incorrect IRC server, IRC port, IRC channel, IRC nickname, IRC username. Fill this
nick name in the field IRC Nickname.





