
Overview
This page includes everything needed to use this feature in the "Beamable SDK for Unity". Or watch this video.
The purpose of this feature is to allow the player to see the LeaderboardLeaderboard - A list of high scores by all players of a game.
The User Interface
When setup properly, the player's user interface in the game project will be as follows.


The Beamable "Leaderboard Flow" UI in the Unity Game Window
Steps
Follow these steps to get started.
Step | Detail |
---|---|
| • Unity → Window → Beamable → Open Beamable Toolbox |
| • Drag this Prefab from the Beamable Toolbox Window to the Unity Hierarchy Window |
Here is the "Beamable" menu as seen in Unity.


The “Beamable” Menu
Here is the feature Prefab as seen in the Beamable Toolbox.


The Beamable "Leaderboard Flow" in the Beamable Toolbox Window
Advanced
Here are a few advanced configuration options and workflows.
Creating Leaderboard Content
LeaderboardLeaderboard - A list of high scores by all players of a game content is required to properly populate the Leaderboard UI.
Step | Detail |
---|---|
| • Unity → Window → Beamable → Open Content Manager |
| ![]() ![]() |
| • Unity → Window → General→ Project |
| • Search by the name given in step #3 |
| ![]() ![]() Note: The |
| • Unity → File → Save Project Best Practice: If you are working on a team, commit to version control in this step. |
| • Press the "Publish" button in the Content Manager Window |
Beamable Security & Permissions
Each
Leaderboard
content object asset includes awrite_self
field.• True: Allows for client-authoritative score updates. Benefits include ease-of-use for game makers and is ideal for a game which can tolerate the occasional cheater. It is hackable.
• False: Allows for server-authoritative score updates and requires additional setup via Microservices. Benefits include higher system security and is ideal for a game which requires that. It is less hackable.
Rewarding Leaderboard-Related Score
To appear on the Leaderboard, a player must have a competitive score.
During Development
The Portal allows the game maker to view and edit a player's score. This is a helpful, temporary workflow during the design and development of a new game feature.
During Production
To properly reward the players with score in production code, use custom C#. See the following example for inspiration.
Code
Beamable SDK Examples
• This and all examples are available for download at GitHub.com/Beamable_SDK_Examples
using Beamable.Common.Leaderboards;
using UnityEngine;
namespace Beamable.Examples.Services.LeaderboardService
{
/// <summary>
/// Demonstrates <see cref="LeaderboardService"/>.
/// </summary>
public class LeaderboardServiceExample : MonoBehaviour
{
// Fields ---------------------------------------
[SerializeField] private LeaderboardRef _leaderboardRef = null;
[SerializeField] private double _score = 100;
// Unity Methods --------------------------------
protected void Start()
{
Debug.Log($"Start()");
LeaderboardServiceSetScore(_leaderboardRef.Id, _score);
}
// Methods --------------------------------------
private async void LeaderboardServiceSetScore(string id, double score)
{
var beamableAPI = await Beamable.API.Instance;
Debug.Log($"beamableAPI.User.id = {beamableAPI.User.id}");
await beamableAPI.LeaderboardService.SetScore(id, score);
Debug.Log($"LeaderboardService.SetScore({id},{score})");
}
}
}
Managing Leaderboard Via Portal
The Portal allows the game maker to manage LeaderboardLeaderboard - A list of high scores by all players of a games.
Step | Detail |
---|---|
| • See Portal for more info |
| ![]() ![]() |
| ![]() ![]() |
| ![]() ![]() Available Operations Note: Some of these operations cannot be undone. |
FAQ
Here are highlights from the Beamable FAQ. See FAQ for more info.
Updated 25 days ago