The primary driver for the leaderboards are events. You can organize user scores per event, into an ordered, ranked list. To get started with the leaderboards, head to the Scill admin panel and click the Leaderboard menu item.
The Leaderboard overview contains all your previously created leaderboards.
Follow these steps to implement Leaderboards into your application:
|1||Create an app||
In the Admin Panel create an app, and API key for the app and create some challenges in the “Battle Pass” area of the Admin Panel. More info on this topic can be found in our Create Challenges section.
|2||Create a leaderboard||
Next, you need to create a leaderboard in the Admin Panel. Provide some data like a name, event type, sorting order, start and end date of the battle pass.
|3||Test in Playground||
In the app list in Admin Panel we provide a Playground button next to each app. Click on that button, and a new browser window will be opened with the Playground-Application. The Application settings have already been made for you and you can directly start playing around with the leaderboard you have created. More info on that topic in our Using Playground section.
We provide SDKs for many programming languages and platforms. Please consult the documentation on how to add the SDK to your application or game. Official SCILL SDKs.
Below the “Send Event” button in Playground you’ll see code generated for you that you just need to Copy & Paste in your applications source code. Just select your programming language and copy the code generated by Playground to your own codebase to send the same event from your code.
Depending on your settings, Challenges have rewards that users can claim. There are various different methods of unlocking rewards to the user, either by implementing real time notification into your client to handle unlocking in your app or game or Webhooks to unlock rewards from your backend (i.e. send a mail with a redeem code). More info in our Rewarding Users section.
Implement User Interfaces to show challenges to your users. We have built some examples for various different platforms. Check out our Github repository for example code or the Examples section of this documentation.
Setting up leaderboards
Creating your first leaderboard is quite simple. By clicking the Add Leaderboard button in the Leaderboards module. Each leaderboard needs a name, activity (to enable or disable it), a start and end date, ordering (ascending or descending), and the event type. The ordering defines how the leaderboard results are sorted, so the top players can be those who received the least damage, or, for example, those who made the most kills.
- This is the leaderboard name, for your convenience, to distinguish between multiple leaderboards. Keep it short and precise.
- This is used to enable or disable the leaderboard.
- Choose the sorting type, either ascending or descending. Ascending means the lowest scores will be at the top of the leaderboard, and the descending ordering means the highest scores will be ranked first.
- Start Date
- This is the date from which the events sent are counted towards the leaderboard scores.
- End Date
- This is the end date after which the events sent are no longer counted towards the leaderboard scores.
- Event Type
- The type of event that drives the leaderboard scores.
SCILL events are preconfigured for you. You can find the complete list of supported event types in our Supported Events list in this documentation.
Save the leaderboard. Congratulations, we just created our first leaderboard. That was simple, wasn’t it? Time to play around with the challenge in SCILL Playground Application.