===========================================================
||[ TribeStat ]||||||||||||||||||||||||||||||||||||||||||||
===========================================================

http://www.planetstarsiege.com/tribestat

Version:  1.0
Date   :  August 6, 1999
Author :  Ted Wehner


==[ Introduction ]=========================================

    TribeStat is a server administrator front-end for the
kick ass Dynamix Game, Starsiege: Tribes.  After running
my own server for a while I found that administration was
somewhat cumbersome.  I had my server sitting next to my
desk at work, and wanted to be able to keep an eye on the
general status of the game without having launch a Tribes
client and join the game.  Although a handful of server
console commands were available, they, of course, would
only give me information if I actively went to the server
and typed them (assuming I could even remember them).
Despite the lack of an extensive set of server commands,
Dynamix did include one brilliantly accomodating feature -
"telnet access".  This telnet access gave me the necessary
hook into the server to write a front-end that keeps track
of just about everything in the game - not to mention the
ability to begin tracking stats as so many players had
requested on other server I had run.  So here it is, after
months of development (ok, so I had other things to do),
TribeStat 1.0.

==[ Compatibility ]========================================

    So far, I have only had support for the "base" Tribes
server in mind for TribeStat.  Of course I think it would
be great if mod developers would begin dialogs with me to
include future support for their mods. We'll just have to
wait and see.

==[ Features ]=============================================

    * Active color-coded player and team lists
    * Drag and drop team management
    * Easy view of who is carrying flags
    * One button access to server commands / messaging
    * Color-coded server console view
    * Complete mission list control...ordering, enabling,
      disabling
    * Live player statistics tracking via DBase database
    * Cumulative server-activity statistics and graph
      (players per hour)
    * TribeStat-to-TribeStat chatting for multiple
      administrators
    * Extensive game preference control
    * Microsoft Speech enhanced event logging
    * Multiple server support for the super administrator
      running a sh!!load of servers
    * Automatic reconnection to dropped servers
    * Administrative Blocks...
      (block admin voting, block team damage voting, etc..)
    * Customizable color schemes

==[ Installation ]=========================================

    1.  Extract the TribeStat.exe file into its own
        directory.

        The databases will reside under this directory as
        well, so you'll need to find a location with some
        space to spare if you plan on using the stats
        feature.

    2.  Copy the TribeStat_Base_X.Y.cs file to your Tribes
        server config directory (i.e. C:\Tribes\config).

    3.  Make sure your serverPrefs.cs or serverConfig.cs
        file in the config directory has telnet access
        turned on with a password.

        $TelnetPort = XXXX;  // pick a port number
        $TelnetPassword = "password";  // pick a password

        It might also be a good idea to turn of console
        logging as this functionality is basically included
        in TribeStat.

        $Console::LogMode = 0;

    4.  Start up your Tribes server and TribeStat.exe.

    5.  Add your server to TribeStat by clicking on the
        "Add Server" button near the top right.

        Type in your server IP address, Port (as setup
        above), and the telnet password (as setup above).

        Click OK.

    6.  Click on the Preferences Tab.

    7.  In the TribeStat Script File box type the name of
        the TribeStat_Base_X.X script you are using.

        i.e. TribeStat_Base_1.7

        NOTE: DO NOT INCLUDE THE .cs EXTENSION

    8.  If you want to have mission list control in
        TribeStat, it must have drive access to your
        missions directory.

        Click on the folder icon next to the "Missions
        Path" box.  Navigate your way to your missions
        directory (i.e. C:\Tribes\Missions).

        Click OK

        If you are running TribeStat on a different network
        machine than your Tribes Server (recommended), you
        will need to map a drive letter to your server.

        For example, if you were running your Tribes server
        on machine "MyServers" under the "C:\Tribes"
        directory, and TribeStat on machine "Stats",
        then you would map a drive letter as follows:

         - open your C:\ folder in "My Computer" on machine
           "MyServers"
         - right-click on the Tribes folder
         - select "Sharing..."
         - select the "Shared As" radio button
         - provide a share name of "Tribes$"
           (the dollar sign hides it from network browsers)
         - select any access type and provide the necessary
           passwords
         - click OK

         - right-click on "My Computer" on machine "Stats"
         - select "Map Network Drive..."
         - pick an unused drive letter from the list
           (i.e. "T:" )
         - type "\\MyServers\Tribes$" into the Path box
         - select "Reconnect at logon"
         - Click OK
         - When prompted, type in the password you setup
           for the Tribes$ share.

        After following the above procedure you would set
        your "Missions Path" in TribeStat to "T:\Missions"

    9.  If you are the primary server administrator, and
        more specifically, if you want control over the
        mission list, then set the passive/active mode
        toggle near the bottom center to "Active".

        NOTE: NO MORE THAN ONE COPY OF TRIBESTAT SHOULD
              BE SET TO ACTIVE MODE FOR A GIVEN SERVER!
              IN OTHER WORDS, REMOTE/SUB ADMINS SHOULD
              BE SET TO PASSIVE.

    10. Click on the Server tab.

    11. Click on the green led "connect/disconnect" button
        to connect to your server.

==[ Speech Setup ]=========================================

    TribeStat makes use of the Microsoft Speech API (SAPI)
to provide speech.  The SAPI binaries and a suitable
speech engine (provided by Microsoft) must be installed
before TribeStat will utter a word.  The SAPI installer
is available from the TribeStat distribution site.
You will need to download the actual voice engine files
from Microsoft at "http://www.microsoft.com/IIT/" (click
on the download button and select Speech Engines).  You
may alternatively find links to the available speech
engines on the TribeStat web site.

==[ Troubleshooting ]======================================

Sympton:
    I dont hear any speech! What the hell are you talking
    about?

Solution:
    Read the speech section above ;)

------

Sympton:
    TribeStat seems to be hosed, and everytime it connects
    or a mission begins, the server console says "Invalid
    script file" or something along those lines.

Solution:
    Try adding the following line to the end of your
    serverPrefs.cs or serverConfig.cs file in your config
    directory.

    exec("TribeStat_Base_X.Y");

    where X.Y is the current version of the TribeStat_Base
    file you are using.

    It seems that older versions of Tribes will only run
    user scripts that are first called during the initial
    startup of the server.

==[ Disclaimer / Licensing Agreement ]=====================

 Yeah yeah, blah blah , the usual....

 Freeware...use at your own risk.
 I'm not responsible for any damage(s) incurred through
 the use of this software.

 It's free...dont sell it.
 If you ever make any money either directly or indirectly
 off this software I'm guessing you're gonna burn in hell.
 SO DONT DO IT!

 I wrote it...gimme credit.
 I've spent months working on this software (like I said
 before, I've had other things to do), so please give me
 credit whenever appropriate.  I'm also pretty sure YOU
 didn't write it.  Don't take credit for it or any part
 of it.  If you ever take any credit either directly or
 indirectly for this software, you're still probably
 gonna burn in hell.
 SO DONT DO IT!

==[ Known Issues ]=========================================

*  The AdjScore field in the Players database is not yet 
   used, pending user feedback on an appropriate formula

*  The LagWhines field in the Players database is not yet
   used, pending the next version which will include a 
   statement parser/tokenizer.  The tokenizer will not
   only catch players that whine about lag, but will
   also convert some tokens such as "lol" into meaningful
   text - "laugh out loud" for the speech api.


==[ Feedback ]=============================================

Please send any comments, suggestions, or questions to

twehner@planetstarsiege.com


===========================================================

