Skip to main content

Before You Start

Please complete the following setup process before you start with Leaderboard SDK

Step 1: Contact Myria Admin​

Before diving into the integration, make sure to reach out to the Myria admin team. You can contact us via our Telegram support channel, email, or Zendesk. We will provide you with detailed information and guidance about the leaderboard.

Step 2: Request the Developer API Key​

Once you're familiar with the leaderboard features, request a Developer API key from the Myria admin through the whitelist process available here. Upon successful whitelisting, you will be granted the Developer API key. This key is essential for accessing and managing leaderboards via the SDK.

Step 3: Safeguard Your API Key​

As a developer, it's important and your responsibility to keep the Developer API key secure. Store it safely in your local notes or a secure location. In case if you lose your Developer API key, you'll need to contact Myria admin to request a new one.

  • For the MVP version, the API key management will be handled manually.
  • In future updates (Post MVP), we plan to introduce features that allow developers to invalidate or regenerate their API keys.

Important Note: If your Developer API key is compromised, immediately contact Myria admin to regenerate a new key. Prompt action is crucial to prevent unauthorized access, which could lead to data breaches and disruption of player scores.

Step 4: Install and Initialize the SDK​

After obtaining your Developer API key, you’re ready to install the @myria/leaderboard-ts-sdk. Use this key to initialize the SDK and begin integrating leaderboard functionality into your game.