Installation

If you haven't created a project in the Gamebeast dashboard yet, please start with the Getting Started guide.

Installing the SDKCopy Anchor Link

In Unity, open Window → Package Manager, press + and choose Add package from git URL, then paste:

https://github.com/GamebeastGG/UnitySDK.git

The source is on GitHub. Gamebeast will soon be available on the Unity Asset Store as well.

Start the SDK and Configure API KeyCopy Anchor Link

The next step of getting your data on the Gamebeast dashboard is to start the SDK and configure your API key.

To start the SDK, you'll need to add the following code to a script in your project:

using UnityEngine;
using Gamebeast;

public class GamebeastStarter : MonoBehaviour
{
    void Start()
    {
        GamebeastSdk.Setup("abcd-efgh-1234-5678");
    }
}

Alternatively, the SDK can start itself with no setup code:

1. Create a settings asset via "Assets > Create > Gamebeast > Settings".
2. Fill in your API key in the inspector.
3. Place the asset at Resources/GamebeastSettings in your project.

Creating an API keyCopy Anchor Link

The SDK uses an SDK Key — a public key scoped to a single project that's safe to ship inside your game.

Create it from the project's Connect SDK page in the dashboard (it opens right after you create a project, and stays in the sidebar until your first event arrives). The page fills the key into the snippet above, so you can copy it as-is. Otherwise, replace the placeholder:

GamebeastSdk.Setup("abcd-efgh-1234-5678"); // Replace with your API key.

Press Play. The Connect SDK page shows Connected once the first event arrives, usually within 30 seconds.