Dashboard guide
Leaderboards
A leaderboard is a ranked table of scores. A game can have as many as it needs: a high score table, a weekly speedrun board, one per level.
Adding a leaderboard
Choose Add leaderboard on the game's overview, or go to Leaderboards and add one there. The settings are:
| Setting | What it does |
|---|---|
| Leaderboard name | Shown in the dashboard, and returned by the API. Unique within the game. |
| Description | For your own notes, and returned by the API. |
| Unique Rows | Keep one entry per player, their best, instead of recording every attempt. |
| Primary Ordering | Highest puts the biggest score first; Lowest the smallest, for times and golf. |
| Secondary Ordering | Breaks ties on the primary score with a second number the game sends. Remaining ties go to whoever got there first. |
| Lowest accepted score | Submissions below this are refused. Empty for no limit. |
| Highest accepted score | Submissions above this are refused. Empty for no limit. |
The bounds are the cheapest defence against obviously impossible scores, so set them when you know them.
Maybe we'll add more specific anti-cheat methods, but version 1 has to have somewhat reasonable scope.
Scores
Each score belongs to a player, and keeps the name they went by when they set it. Scores by banned or deleted players are kept, but they are not shown and do not count towards anyone's rank. Lifting the ban or restoring the player brings them back.
The Leaderboards list shows each board's id, which is what a game passes when it reads or submits.
Managing entries
Browse scores on a board lists its entries, 50 to a page. Search by name, player id or entry id; sort best first, worst first, newest or oldest; and choose between the entries on the board, the hidden ones (whose player is banned or deleted), or all of them. Each row can be opened, deleted, or its player banned.
An entry's own page shows everything about it: its rank, its player, the extra data the game stored with it, the entries around it on the board, and the player's other entries there. From it you can:
- Change the name shown, for a name that should not be on a public board. The score and when it was set stay as they are.
- Delete the entry. This cannot be undone.
- Ban the player, which takes all their entries off every leaderboard until the ban is lifted, or sign them out of every device.
What a game needs
A key with the game client role may read a leaderboard's settings, read its scores and submit scores. Submitting needs a signed-in player, because every score belongs to one. Submitting on behalf of any player, and editing or deleting scores, are for your own server. See the leaderboard API.