Skip to main content

Counter-Strike 2 Plugin

Integrating your Counter-Strike 2 with our API allows us to automate several processes, enhancing your gaming experience.

Installation Steps​

  1. Download the Plugin:
  2. Install the Plugin:
    • Place the addon folder into your /path/to/csgo directory.
    • Start or restart your server to activate the new plugin.
  3. Configure the Plugin:
    • Stop your server.
    • Navigate to /path/to/csgo/addons/counterstrikesharp/configs/plugins/GameCMSPlugin/GameCMSPlugin.json.
    • Open the config file, locate the ServerHttpPort entry, and enter a free port number not used by any other service.
    • Configure the database settings within the same file to ensure proper communication with the necessary databases.
    • Restart your server to apply the configuration changes.
  4. Create and Verify the Server:
    • Go to the GameCMS Dashboard.
    • Navigate to Integrations > Servers.
    • Select Counter-Strike 2 as the Server Type and click Create.
    • You will be redirected to the server verification page. Follow the instructions provided.
    • Run the server verification command in your console, and you should see a message confirming that your server has been successfully verified.
WEBSITE API KEY

Website API KEY is not required it's added for future features.

Configuration Options​

  • ServerApiKey: This is the server API key used to create a new server instance for each of your servers.
  • WebsiteApiKey: This is your website API key. Currently, this option is not in use and can be ignored.
  • ServerHttpPort: This is the port you need to open for connecting the server to our platform.
  • FaceitToken: This is an optional field. To use this, generate a server-side token from the Faceit Developer Portal. It's used to display player levels and online player lists.
  • DeleteExpiredAdmins: Set this to 'true' if you want to automatically delete expired admins from the database.

Plugin Services​

Playing Time​

Configuration Key: playing-time

This service tracks how long players spend on your server. When enabled (default setting), the plugin stores daily player activity, including:

  • Time spent on the Terrorist team
  • Time spent on the Counter-Terrorist team
  • Time spent as a Spectator

If disabled, no playing time data will be collected.

Server Data Collection​

Configuration Key: server-data-collection

When enabled, this service sends basic metrics to our API, including:

Server Information:

  • Server IP and name
  • Maximum player capacity
  • Current online players
  • Round statistics (CT/T wins, maximum rounds)
  • Match duration and warmup status

Player Information:

  • Steam ID
  • Performance stats (kills, deaths, headshots)
  • Session data (join time, score)
  • Network information (ping)
  • Team assignment

VIP Status Tracker​

Configuration Key: vip-status-tracker

This service tracks players with VIP privileges on your server. It doesn't grant VIP status but monitors which players have VIP flags, allowing you to display this information on your website regardless of which VIP plugin you use.

Configuration Options:

  • enabled: Enable or disable VIP status tracking
  • flags-list: Define which flags identify VIP players on your server
  • purge-days: Number of days after which inactive VIP players are removed from tracking

Complete Services Configuration Example​

Below is an example showing how to configure all available services:

{
  "services": {
    "playing-time": true,
    "server-data-collection": true,
    "vip-status-tracker": {
      "enabled": true,
      "flags-list": [
        "css/vip",
        "css/vip-plus",
        "css/vip-premium"
      ],
      "purge-days": 30
    }
  }
}

Missing Configuration Keys​

If your configuration file is missing any of the settings shown above:

  1. Generate a new config file:
  • Delete the existing config file at configs/plugins/GameCMSPlugin/GameCMSPlugin.json
  • Restart your server or reload the plugin
  • A new file with all default settings will be generated automatically
  1. Manually add missing keys:
  • Open your existing config file
  • Copy the missing sections from the example above
  • Paste them into your configuration file
  • Make sure to maintain proper JSON structure with correct commas and brackets
  • Save the file and reload the plugin

This completes the setup process. Your Counter-Strike 2 server is now fully integrated with our platform.

Command List​

info

All commands require the @css/root permission and are available for both client and server.

  1. css_gcms_store_force: Forces the execution of any commands that are queued from the webstore.
  2. css_gcms_server_verify: Verifies your Counter-Strike 2 server with the GameCMS API.
  3. css_gcms_reload_admins: Reloads admins, groups, and overrides. These changes will be applied to your admins.json, admin_groups.json, and admin_overrides.json files. (Root flag required)

Video Tutorials​

For further assistance, please refer to our video tutorials:

How to setup CS 2 Plugin

How to add MySQL Server

Plugin Features

If you wish our plugin to do something more that can help your Rust Server, please contact us.