¶ Overview
The following is a step-by-step guide on how to set up and manage various SDK features.
¶ Leaderboard
The Leaderboard API enables developers to create and manage leaderboards for their games, which allow players to compete with each other and compare their scores.
¶ Create a Leaderboard
To create a new leaderboard, navigate to 'APIs tab' of the game-edit-screen in the developer dashboard and click on the 'Create Leaderboard' button next to the 'Leaderboards' header
A new screen will appear where you will need to input the following information about your new item:
- Name
- ID
- Reset Interval
- Type selection
- Ascending = “Lowest score wins”, e.g. a time based leaderboard.
- Descending = "Highest score wins", e.g a point based leaderboard.
- Sum = "Highest all-time score wins”, e.g. a grind based leaderboard.
After you have created your leaderboard by clicking on the 'Create Leaderboard' button, your new leaderboard will show up under the 'Leaderboards' header of the 'APIs Tab'.
¶ Edit a Leaderboard
To Edit a leaderboard, click on the green 'Edit' icon under 'Actions'.
A new screen will appear where you are able to change the leaderboard setting.
This screen also shows the following additional information about your leaderboard:
- Total Scores
- Highest Scores
- Last Posted Scores
- Creation Date
- Lasst Modification Date
- An overview of all Posted Scores to you leaderboard.
¶ Reset a Leaderboard
To Reset a leaderboard, click on the orange 'Reset' icon under 'Actions'.
A new Modal will appear, asking whether you are sure you want to reset this leaderboard, as this action can not be reversed.
To proceed, type the "name of your leaderboard" in the field, and confirm that you want to reset your leaderboard. A notification will show that the leaderboard has been succesfully reset.
¶ Delete a Leaderboard
To Delete a leaderboard, click on the red 'Delete' icon under 'Actions'.
A new Modal will appear, asking whether you are sure you want to delete this leaderboard, as this action can not be reversed.
To proceed, type the "name of your leaderboard" in the field, and confirm that you want to delete your leaderboard. A notification will show that the leaderboard has been succesfully deleted.
¶ Inventory
The Inventory API enables developers to store, manage and access items for their games and allow players to unlock and/or purchase these items.
¶ Create a Catalog Item
To create a new catalog item, navigate to 'APIs tab' of the game-edit-screen in the developer dashboard and click on the 'Create Item' button next to the 'Inventory' header
A new screen will appear where you will need to input the following information about your new item:
- Name
- ID
- Price (except when being unlocked by performing a specific action)
- 3D model (optional, relative URL to asset; for future use in user profile)
- Class (optional, to help organizing if you have many items)
- Type selection
- Singular i.e., unique items.
- Stackable i.e., items of which a player can own more than one.
- Status
- Expiration Date
After you have created your new catalog item by clicking on the 'Create Item' button, your new item will show up under the 'Inventory' header of the 'APIs Tab'.
¶ Edit a Catalog Item
To Edit a Catalog Item, click on the green 'Edit' icon under 'Actions'.
A new screen will appear where you are able to change the item setting.
¶ Delete a Catalog Item
To Delete a catalog item, click on the red 'Delete' icon under 'Actions'.
A new Modal will appear, asking whether you are sure you want to delete this item, as this action can not be reversed.
To proceed, confirm that you want to delete your item. A notification will show that the item has been succesfully deleted.
¶ Matchmaking
You can create and configure rooms for your game if you decide to provide multiplayer functionality. You can access these rooms via our SDK. Players can join these rooms for a multiplayer experience.
¶ Create a Room
To create a new room, navigate to 'APIs tab' of the game-edit-screen in the developer dashboard and click on the 'Create Room' button next to the 'Matchmaking' header
A new screen will appear where you will need to input the following information about your new item:
- Name
- Slug i.e. Unique identifier for your room
- Max. Players
- Status
- Whether it is Public or Private
¶ Edit a Room
To Edit a room, click on the green 'Edit' icon under 'Actions'.
A new screen will appear where you are able to change the room setting.
¶ Delete a Room
To Delete a room, click on the red 'Delete' icon under 'Actions'.
A new Modal will appear, asking whether you are sure you want to delete this room, as this action can not be reversed.
To proceed, confirm that you want to delete your room. A notification will show that the room has been succesfully deleted.