Leaderboard

Website | Docs | API | Forum | Discord

A highscores leaderboard plugin and self-hosted service for Unity.

Allows players and developers to easily store and retrieve highscore entries.

Supports unlimited entries per user, or optionally store a limited number of the best ranked entries to keep your leaderboard uncluttered.

Entries may be retrieved one page at a time in ascending or descending order while taking ties into account.

You can also show a player's latest score in context to other surrounding scores.

Supports Windows, Linux, OSX, Android, and iOS.

Note: Web builds are not supported.

Note: This is a self-hosted service. Before you can use the plugin you must set up the provided leaderboard_server executable on a publicly accessible server. See Assets/Leaderboard/Server/README.md for details.

Metadata

Up to 10KB of metadata may be stored per leaderboard entry. Metadata is stored as bytes, so you can use it to store just about anything you can think of related to a high score entry, like which character a player was playing as, or what upgrades they had.

Flexible Filtering

Highscore lists can be filtered by player or level or both. You can also include multiple entries per player, or only the best entry for each player, whatever best suits your game.

Sorting and Pagination

Leaderboard lists may be sorted in ascending or descending order by rank. The rank is determined by score and sorting order and takes into account ties. Entries can be retrieved one page at a time for easy display to users.

Player Entry Limit

By default there is no limit on the number of entries a player can have for each level. You may optionally set a maximum number of entries per player per level. This allows you to easily keep only the best scores for a player and keep your leaderboards less cluttered.

Get Adjacent Scores

You may also show your players latest score in context to other surrounding scores using the GetListAdjacent method.