Boards¶
Boards are the individual leaderboards your players compete on. Each game can have unlimited boards for different challenges, modes, or metrics.
Board ID¶
Each board has a unique identifier in the format brd_<uuid>, for example: brd_a1b2c3d4-e5f6-7890-abcd-ef1234567890.
You'll need board IDs when submitting scores or fetching leaderboards via the SDK. Find it in the LEADR app by navigating to Games, selecting your game, selecting Boards (or pressing b), selecting the correct board, and pressing y to copy the ID.
Slug¶
Each board has a "slug" that must be unique to that game. Slug is autogenerated from the board name, but can be manually specified if you need.
Example: For a board with the name "Weekly High Scores", the generated slug would be weekly-high-scores, but you could specify the slug as just high-scores if you preferred.
Slug is used to retrieve a single board via the SDK so you can easily use fixed names for boards in your game code. This is especially useful with board series generated via board templates where the individual board ID will change, so you can reliably retrieve the currently active board, e.g. weekly.
A board's slug is also combined with your game slug to give the full (canonical) URL for that board's web page. E.g. for a game with slug pong, the high-scores board would have the URL https://leadr.gg/games/pong/boards/high-scores.
Short Code¶
Sometimes you want a shorter and more convenient URL for sharing or linking board web pages. Each board also has a 6-character short code (e.g., ABC123) which are globally unique and used in short URLs like https://leadr.gg/b/ABC123.
The short code is automatically generated and cannot be customised.
Fields¶
| Field | Required | Example | Default | Description |
|---|---|---|---|---|
| Name | Yes | High Scores |
- | Board display name |
| Slug | Yes | high-scores |
Auto-generated | URL-friendly identifier (2-50 characters) |
| Description | No | Compete for the top spot |
None | Brief description of this leaderboard |
| Board Type | Yes | - | Per Player | How scores are tracked (see Board Types below) |
| Sort Direction | Yes | - | Descending | Whether higher or lower scores rank first |
| Keep Strategy | Yes | - | Best | How to handle multiple scores per player (Per Player boards only) |
| Starts At | No | 2026-05-04T00:00:00Z |
None | When this board becomes active (ISO 8601 datetime) |
| Ends At | No | 2026-05-04T23:59:59Z |
None | When this board closes for new submissions |
| Unit | No | points |
None | Score unit label (e.g., "points", "seconds", "meters") |
| Icon | No | fa-trophy |
fa-crown | FontAwesome icon name |
| Tags | No | challenge, points |
None | Comma-separated tags for organising boards |
| Active | No | Yes |
Yes | Whether the board accepts new scores |
| Published | No | Yes |
Yes | Whether to generate a web page for this board |
Board Types¶
Per Run¶
Every score submission is ranked separately. Players can have multiple entries on the leaderboard.
Use for: Classic "High Scores" leaderboards, speedrun attempts, daily challenges where each attempt counts
Per Player¶
One entry per player on the leaderboard. When a player submits multiple scores, the Keep Strategy (see below) determines which score is kept.
Use for: Personal bests, all-time high scores, single attempts, most recent scores
Counter¶
Tracks cumulative totals that increment over time. Each submission adds a delta to the player's total rather than replacing it.
Use for: Total wins, games played, lifetime distance travelled, minutes of playtime
Ratio¶
Calculates a ratio or percentage from two Counter boards. Requires selecting a numerator and denominator board.
Use for: Win/loss percentage, accuracy rate, completion percentage, damage per second
See the Advanced Boards guide for more information on creating Counter or Ratio boards.
Sort Direction¶
| Direction | When Higher is Better | Example Use Cases |
|---|---|---|
| Descending | Yes | High scores, points, distance, wins |
| Ascending | No | Speedruns, golf, fewest attempts, shortest time |
Keep Strategy¶
Controls what happens when a player submits multiple scores to a Per Player board:
| Strategy | Behavior |
|---|---|
| Best | Keep only the player's best score (determined by sort direction) |
| Latest | Keep only the player's most recent score, replacing any previous |
| First | Keep only the player's first score, ignoring all subsequent submissions |
Per Run, Counter, and Ratio boards
Keep Strategy only applies to Per Player boards. Other board types handle submissions differently:
- Per Run: All submissions are kept and ranked
- Counter: Submissions are deltas that accumulate
- Ratio: No direct submissions (calculated from Counter boards)
Need Help? The LEADR team and community is always happy to help on the LEADR Discord