XLRstats Installation Documentation

XLRStats Webfront Installation - How To

XLRStats Webfront Installation - How To

XLRStats is the only REAL TIME stats solution for games and it has started to offer great improvements with the release of version 2. This guide describes the step-by-step installation of XLRstats Webfront on your server!

Download the latest version of XLRstats Webfront here.

REQUIREMENTS:

Before installing XLRstats webfront, make sure you have BigBrotherBot - B3 installed and running correctly. We will not cover the installation steps for B3 here, but you can simply go to http://www.bigbrotherbot.net and find plenty of information on the website and forum section.

After you have got B3 installed and running smooth, install following B3 plugins required by XLRstats!

  • XLRstats plugin (Documented here)
  • status.py plugin version 1.2.5 or higher! (included in XLRstats Webfront package)
  • ctime.py plugin (included in XLRstats Webfront package)

To install status.py and ctime.py, follow the steps explained in README.TXT files.

Remember to check your b3.log to see BigBrotherBot is functioning correctly and all plugins are loaded successfully. If you encounter problems, solve them first!

All is good with BigBrotherBot and plugins? Good! Now grab a piece of paper and a pen, and note down the following information which you will need during setup. If you're not sure, contact your service provider:

Hostname This is generally "localhost" if you'll install the webfront on the same machine as your database.
MySQL Username Username to access your B3 Database
MySQL Password Password to access your B3 Database
MySQL Database Name The name of the database you are using for B3.

INSTALLATION:

First thing to do is to upload xlrstats to your web server. In the package you downloaded you will have three folders: "b3-plugins", "sql" and "xlrstats".

  • Upload the "xlrstats" folder to your web server using an ftp software like FileZilla or any other software you're familiar with.
  • Make the folders "dynamic" and "config" writable by the webserver. XLRstats will place its dynamic files in "dynamic" folder and the installer will create the config file(s) in "config" folder.

    Linux users who have shell access to the server type:

    # chmod 777 path/to/xlrstats/dynamic
    # chmod 777 path/to/xlrstats/config


Do not forget to replace the path information with yours.

  • If you see the following screen, uploading the files to the server was successful and all is going well so far. If not, check if all files are uploaded successfully.

Licence & Read Me

XLRstats was created at www.xlr8or.com, the community of serious gamers around the world, and distributed freely under GNU/GPL license. That means we receive no revenue from selling XLRstats. But to keep our project going we need your valuable support. Click here to lend your support to: xlrstats-web-v2 and make a donation at www.pledgie.com !

Click "Start Install" button on the lower right corner of the page to begin installing XLRstats!

Requirements

We have already covered some of the requirements such as B3 and plugins. At this stage, PHP and several other settings are also checked. If any of those are in red, you must correct them first.

Contact your service provider if necessary.

If all is green as in the image above click "Next" to continue.

Step 1 - MySQL Connection Settings

At this stage, the information you have written down earlier will come in handy! Simply fill in the information below correctly and click "Next".

If the information you entered is wrong, you will receive a warning message as below:

Hit "Go Back" button and provide the correct login information. Contact your service provider if necessary!

Step 2 - Basic Game & Server Settings

Once you enter the correct login information and click "Next", the following screen is displayed. Here you have to provide your game and server settings.

  • Each setting is explained briefly at the end of each line. The crucial settings that need to be entered correctly are "B3 Status URL" and "GeoIP path" in case you want to use GeoIP.
  • status.xml is the file created by B3 status.py plugin and it is the communication line between B3 and XLRstats. So it is crucial to enter the full path or URL to status.xml correctly.
  • If you use GeoIP information, players' country flags are displayed in XLRstats pages. This is a nice feature if you want to see where each player is connecting from. If you intend to use the GeoIP data in the playerlist you'll have to download the (free) GeoIP.dat file from http://www.maxmind.com and make sure the path to the file is set correctly! (http://geolite.maxmind.com/download/geoip/database/GeoLiteCountry/GeoIP.dat.gz) this is a gzipped file, you need to unzip it with an unzipper like 7-zip before usage.)

- NOTE 1: Add a trailing slash to the path: /path/to/your/GeoIP/

- NOTE 2: Windows users: Use forward slashes in the path: C:/path/to/your/GeoIP/

- NOTE 3: Although a URL is acceptable for status.xml, you cannot enter a URL for GeoIP path.

  • If you provide wrong path information for either status.xml or GeoIP you will see a warning page as below.

  • You must provide the correct paths to proceed. So, hit "Go Back", enter correct information and click "Next" when you're ready!

Step 3 - Advanced XLRstats Settings

At this stage advanced XLRstats settings are displayed, and again a brief explanation of each setting is presented at the end of each line. You can either change those settings as you like them to be or just keep the default settings.

  • If you are confident with all settings, click "Save Config" button.

Step 4 - Statsconfig Files

If you see the following screen, your "statsconfig.php" was just created and you are only 2 clicks away from completing your installation. Of course if you have just one server to configure.

  • If you have another server to configure click "New Server" button. This will take you back to "Step 1".
  • Repeat the same steps for your second server.
  • If you have just one server click "Finish".

Identify Awards

Once you click "Finish" button at "Step 3", the installer generates the awards file. In other words medal owners are determined and the installation is now complete.

  • If all went well, your installation is successfully completed and now you can click "Index" button to go to your server's XLRstats pages.
  • We highly recommend you to rename or move the "install" director to another location.

We hope this brief guide helps you install XLRstats without any hassle. However, if you encounter any problem, feel free to write to our forums.

Rate this page +1 at Google Search