Get the SDK¶
Connect your game to LEADR using an SDK or the REST API. SDKs handle authentication, sessions, and token management automatically so you can focus on your game.
Prerequisites¶
- Download and install the LEADR app
- A LEADR account:
- Register
- Join a team
- Create a game
- Create a board
Choose Your Platform¶
The LEADR Godot SDK provides a native GDScript plugin for Godot 4.x.
Install from the GitHub repository:
- Open the latest release of the LEADR Godot SDK on GitHub: https://github.com/LEADR-official/leadr-sdk-godot/releases
- Download the
.zipcontaining the SDK code and unzip to a temporary location (or clone the repo if you prefer) - Copy the entire
leadrdirectory from the unzippedaddonsdirectory into theaddonsdirectory of your Godot project - Open your Godot project
The LEADR Unity SDK provides a C# package for Unity 2021.3+.
Install from GitHub via Package Manager:
- Open Window > Package Manager
- Click + > Add package from git URL
- Enter:
https://github.com/LEADR-Official/leadr-sdk-unity.git?path=Packages/com.leadr.sd
Using a different engine, language, or custom setup? The REST API works from anything that speaks HTTP.
For the full list of available and planned SDKs, see the SDKs overview.
SDK vs REST API¶
| Feature | SDK | REST API |
|---|---|---|
| Authentication | Automatic | Manual |
| Session management | Automatic | Manual |
| Token refresh | Automatic | Manual |
| Nonce handling | Automatic | Manual |
| Platform-specific | Yes | No |
Use an SDK if one exists for your engine. It handles all the authentication complexity automatically.
Use the REST API if you're using an unsupported engine, building a custom integration, or need full control over the HTTP layer.
What's Next¶
- Use LEADR in your game - Integrate the LEADR SDK into your game code and scenes
Need Help? The LEADR team and community is always happy to help on the LEADR Discord