----------------------------------------------------------------
            DFF TRIBES 2 Admin + IRC Announcer Build 0524
                  (c) 2001 by BiTBUSTER bit@dff.de 
              http://www.dff.de http://www.veterans.de )
----------------------------------------------------------------

======
About:
======

The DFF TRIBES 2 Admin allows you to administer your T2 Server and
report T2 Matches to the IRC Network (http://www.irc.net/).

It reports Captures, Kills, Team Kills, Suicides, Team Changes,
Environmental Kills, Chat and many other things.

=============
REQUIREMENTS:
=============
o Tribes 2 Server with Telnet Access
o Win32 Operating System
o Internet connection

============
INSTALLATION
============
---------
1st Step:
---------

First you have to make a file called 'telnet.cs' in the following
dir:

\Tribes2\GameData\base\scripts\autoexec\

By default you don't have an autoexec dir so you have to create it first.
This should be the content of the 'telnet.cs' file:

telnetsetparameters(28000,"mypassword","mylistenpassword"); 
setlogmode(1);
$logechoenabled=1;

Change the admin password and the listenpassword. The first password is for
sending commands & listening. The second password is for listeners only.

---------
2nd Step:
---------

Copy the dff.vl2 file to your \Tribes2\GameData\base\ directory or to your
mod directory (for example \Tribes2\GameData\bwadmin\ )

---------
3rd Step:
---------
Start your Tribes 2 Server.

-----------------------
4th Step (Client Setup)
-----------------------

Start the DFFT2Admin.exe and click the favorites button on the toolbar 
to add your Tribes 2 Servers. Enter your telnet port as the port number and 
the admin password (not the listenpassword) and click on the connect button.

Click on the Setup icon on the toolbar.

There are several Checkboxes in the 'Report'-Section. The bot will only report
stuff to IRC that is enabled here.

Activate the IRC tabsheet and enter the IRC-Server you want to use for reporting. 
You can choose from a complete IRC-Network listing here: 
http://www.irc.net/servers/index.html

Port should stay at 6667 (default). 

Choose a Nickname for your bot. Also give an alternative Nick so the bot can 
logon to the IRC-Network even if the Primary Nick is taken.

Reconnect means that your bot automatically reconnected after xx seconds
(Delay) when it got a disconnect.

Min chars / line: Your bot will gather informations and broadcast them 
to IRC after the given number of characters. You should use 150-200 chars to prevent
the bot from excess flooding or uncheck some boxes in the report section.

Channel: The channel where the bot will announce.

----

Three Windows are visible:

- IRC-Chat-Window

- Tribes 2 Server Connection Window. All messages received from the Tribes 2 Server will 
  be shown there. You can enter commands in the edit field and press return to 
  send them to the server. For example 'listenplayers();'.
  
- Player Grids
  You can see the actual stats here. Use the right mouse button to choose from options like
  - kicking / banning players
  - change their teams
  - send messages to a player
  - send messages to the server

Connect to your T2 Server. Use the Bulb Icon. 

Press the Map Icon if you want to list all available Maps. Change maps with a doubleclick.

You can click the Symbol 'Connect to IRC' now which is located to the left on the Toolbar. 
The bot will connect to your IRC Server. Try an alternative IRC-Server if the bot is not 
able to connect.

Infos can be retrieved by sending private IRC Messages to the bot:

/msg Botname !stats playername
/msg Botname !time
/msg Botname !players


------------
Future Watch
------------

- Linux version



Have fun!

BiTBUSTER (bit@dff.de)
