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

http://www.planetstarsiege.com/tribestat

Version:  1.1
Date   :  August 11, 1999
Author :  Ted Wehner

==[ FIXES / UPDATES ]======================================

v.1.1

* The server console resize-bug has been eliminated.  
  TribeStat was occasionally locking up when resized.

* The available missions are now pulled from the server
  telnet connection, so local/network drive access is no
  longer necessary.  Basically, TribeStat is now truly
  a remote beast.

* Added a mission ordering selector that allows the user
  to select from strict (which forces the enabled missions
  to run in order as they are listed), typed (default 
  tribes behaviour in which missions are cycled through
  same-type missions), and random (missions are selected
  at random from the available enabled missions).

* Added easy admin-to-player(s) chat functionality.  Admins
  may now chat with player(s) by preceding text in the 
  normal server console entry box with a ":".  If no 
  players in the player list are selected the message is
  broadcast to all players.  If a players are selected in
  the player list, the message will only go out to those
  players.

* Added a Lexicon Setup button on the events tab which
  allows the addition/moification of words to the speech
  dictionary.  Basically, this will allow you to teach
  the Speech engine new words and acronyms (lol = laugh
  out loud).

==[ 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.8

        NOTE: DO NOT INCLUDE THE .cs EXTENSION

    8.  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.

    9. Click on the Server tab.

    10. 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 ]======================================

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

Solution:
    Read the speech section above ;)

------

Symptom:
    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.

------

Symptom:
    I am the "Active Mode" admin among a number of admins
    , but my mission order doesn't seem to be working 
    correctly.  I can see what the next mission should be,
    but it always runs something else.

Solution:
    The most likely cause is that another admin is also
    running in Active Mode. In this case, after each 
    mission begins, both copies of TribeStat tell the
    server what the next mission will be.  Last one
    wins :)

==[ 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 a future version which will include a 
   statement parser/tokenizer.


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

On a personal note:  If you are running TribeStat and feel
so inclined, please fire off some mail to me and let me 
know.  I have spent a lot of time on this project and would
love to know if anyone is actually using it.  Thanks.

Please send any comments, suggestions, or questions to

twehner@planetstarsiege.com


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

