Vsp core v0.45

README

================================================================================
vsp stats processor - vsp(c) 2004-2005 by myrddin(myrddin8 <AT> gmail <DOT> com)
================================================================================

vsp stats processor is a multi game - log analyzer/stats generator/log parser. 
It can process log files from several games including Quake 3 Arena (q3a), 
Halflife 1, 2, Counter Strike Source (hl), Wolfenstein: Enemy Territory (wet), 
Return to Castle Wolfenstein (rtcw), Call Of Duty, COD: United Offensive (cod), 
Medal of Honor Allied Assault, MOHAA: Spearhead, MOHAA: BreakThrough (moh), 
Soldier of Fortune 2 (sof2), etc. It reads the log files generated by a game 
and displays various game statistics. vsp also supports both server logs (ex:- 
games.log for Q3A) and client logs (ex:- qconsole.log for Q3A).

Credits:
---------

             Lead Programming/Design : myrddin (myrddin8 <AT> gmail <DOT> com)
                         Programming : react
                             Hosting : gouki
                             Website : http://www.clanavl.com/vsp/
                                       http://www.clanavl.com
                                 Irc : #vsp on irc.enterthegame.com

________________________________________________________________________________



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

   
   0. requirements
      ------------
   
      - php (http://www.php.net) - version 4
      - mysql (http://www.mysql.com)
      - a php compatible web server (http://www.apache.org)
      - a web browser (http://www.mozilla.org/products/firefox/)

      vsp uses php and mysql to store and retrieve stats, so you need to
      install both php and mysql on your server/system.
      You may also need a webserver that is compatible with php if you dont 
      already have one. Apache is a good one and is the recommended web server.
      php, mysql and apache can be downloaded and used for free.
      Download the latest version of the php, mysql & apache(or another webserver)

      php can be downloaded from http://www.php.net
      mysql can be downloaded from http://www.mysql.com
      apache can be downloaded from http://www.apache.org
      You can also get a free webserver from http://www.xitami.com , which may be
      easier to setup than apache.

      Install the webserver first. In windows, the PHP setup program can 
      automatically detect the webserver and configure it accordingly.
      Install mysql and php on your system.

      Check the installation instructions that comes with php, mysql and apache, 
      for further instructions. 

      http://www.google.com is a good resource as well.

      It is recommended that you run php as a module from apache.
   
   
   1. mysql setup
      -----------
   
      If you already have a mysql username/password/hostname/database set up,
      then you may skip this step. Usually your website host will provide you
      with this information. 
   
   a. Read the section (section 5?) that deals with MySQL Database 
      Administration from the mysql manual which can be found C:/mysql/Docs or
      online at http://www.mysql.com/doc/en/Adding_users.html or
      http://www.mysql.com
      This section deals with user priveleges and tells you how to make mysql
      more secure and add a new user etc. You can simplify this process using
      an application called MySQL Control Center which can be found at
      http://www.mysql.com/products/mysqlcc/index.html

      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 isn't already setup.
      
      The following is from the mysql documentation:-
      
      
          The default privileges on Windows give all local users full privileges 
          to all databases without specifying a password. To make MySQL more 
          secure, you should set a password for at least the root accounts. 
          You should also remove the row in the mysql.user table that has 
          Host='localhost' and User=''. This account allows anonymous access 
          but has full privileges, so removing it improves security.

          The following example shows how to remove the anonymous-user account 
          that has all privileges, and then assigns a password to the root 
          accounts:
          
          C:\> C:\mysql\bin\mysql -u root mysql
          mysql> DELETE FROM user WHERE Host='localhost' AND User='';
          mysql> FLUSH PRIVILEGES;
          mysql> QUIT
          C:\> C:\mysql\bin\mysqladmin -u root password "newpwd"
          C:\> C:\mysql\bin\mysqladmin -u root -h host_name password "newpwd"

          Replace "newpwd" with the actual root password that you want to use. 
          The double quotes are not always necessary, but they are helpful if 
          the password contains spaces or other characters that are special 
          to your command interpreter. In the second mysqladmin command, 
          replace host_name with the name of the server host. 
      
      
      If you are running mysql as root, you *MUST* have a root password set up
      as indicated above
      
      Test to see if you can load up mysql with the username and the password
      you have set up. Open up a command prompt and do the 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 command prompt window.
      
      Further help on how to set up mysql can be found at http://www.mysql.com
 
 
   2. php setup
      ---------
      
      If you already have php set up on your host then you may skip this step. 
   
   a. The following step is not required but it is recommended to make things
      easier. If you dont do the following, then you have to type the full
      php path whenever you want to execute vsp. (i.e. Instead of typing
      php vsp.php, you have to type C:/php/php vsp.php.
   
      Add the php command path (c:/php/ is the default) to your 
      environment variable PATH.
      In windows 2000/XP 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:\php;
      
      i.e, when you type php -v from the command prompt (from any directory), 
           it should display the php version you have installed.
      Test it! Open up a command prompt window, and from C:\ or any other 
      directory, type php -v and press enter. It should display your php version.
      
   
   b. 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 pub 
      sub-folder. After setting up php, start your webserver and configure it
      to give public access to the pub folder. Then load up the test.php file
      using your internet browser. If php is set up properly, you should see
      a whole lot of tables with variables and its values. If instead you see a
      line saying that "php is not set up properly" followed by "phpinfo();",
      then php is not set up properly! Once you confirm php is working properly,
      you can and should delete the test.php file from your system (more secure).
  
      Further help on how to set up php can be found at http://www.php.net
 
 
   3. vsp setup
      ---------
      
      If you installed mysql, php, apache or another webserver or made any 
      changes to your system configuration, its a good idea to reboot your 
      system before you continue any further.

   a.  i) Download the vsp core zip file and extract it to a folder of your choice.
   
      ii) Download all the game media zip files that you want vsp to work with and 
          extract to the same folder you chose in step (3a.i), overwriting existing 
          files if necessary. If there is no media file for the game you are 
          looking for, you can ignore this step. 

   b. Open up pub/configs/cfg-default.php file using a text editor and 
      specify your mysql database username, password and other preferences. 
      Further decription of what each setting in the cfg file mean, can be
      found in cfg-default.php itself. Before you start parsing the logs, you 
      must make sure that you set the variable $cfg['game']['name'] in the config
      file properly. Read the comments beside that variable in cfg-default.php
      
   c. To analyze a log file and generate stats
      
      There are two available methods to update your stats:-
      
       i) If you have command line shell access to server where you installed vsp...
      
          Lets say you