Configure leaderboards
Leaderboards allow players to compare their scores against other players in the same game. When you configure leaderboards in App Store Connect, you specify details such as the scores to collect and how to order them. For each language you want a leaderboard to display in, you specify the leaderboard name, score format, and score unit. You can also include a localized image to illustrate the score in the leaderboard.
There are two types of leaderboards that can be created:
-
Classic leaderboards: A leaderboard where score data will never reset unless the leaderboard is deleted.
-
Recurring leaderboards: A leaderboard where score data will continually be reset based on set preferences.
You can create up to 500 leaderboards per app.
For development information, visit Leaderboards in GameKit.
Create a classic leaderboard
-
From My Apps, select the app you wish to enable for Game Center.
-
In the toolbar, click Services. The page opens with the Game Center tab selected.
-
Click the add button (+) in the Leaderboards section.
-
Select Choose next to Classic Leaderboard.
-
Input your leaderboard metadata. For more information, visit Leaderboard properties.
-
Leaderboard Reference Name
-
Leaderboard ID
-
Score Format Type
-
Score Submission Type
-
Sort Order
-
Score Range (Optional)
-
-
Under Leaderboard Localization, add one or more languages by clicking Add Language.
-
Enter the required information:
-
In the dialog that appears, choose a language from the Language menu.
-
In the Name field, enter a localized reference name for the leaderboard. For example, if you choose Finnish from the Language menu, enter the Finnish name for the leaderboard in the Name field.
-
Choose a localized score format from the Score Format menu.
-
Enter the singular and plural versions of your score format suffix. If Score Format Suffix Plural doesn’t appear, it’s not needed for the selected language. Additionally, if you want a space to appear between the score and the suffix, you can enter a space followed by the suffix text.
-
Optionally, you can click Choose File to add a localized image for your leaderboard.
-
Click Save.
To add additional language support for your leaderboards, repeat the above steps for each language.
-
-
Click Save.
Create a recurring leaderboard
Recurring leaderboards add flexibility to your leaderboard configuration by allowing you to reset your leaderboards’ scores. The ability to reset your leaderboards creates a more competitive gaming experience, as it allows players to set a new top score for each leaderboard recurrence.
Leaderboards have a minimum recurrence of five minutes, a maximum recurrence of 30 days, and aren't allowed to overlap.
-
From My Apps , select your app.
-
In the toolbar, click Services. The page opens with the Game Center tab selected.
-
Click the add button (+) in the Leaderboards section.
-
Select Choose next to Recurring Leaderboard.
-
Input your leaderboard metadata. For more information, visit Leaderboard properties.
-
Leaderboard Reference Name
-
Leaderboard ID
-
Score Format Type
-
Score Submission Type
-
Sort Order
-
Score Range (Optional)
-
Start Date and Time: The date and time when scores will begin posting to this leaderboard. The date and time are based on Coordinated Universal Time (UTC).
-
Duration: The length of time scores on this leaderboard will be posted.
-
Restarts Every: The frequency at which this leaderboard will be created.
-
-
Under Leaderboard Localization, add one or more languages by clicking Add Language.
-
Enter the required information:
-
In the dialog that appears, choose a language from the Language menu.
-
In the Name field, enter a localized display name for the leaderboard. For example, if you choose Finnish from the Language menu, enter the Finnish name for the leaderboard in the Name field.
-
Choose a localized score format from the Score Format menu.
-
Enter the singular and plural versions of your score format suffix. If Score Format Suffix Plural doesn’t appear, it’s not needed for the selected language. Additionally, if you want a space to appear between the score and the suffix, you can enter a space followed by the suffix text.
-
Optionally, you can click Choose File to add a localized image for your leaderboard.
-
Click Save.
To add additional language support for your leaderboards, repeat the above steps for each language.
-
-
Click Save.
Delete a leaderboard
The status of a leaderboard is displayed in the Status column of the Leaderboards table. The possible status values are described in Leaderboard Statuses. A Delete button appears in this column when a leaderboard is eligible for deletion. After a leaderboard is available in Game Center, it can’t be deleted.
Learn about archiving live leaderboards.
-
From My Apps, select your app.
-
In the toolbar, click Services. The page opens with the Game Center tab selected.
-
From the Leaderboard section, hold the pointer over the leaderboard you want to delete, then click the delete button.
-
Confirm the deletion, then click Save.