DEVICE-CENTRIC DOCUMENTATION

The site has a new content architecture. We've added the ability to select your development device to show device-specific content. Please read our blog post Oculus Developer Center Update: Device-centric Documentation Architecture for more information.

Oculus Quest Development

All Oculus Quest developers MUST PASS the concept review prior to gaining publishing access to the Quest Store and additional resources. Submit a concept document for review as early in your Quest application development cycle as possible. For additional information and context, please see Submitting Your App to the Oculus Quest Store.

Leaderboards

Note: You are viewing the Native version of this topic. To view this topic for Unity development, see Leaderboards (Unity). To view this topic for Unreal development, see Leaderboards (Unreal).

Leaderboards create competition and increase engagement among your users.

The Oculus Platform will manage your leaderboard data, and you can opt in to user-facing leaderboards, meaning a user can see their rank compared to friends and other users in the Oculus app. In addition, you can optionally choose to have notifications automatically generated when a user passes a friend’s leaderboard score. However, you will be responsible for displaying, reporting, and verifying the leaderboard data in your app.

The following image shows a user-facing leaderboard.

user facing leaderboard

This page will walk you through how to create your global leaderboards, interact with the leaderboards service, and provide an example Unity implementation you can review or use as a leaderboard template.

Create a Leaderboard

The first step in adding leaderboards to your game is defining them in the developer dashboard. Navigate to Leaderboards and select the app that you would like to create a leaderboard for.

Select Create Leaderboard and enter the following information:

  • API Name - This is the unique string that you will allow you to reference this leaderboard in your app code. The API Name is case-sensitive, the name you define in the Dashboard must exactly match the name you reference in your code.
  • Sort Order - There are two options for Sort Order depending on your use-case:
    • Higher is Better will rank users in descending order, from highest to lowest score.
    • Lower is Better will rank users in ascending order, from lowest to highest score.
  • Enter a Title for your leaderboard that will display publicly.
  • If you have localized your app into multiple languages, use the Modify Languages button to select additional languages, and enter the localized Title for the leaderboard in each language you choose.
  • Finally, to enable social features for the leaderboard, use the sliders to opt in. You can:
    • Add a Deep Link Destination, which means when a user clicks on the leaderboard, they will be taken to the in-app destination that you specify. For more information about destinations, see Destinations and Rich Presence.
    • Choose to have the leaderboard user facing, meaning a user that owns your app can see their rank on a leaderboard in the Oculus app.
    • You can also choose to have Friend surpassed notifications if the leaderboard is user-facing. This means notifications are sent by Oculus to a user when a friend passes their score.

Select Submit when finished to save the leaderboard.

You can update leaderboard settings at any time in the Developer Center. You may also clear the results in a leaderboard and reset the scores.

Leaderboard Best Practices

To help increase engagement with your leaderboards, follow these best practices:

  • Set a user-friendly display title for the leaderboard in addition to the API name.
  • To reach a broader market, provide translations for your display title.
  • Make sure your leaderboard is public by checking the toggle on the leaderboard page if you want Oculus to provide notifications and social stories for this leaderboard
  • Create a destination for the leaderboard, and associate it with your leaderboard. If you provide a destination, you can deep link users directly into the right level of your app, to jump into the action and challenge a friend’s leaderboard score that they’ve just seen at the platform level.

Edit a Leaderboard

You can edit any of a leaderboard’s properties except its API Name. This means you can add translations and social feature after you have created it. To edit a leaderboard:

  • Go to the Developer Dashboard > Manage > [Your App] > Platform Services > Leaderboards
  • Click the ellipses (...) button on the right hand side of the leaderboard you want to edit and choose View/Edit Details
  • Make the desired changes, such as adding languages and localized titles or enabling social features.
  • Click Submit to save the changes.

The following image shows an example of the Edit Leaderboard page.

create leaderboard

Integrating Leaderboards

Once you’re finished creating the achievements, you can begin to integrate them in your game. When calling the SDK methods in this section use the API Name you defined in the Developer Center.

Detail about each function can be found in the Platform SDK Reference Content.

Retrieve a list of leaderboard entries:

ovr_Leaderboard_GetEntries()

Retrieves an array of leaderboard entries for a specified leaderboard.

Retrieve a list of leaderboard entries after a rank:

ovr_Leaderboard_GetEntriesAfterRank()

Retrieves a list of entries starting after a rank that you define. For example, if you specify a list with an ‘afterRank’ of 10, you’ll get a list starting with the 11th position.

Retrieve the next list of entries:

ovr_Leaderboard_GetNextEntries()

Retrieves the next group of leaderboard entries. This can be used to paginate the leaderboard data.

Retrieve the previous list of entries:

ovr_Leaderboard_GetPreviousEntries()

Retrieves the previous group of leaderboard entries. This can be used to paginate the leaderboard data.

Write leaderboard entry:

ovr_Leaderboard_WriteEntry()

This method will write a new leaderboard entry to a specified leaderboard for the current user. It is not an incremental update, it will overwrite the existing entry.

Get the total number of leaderboard entries

ovr_LeaderboardEntryArray_GetTotalCount()

Use this method to get the total number of entries in the leaderboard so that you can show a users rank within the total number of entries. For example, use this method to display that a user is number 50 out of 200 entries.

Implement a Leaderboard

To implement leaderboards, there are two different processes.

  1. Retrieve and Display Leaderboards - Display the current leaderboard state before a game begins. For example, ovr_Leaderboard_GetEntries for a native app . There are other methods you can use to get a subset of leaderboard entries based on input criteria.

  2. Update Leaderboard Entries - Write the results of the current game to your leaderboard. For example, ovr_Leaderboard_WriteEntry for a native app . A user may only have one entry on each leaderboard, subsequent entries will overwrite the existing entry on the specified leaderboard.

Implementation Tips

When implementing leaderboards, there are two common scenarios you should be aware of. They are:

  • To retrieve leaderboard entries centered around the current user, use the LeaderboardStartAt enum to define where the values returned start or are centered. To retrieve only the current user, center on the viewer and limit results returned to 1.
  • To return only the user’s friends, you can use the LeaderboardFilterType enum to define the results returned.

Server to Server Messages

You may need to manipulate a leaderboard from your trusted server. For details on leaderboard server-to-server APIs, see Leaderboard Server to Server APIs.