Modes Config Format

Overview

Modes make work with user statistics more flexible by acting as named containers for stats. Each mode stores its own independent copy of all user statistics. For example, a player can have 4 kills in solo mode and 10 kills in squad mode.

Typical uses:

  • game types: solo, squad, duo

  • countries: USSR, Germany

  • locations: Moscow, Berlin

To learn how the game interacts with the statistics server, see the .

Adding Modes Config

To use modes, you need to:

  1. Add mode descriptions to the modes config.

  2. Deploy configs to services.

Mode Description Format

{
  "name": "solo",
  "leaderboard": "SIMPLE",
  "public": false
}

Fields

name string required

Name of the mode. Must be unique.

leaderboard string optional

Type of leaderboard generated for this mode. Defaults to "NONE".

Possible values:

  • NONE – No leaderboard is generated for this mode.

  • SIMPLE – Generates a flat leaderboard without groups.

  • GROUPING – Generates a leaderboard with groups. Use this to implement leagues or buckets. See Leaderboard Group.

public bool optional

If true, makes stats for this mode visible to other users. Defaults to false.

Note

This only applies to stats with showForAll = true. To request another user’s statistics, use the action.