Documentation Home

Page Last Updated on: Wednesday, December 18, 2024 1:33 AM
Total Hits: 46,527
VSP™ Logo

Voodoo Stats Processor - v1.1.52

Voodoo 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, 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 Program / Design : myrdd1n & Krillin
Programming : react
Hosting : Krillin's World
VSP™ Dev Website | Krillin's World VSP™ Live Test Site
Offically Download Voodoo Stats Processor at VSP™ Download Section!

For up-to-date information regarding VSP™ visit www.krillinsworld.com/vsp or for help visit our VSP™ forums at https://www.krillinsworld.com/forum/index.php#c9
Please Note: Not all sections of our forums are open to the General Public. You may be required to register with our forums before you can gain access for assistance.

READ, READ, READ AND REREAD
Read these instructions carfully. If you do not understand them, read them again. If you still do not understand them reread them again. Once you get a grip of them, then follow along. If you need assistance reach out to us in our forums (above). Just note registration will be required.

Installation and Usage Instructions

0. Requirements

1. Overview

VSP™ uses PHP and a database storage system (MySQL or MariaDB) to store and retrieve player stats. You’ll need to:

  1. Install PHP, MariaDB/MySQL, and a compatible web server (e.g., Apache / IIS).
  2. Configure the components to work together. (IIS seems to have gone by the way side these days)

2. Installation Steps

Part 1: Install a Web Server

Download Apache from https://www.apache.org and follow its documentation for installation and setup.

For IIS see Installing IIS help guide (asp not required).

Part 2: Install PHP

Download PHP from https://www.php.net. For Windows users, use builds from https://windows.php.net. Ensure PHP is configured as an Apache module. This is required for compatibility with Apache 2.4.xx.

Part 3: Install a Database System

3. Configuration Guidelines

If you already have PHP set up on your host, you may skip ahead here.
  1. Installation Directories:
    • Windows Users: Avoid installing PHP or MariaDB/MySQL in C:/Program Files/ or C:/Program Files (x86)/. Use paths like C:/PHP/ and C:/MariaDB/ for better compatibility.
  2. Database Configuration:
    • If migrating from MySQL to MariaDB:
      1. Back up your MySQL /Data folder.
      2. Uninstall MySQL.
      3. Install MariaDB in the C:/MariaDB/ directory. Use the same root password as MySQL for a seamless migation.
      4. Stop the MariaDB service using the Services Management Console (services.msc).
      5. Copy the /Data folder from the MySQL backup to the new /MariaDB/Data/ directory.
      6. Restart the MariaDB service.

      Note: Avoid copying directly to/from /MariaDB/Data/ while services are active to prevent corruption. If you copy the database files into or out from the /MariaDB/Data/ folder you will corrupt the data.

  3. PHP Module Integration:

    Verify PHP is running as a module in Apache to ensure proper compatibility.

4. Additional Notes

PHP Setup

Part A

The following step is not required but recommended to make things easier. If skipped, you’ll have to type the full PHP path whenever executing VSP™.

For example:
Instead of typing php vsp.php, you would need to type:
C:\php\php vsp.php [snipped]

Add the PHP command path (C:\PHP\ is the default) to your system’s environment variable PATH.

NOTE: Windows XP and Windows Server 2003 are no longer supported as of VSP™ v0.47 because PHP 5.4.x is unsupported on these systems. Most recent versions of Windows are supported, with earlier versions like Windows 2008 R2 or Windows 7 required for older PHP versions. As of PHP version 8.3.0, PHP requires Windows 8 or Windows Server 2012. Versions after 7.2.0 required Windows 2008 R2 or Windows 7. Versions before 7.2.0 supported Windows 2008 and Vista.

To set the PATH variable:

Close all dialog boxes and restart your system as a precaution.

To verify the setup, open a command prompt and type:

php -v

If PHP is set up correctly, it will display something like:

PHP 8.4.1 (cli) (built: Nov 20 2024 11:13:29) (ZTS Visual C++ 2022 x64)
Copyright (c) The PHP Group
Zend Engine v4.4.1, Copyright (c) Zend Technologies with Zend OPcache v8.4.1, Copyright (c), by Zend Technologies

Part B

Ensure your web server is configured to intercept .php files. This should be handled automatically by the PHP installation. Refer to the PHP ReadMe file for manual configuration details if needed. If you are not sure, then ask. Below are the KEY settings to check, change or enable.

The following extensions are required to be enabled in your php.ini file before seeking help:

Other Settings:

During PHP setup, ensure date.timezone = is defined in your php.ini file to a valid timezone as see at: https://us3.php.net/manual/en/timezones.php Select your continent, locate your timezone and place it at date.timezone = in the php.ini file. Be sure to SAVE the changes to your PHP.INI file!

***WARNING***
If PHP is not set up properly, your MySQL/MariaDB cridentials (host, username, password, database name) could be compromised!

If you are using a web hosting company, resume here.

VSP™ File Structure

Understanding the file structure is essential:

		    VSP-CORE_v1.1.52/
		    - /_DOCS/           : Documentation files.
		    - /css/             : Cascading Style Sheets for VSP™ Web Access.
		    - /ftplogs/         : Location for processing game/server logs.
		    - /logdata/         : Stores SAVESTATE process data for reference.
		    - /pub/             : Public website files (not use for log processing).
		    - /sql/             : SQL statements for creating database tables.

		    [Key Files]
		    - ReadMD.txt        : Notice of relocated text content.
		    - License.txt       : License agreement reminder.
		    - password.inc.php  : Required for VSP™ Web Access.
		    - vsp.php           : Core processor for VSP™.
		    - vsp-client.php    : For processing client log files.
		    - vsp-cod.php       : For Call of Duty logs.
		    - vsp-hl.php        : For Half-Life and associated mods.
		    - vsp-moh.php       : For Medal of Honor logs.
		    - vsp-q3a.php       : For Quake 3 Arena logs.
		    - vsp-rtcw.php      : For Return to Castle Wolfenstein logs.
		    - vsp-sof2.php      : For Soldier of Fortune 2 logs.
		    - vsp-wet.php       : For Wolfenstein: Enemy Territory logs.
		    - vutil.php         : Utility functions for VSP™.

VSP™ Setup

The Home Stretch

VSP™ requires some manual staging depending on your specific environment. This document assumes you are running VSP™ locally on a server or workstation. We aim to keep this documentation simple, assuming a localhost setup. Adjust as necessary based on your setup.

To clarify, VSP™ has two sides: a frontend side and a backend side. The frontend side is what the players and the public access from a webserver. The backend side handles processing and offers two modes: CLI (command line interface) and Web Mode Access. These are self-explanatory and need no further explanation.

For PUBLIC ACCESS (frontend): Copy or FTP the contents of the /PUB/ folder to your webserver. Do not upload the /PUB/ folder itself. Instead, create a folder on the webhost like /vspstats/ and link that location on your website. If this is your entire website, copy the contents of the /PUB/ folder to the root folder, excluding the _Docs folder.

For Processing Access (backend): Copy the entire contents (including the MEDIA FILES/Mapset of your MOD) to a folder not linked to your frontend. For example, use /vsp/ or /vsprun/. Navigate to this location directly using: https://yoursite.com/vsp/vsp.php or https://yoursite.com/vsprun/vsp.php. VSP™ does not use default website standards like index.html or index.php, so call vsp.php manually.

Test PHP setup by accessing the included phpinfo.php file under the /PUB/ folder. Load the file in your browser (e.g., https://yoursite.com/vsp/phpinfo.php). If PHP is working, you'll see tables with variables and values. If not, you'll see a message indicating PHP is not properly set up. Once confirmed, delete phpinfo.php for security.

Further PHP setup documentation is available at https://www.php.net/docs.php.

If you installed MySQL/MariaDB, PHP, Apache, or made system configuration changes, reboot your system. If only PHP was changed, restart your webserver (Apache or IIS).

We need to set up a database for VSP™ to access because we need 4 pieces of information to insert into the configuration file. Use a utility like PHPMyAdmin to create the database. Use what ever name you like here VSP, playerstats, QGames, cstrike (you get the idea). When you set up the database, you created a username and password and grant this user full access to this database. Note the Hostname, Username, Password and Database Name. As this is required to generate game stats.

  1. Download the VSP™ core zip file and extract it to a folder.
  2. Download the game media zip file for VSP™ and extract it to the same folder, overwriting existing files if necessary. If unavailable, skip this step.
  3. If you have a mapset for your game, extract the contents into the folder you extracted the core folder.

Edit the pub/configs/cfg-default.php file with a text editor. Specify hostname, database name, username, password, and preferences. Ensure the variable $cfg['game']['name'] is set correctly based on the game's log type. Detailed comments are available in cfg-default.php.
Allowed config files are: cfg-default.php, cfg-custom.php and cfg-advanced.php.

Generating Stats

Method 1: Command Line

Navigate to the VSP™ folder and run:

php vsp.php -l q3a -p savestate 1 "C:\games\quake iii arena\osp\games.log"

Method 2: Web Browser

To enable web access to vsp.php by editing password.inc.php in the main folder. Set a password (minimum 7 characters) and upload it to the webserver. Then open https://yoursite.com/vsprun/vsp.php in your browser.

To analyze a log file (e.g., games.log), upload it to the ./ftplogs/ folder on the server. Open https://yoursite.com/runvsp/vsp.php in your browser, enter:

Click "RUN VSP™"

For frontend access, the contents of the /pub/ needs to be transfered to a public accessable folder on your website. For instance, you put the contents in a folder named /vsp/. Now you link the https://yourwebsite.com/vsp/ from your main website. After you parse your game servers log file(s) you will see the magic of VSP™ when you open https://yourwebsite.com/vsp will automatically redirect to https://yourwebsite.com/vsp/themes/bizmarck/index.php.

Customizing Themes

Edit the pub/themes/bismarck/settings.php to customize the theme. Use themes/bismarck/index.php?config=cfg-default.php to load specific configuration files.
Allowed files are: cfg-default.php, cfg-custom.php and cfg-advanced.php.

Visit the VSP Help for assistance.

FAQs are available here.

By using this software, you adhere and agree to the terms contained within this License Agreement.

Thank your for reading. We hope you enjoy using VSP™! 

			[END OF FILE]
© 2004 - 2024  VSP™ (Voodoo Stats Processor) – All right Reserved.®