Leaderboards
Attention: The Digital Services Act (DSA) requires Unity to notify our customers’ end users if Unity takes an action which impacts those end users under the DSA. To comply with this requirement, if you use Unity Gaming Services (UGS) products that rely on the Unity Authentication Service, you must integrate the notification API by the effective date of the DSA: February 17, 2024. The notification API is ready for adoption in late January 2024.
For more information on DSA, refer to the Digital Services Act - compliance update.
To make your game compliant, refer to DSA notifications.
Leaderboards is a feature of Unity Gaming Services that supports the storage, sorting, and ranking of player scores.
| Topic | Description |
|---|---|
| Get started | Learn how to set up your project with leaderboards. |
| SDK sample | Use an example to learn how to implement Leaderboards in your Unity project. |
| SDK documentation | Familiarize yourself with the Leaderboards SDK to use online multiplayer leaderboards in your Unity project. |
Interfaces
You can interact with Leaderboards and implement them in your application using the following interfaces:
- Use the Unity Cloud Dashboard to create and manage your leaderboards and view entries.
- Implement Leaderboards for non-MWU (Made with Unity) games using REST APIs.
- Perform player actions with the Client REST API.
- Perform admin actions with the Admin REST API.
- Make calls to the Leaderboards service with the CLI.
- Use the Unity SDK to implement leaderboards in your application.
- Implement Leaderboards functionality using the Cloud Code service.
- Deployments are supported for the Unity Editor and the command-line interface (CLI).
- Allows you to configure Leaderboards using files, instead of the Unity Cloud Dashboard UI.
- Include these files as part of version control to minimize the Unity Cloud Dashboard context switching.
Outcomes
| Outcome | Description | Services used |
|---|---|---|
| Display player names in Leaderboards | Retrieve player names using the Authentication service and display them in your Leaderboards. | |
| Display Leaderboards in Lobby menus | Implement Leaderboards in Lobby menus to let players compare themselves against each other. | |
| Compare scores with Friends | Let players view Leaderboards for their friends and compare against each other. |