Getting Started
Contents |
Introduction to HLXCE
HLXCE is written by a team of developers who believe that getting great statistics to help your gaming community should be free. HLXCE is a constantly evolving product with new versions being released regularly. The development team welcomes you to our wiki, and hopes that you find the content here informational and helpful. Please consider dropping by our Community to talk to the development staff and other users of HLXCE.
Supported Games
HLXCE is designed to accept HL Log Standard format logs. This typically includes Gold Source (HL1) and Source (HL2) games and modifications. This means most Valve games are supported, however many mods may not be supported due to customization of the log format. For a complete list of supported games, check out our Supported Games page.
Components of HLXCE
To aid with troubleshooting and configuration, you will want to become familiar with what each part does and where you need to install it. HLXCE is composed of three main components, outlined below.
HLXCE daemon
The HLXCE daemon is a collection of perl scripts and modules that is able to parse incoming log lines, either by listening for live logs from game servers or from saved log files, and then act upon the log it received. The daemon is also responsible for returning data to the game server when an event is triggered or a player requests information, such as rank or top10. The daemon does not need to be accessible by the web, however it does need to have access to the MySQL database (which can be stored remotely). Since the daemon is written using strict perl, most shared hosting and almost all VPS providers, as well as dedicated hosting companies, should be able to run the daemon with minimal effort.
HLXCE web site
Most likely the user interface of choice for game stats, the web site for HLXCE provides your players with the ability to track their progress live while games are in progress. The web site backend is entirely php, and can be installed anywhere. It does require access to the MySQL database and the HLXCE daemons (if you wish to use the remote control feature in the Administration Center).
HLXCE ingame plugins
- See also: SuperLogs
The ingame plugins for HLXCE provide the daemon with the necessary RCON commands to provide ingame feedback. A common misconception of the ingame plugins is that they perform the look up requests for ingame queries (such as rank, place and top10). This is incorrect. The ingame plugins simply provide the necessary commands that the daemon uses to message players when it sends RCON commands.
For example, when you load the SourceMod plugin onto your SourceMod enabled game server, it creates multiple new commands, such as hlx_psay. When a player performs an ingame event, such as capturing the flag, the daemon will RCON into the game server and utilize the hlx_psay command.
Installation Requirements
HLXCE has a number of requirements for installation. You will need at least one "server" to run your game server, daemon and web site on. You can run all three of these on one system if you wish, just be sure to check performance as the load on MySQL can be higher than most other web-utilities, such as forums and blogs. For more details on the specific requirements for the web, database and daemon server, check out our Installation Requirements page.
Installation
Installation of HLXCE is very similar on Linux and Windows hosts. Complications sometimes arise on hosts running cPanel or other panel-based shared hosting. However we do have installation guides to help get HLXCE installed on your host:
Post-installation
Once you've installed HLXCE it may require minor adjustments to the point system, depending on the tastes of your gaming community. When updates are provided by the development team, you will need to perform a database and file update. Instructions for each update are provided as part of the Release Notes for the update. Please be sure to read the Release Notes for every release to know how the update may impact you!
Be sure to check out our User Documentation section for help on running your new HLXCE installation. If you cannot find your answer there, please visit our of our Communities for further assistance, or to just chat! Welcome to HLXCE!
