###############################################################################
## ------------------------------------------------------------------------- ##
## ProgramName......... TripleX RankingS                                     ##
## ------------------------------------------------------------------------- ##
## Programmer.......... TripleX                                              ##
## eMail............... mrbrain@cs.tu-berlin.de                              ##
## Homepage............ http://user.cs.tu-berlin.de/~mrbrain/                ##
## ------------------------------------------------------------------------- ##
## current Version..... 2.02                                                 ##
## ReleaseDate......... 25th Febrary 1998                                    ##
## SoftwareStatus...... Freeware                                             ##
## ------------------------------------------------------------------------- ##
## Requirements........ - Perl as Version 5 or above                         ##
## ------------------------------------------------------------------------- ##
## History..... v2.02 : - first public Release                               ##
## ------------------------------------------------------------------------- ##
## Purpose............. This Package of Scripts can be used to provide       ##
##                      some nice Rankings for a Quake II Server. It         ##
##                      splits in an CommandLine-Util to build up some       ##
##                      DataBase and a CGI-Script that uses this DataBase    ##
##                      to show the Rankings on a WebPage.                   ##
##                                                                           ##
##                      It's is NOT mentioned for local Usage without        ##
##                      InternetAccess.                                      ##
## ------------------------------------------------------------------------- ##
## Features............ - reads the ConsoleLogFile of Quake II v3.12+        ##
##                      - no special Mods supported yet                      ##
##                      - only useful with DeathMatchServers                 ##
##                      - provides excelent Designed WebPages through some   ##
##                        CGI                                                ##
##                      - allows Overview on all Players                     ##
##                      - Table sortable by Name, Kills, Deaths, Frags and   ##
##                        Skill                                              ##
##                      - shows Top10, 25, 50, 100 or complete List          ##
##                      - counts WeaponUsage and SuicidReasons               ##
##                      - gives all this Data even for every single Player   ##
##                      - two ColorScemes for printable Output               ##
## ------------------------------------------------------------------------- ##
## known Bugs.......... none                                                 ##
## ------------------------------------------------------------------------- ##
## Usage............... You'll first need some Quake II Server running       ##
##                      DeathMatch with the PointRelease v3.12 or above!     ##
##                      Former Servers are not supported.                    ##
##                                                                           ##
##                      This Server has to write a ConsoleLogFile which can  ##
##                      be achieved with SET LOGFILE 1 or OutputRedirection. ##
##                      To use OutputRedirection start the Server this Way:  ##
##                                                                           ##
##                      quake2.exe OPTIONS > console.log                     ##
##                                                                           ##
##                      You'll need this LogFile to build up the Ranking-    ##
##                      Database for the CGI.                                ##
##                                                                           ##
##                      RANK.PL will read this LogFile and create the        ##
##                      DataBase for you. The Input will allways be added    ##
##                      to the existing DataBase - so keep in Mind that      ##
##                      no LogFile should be added twice! Allways MOVE the   ##
##                      LogFile out of the ServerDirectory. So a new LogFile ##
##                      of the same Name will be startet and can be sure to  ##
##                      rank everything just ones!                           ##
##                      If you're able to build some Script that does this   ##
##                      Job for you - do it! Otherwise you'll have to do     ##
##                      this by Hand - let's say ones a Day.                 ##
##                                                                           ##
##                      To add the LogFile to the Database just type:        ##
##                                                                           ##
##                      perl rank.pl console.log                             ##
##                                                                           ##
##                      On many Systems you can let the starting Perl off.   ##
##                      I sugguest to keep all Files in one Directory so     ##
##                      no Changes need to be done to the Scripts. If you    ##
##                      plan to put the Database in another Directory        ##
##                      you'll have to change the Variables in this Script.  ##
##                                                                           ##
##                      Now you should setup the RANK.CGI with a Link        ##
##                      on your WebSite. To get some first Look at the       ##
##                      Output use the following URL:                        ##
##                                                                           ##
##                      http://.../rank.cgi                                  ##
##                                                                           ##
##                      without any Arguments. I don't need to say that the  ##
##                      CGI needs to be executable to work. Some WebServers  ##
##                      even rely on fixed Directories - but i'm sure you    ##
##                      know about that. Ask your SystemAdministrator for    ##
##                      Help if you need some!                               ##
##                                                                           ##
##                      This URL gives you the complete Overview. Play a     ##
##                      bit with the Links in teh ControlWindow and choose   ##
##                      the one you like the most for your WebPage. Then     ##
##                      copy the URL of this Page to your WebSite for        ##
##                      Access. Keep in Mind that the complete Overview      ##
##                      takes some Time to display the Table to the User -   ##
##                      so use the Top10 or Top50... not the complete one.   ##
##                      The User will have the Possibilty to use the Link    ##
##                      for that!                                            ##
##                                                                           ##
##                      That's all for you to do!                            ##
##                                                                           ##
##                      Remember to maintain the DataBase and never rank     ##
##                      the same LogFile twice... HAVE FUN!                  ##
## ------------------------------------------------------------------------- ##
##         (C) Copyright 1998 by TripleX - All Rights reserved!              ##
## ------------------------------------------------------------------------- ##
###############################################################################