VoodooStats-ReadME.txt

(27 KB) Pobierz
================================================================================
Voodoo Stats by myrddin & react
================================================================================

Voodoo Stats is a log analyzer for quake III arena. It can analyze both 
client side (qconsole.log) logs as well as server side (games.log) logs.
It reads the log files generated by quake III and displays various game stats 
in html format. 

Credits:
---------

             Lead Programming/Design : myrddin (myrdd1n@hotmail.com)
                         Programming : react   (r3act@hotmail.com)
Additional coding/suggestions/advise : phred   (greg@price.org)
 Additional testing/suggestions/p.r. : gouki   (gouki9@yahoo.com)

                             Website : http://www.clanavl.com/voodoo/
                                       http://www.clanavl.com
                                 Irc : #avalanche, #voodoopeople, #^oo^
                                       on irc.enterthegame.com

Thanks to:
----------
rhea and the osp team : For creating the best competition mod for quake3.
n8dawg                : For helping us out with ummm... stuff/code ;)
grunge                : For setting us up with a test server in linux.
lunk                  : For providing a linux shell account with mysql/php/www.
fia & hifi            : For helping me sort out browser compatiblities on macs.
all the peeps in avl  : Default Pimpage.

and anyone else i forgot to mention...

________________________________________________________________________________



================================================================================
Pimpage:
================================================================================

Clan Avalanche                    : http://www.clanavl.com
                                    #avalanche on irc.enterthegame.com
Orange Smoothie Productions (OSP) : http://www.orangesmoothie.com
                                    #osp on irc.enterthegame.com
Server Config Generator for OSP   : http://www.clanavl.com/OSPConfig
                                    Brought to you by phred ( greg@price.org )
Coderz                            : #coderz on irc.enterthegame.com

________________________________________________________________________________



================================================================================
About this document:
================================================================================

This ReadME is a generic document and contains information on all the different
releases of voodoostats (linux and windows), so ignore the information that does 
not refer to the release that you have downloaded.

This document is written from a windows/dos perspective, so linux users should 
use the equivalent commands/methods if its not the same.
ex: In windows directories are delimited by \
    In   linux directories are delimited by /

voodoostats(xx)-c and voodoostats(xx)-s
---------------------------------------
The (xx) here refers to the current version of voodoostats.
Ex: If you have downloaded voodoostats version 4.0, then
    voodoostats(xx)-c means voodoostats40-c and
    voodoostats(xx)-s means voodoostats40-s

voodoostats(xx)-c = analyzes log files and generates html stats.
voodoostats(xx)-s = analyzes log files and updates mysql database with stats.

________________________________________________________________________________



================================================================================
Installation and Usage Instructions:
================================================================================

   
   Client Side version
   -------------------
   This version is mainly for players who just want to see stats of the games 
   they play online. The stats are generated from qconsole.log
   
   1. Extract the downloaded .zip file into a directory of your choice.
      Linux specific: You may have to do a "chmod u+x" on the following files:
   
        voodoostats(xx)-c
        vs-preparse
   
   2. To analyze a log file and generate html stats:
      Lets say your qconsole.log file is in c:\games\quake iii arena\baseq3\
      To analyze this file, go to the dir where you unzipped voodoostats and 
      type:
      
        voodoostats(xx)-c "c:\games\quake iii arena\baseq3\qconsole.log" <mycfg.cfg>

      NOTE: mycfg.cfg is optional. If you do not specify a cfg file then
            voodoostats will read all the info from c-default.cfg. You can make
            several different cfg files with different settings etc, and 
            tell voodoostats to read your preference from that cfg file.
            A description of what each setting mean in the cfg can be found
            in c-default.cfg
            Also, the config file must have .cfg as its extension.
            You need the double quotes if the directory path has spaces in it.

  
   Server Side version (includes client side as well)
   -------------------
   This version is mainly for q3 server admins who wants to generate stats
   for all the players that join their server and keep a cumulative record
   of the stats stored in a database. The stats are generated from games.log
   
   The server side version uses mysql and php to store and retrieve the stats, 
   so you need to install both mysql and php on your server/system.
   You may also need a webserver that is compatible with php if you dont 
   already have one.
   Both mysql and php can be downloaded and used for free.
   Download the latest version of the webserver, mysql and php.
   You can get a free webserver from http://www.xitami.com
   mysql can be downloaded from http://www.mysql.com
   php can be downloaded from http://www.php.net
   Install the webserver first. In windows, PHP can automatically detect the 
   webserver and configure it accordingly.
   Install mysql and php on your system.
   Check the installation instructions that comes with mysql and php.
   
   
   1. mysql setup
      -----------
   
   a. Add the mysql command path (c:\mysql\bin\ is the default) to your 
      evironment variable PATH.
      In windows 2000 you can specify the PATH in
      start->
        settings->
          control panel->
            system->
              advanced->
                environment variables->
                  user variables->
                    PATH
      In win9x versions, you can specify the PATH in autoexec.bat:
        Path=C:\Windows;C:\Windows\Command;c:\mysql\bin
      
      i.e, when you type mysql from the command prompt (from any directory), it
           should go to the mysql> prompt.
      Test it! Open up a dos window and from C:\ or any other directory, type 
      mysql and press enter. It should go to the mysql> prompt. type QUIT in the
      mysql> prompt to return to the command prompt.
      
   b. Read the section (section 4?) that deals with MySQL Database 
      Administration from the mysql manual which can be found C:\mysql\Docs
      This section deals with user priveleges and tells you how to make mysql
      more secure and add a new user etc.

      You need to setup a user AND a password in mysql. If you are planning
      to run mysql as user 'root' then you have to set up a password for user 
      'root' if it isnt already setup.
      
      The following is from the mysql documentation,
      
          The default privileges on Windows give all local users full 
          privileges to all databases. To make MySQL more secure, you should
          set a password for all users and remove the row in the mysql.user 
          table that has Host='localhost' and User=''. 

          You should also add a password for the root user. 
          (The following example starts by removing the anonymous user, that 
          allows anyone to access the 'test' database.): 
      
          C:\mysql\bin> mysql mysql
          mysql> DELETE FROM user WHERE Host='localhost' AND User='';
          mysql> QUIT
          C:\mysql\bin> mysqladmin reload
          C:\mysql\bin> mysqladmin -u root password your_password
      
      If you are running mysql as root, you *MUST* have a root password set up
      as indicated above, otherwise voodoostats will stall when updating
      the mysql database.
      
      Test to see if you can load up mysql with the username and the password
      you have set up as following:

        mysql -u Username -pPassword

      Note: Username = your username
            Password = your password
            There is no space between the -p and your password

      If it goes to the mysql> prompt, mysql is properly set up on your system.
      Quit mysql by typing QUIT in the mysql> prompt and that should return to the
      command prompt.
      
        mysql> QUIT
      
      Close the dos window.
 
   2. php setup
      ---------

   a. Make sure you have configured your webserver to intercept .php files.
      This should automatically be done by the php installation program. Read
      the ReadMe file that comes with php. You may have to configure some things
      manually depending on the webserver you have on your system.
      *WARNING* If php is not set up properly, your username/password for mysql
      may be compromised!
      There is a file called test.php in this distribution under the html 
      sub-folder. After setting up php, start your webserver and configure it
      to give public access to the html folder. Then load up the test.php file
      using your internet browser. If php is set up prop...
Zgłoś jeśli naruszono regulamin