Getting Started

Configuration

Configure the RanklyStats mod using the RanklyConfig.json file in your server's profiles directory.

Complete Configuration File

{
  "api_key": "RNKLY-XXXX-XXXX-XXXX-XXXX",
  "api_endpoint": "https://rankly.gg/api/ingest",
  "send_interval_seconds": 30
}

Replace the placeholder API key with the one from your dashboard. Save this file as RanklyConfig.json in your profiles directory.

Field Reference

api_keystringrequired

Your unique Rankly API key. Found on your dashboard after signup. Format: RNKLY-XXXX-XXXX-XXXX-XXXX. Each server has its own key — do not share keys between servers.

api_endpointstringrequired

The URL where the mod sends event data. This should always be set to "https://rankly.gg/api/ingest" unless you are running a self-hosted instance.

send_interval_secondsnumberoptional

How often (in seconds) the mod batches and sends events to the API. Default is 30. Lower values mean faster data but slightly more network overhead. Minimum recommended: 10.

API Key Format

Rankly API keys follow the format:

RNKLY-XXXX-XXXX-XXXX-XXXX

·Prefix is always RNKLY- followed by four groups of four hexadecimal characters

·Each server gets a unique API key — do not reuse keys across servers

·You can regenerate your key from the dashboard if it is compromised, but the old key will stop working immediately

Profiles Directory Location

The config file must be in the directory specified by your -profiles= launch parameter. Common setups:

With -profiles=config:

DayZServer/
├── config/
│   └── RanklyConfig.json   ← place here
├── @RanklyStats/
└── DayZServer_x64.exe

Without -profiles (default):

DayZServer/
├── RanklyConfig.json        ← place here
├── @RanklyStats/
└── DayZServer_x64.exe

Important

The mod reads RanklyConfig.json once at server startup. If you change the configuration, you must restart your DayZ server for the changes to take effect.

Previous: Mod Installation · Next: Verify Setup