Getting Started

Quick Start Guide

Get Rankly.gg tracking your DayZ server in under 10 minutes. Follow these steps from signup to live stats.

01

Create Your Account

Sign up at Rankly.gg with your email. After confirming, you will be guided through server onboarding where you name your server and choose your game.

02

Get Your API Key

After onboarding, your unique API key will be displayed on the dashboard. Copy it — you will need it for the mod configuration. The key format is RNKLY-XXXX-XXXX-XXXX-XXXX.

03

Download the Mod

Subscribe to RanklyStats on the Steam Workshop (ID 3683623007). Steam will download it automatically. For manual install details, see the Mod Installation guide.

04

Create RanklyConfig.json

Create a file called RanklyConfig.json in your server's profiles directory (the folder set by your -profiles= launch parameter). Paste your API key into it:

{
  "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. See the Configuration guide for details on each field.

05

Add Launch Parameter

Add -servermod=@RanklyStats to your DayZ server launch parameters. If you already have other server mods, separate them with semicolons: -servermod=@RanklyStats;@OtherMod

06

Restart Your Server

Restart your DayZ server so it loads the mod. The mod initializes on server startup and begins tracking events as soon as players connect.

07

Verify Data Is Flowing

Have a player connect to your server. Within 1–2 minutes you should see data appearing on your Rankly dashboard. Check the Verify Setup guide if data does not appear.

Profiles Directory Note

The profiles directory is where DayZ stores server logs and configuration. It is set by the -profiles= launch parameter. If you use -profiles=config, then place RanklyConfig.json in the config\ folder. If you don't set -profiles, the default is your server root directory.