Installing the SDK

Installing the Theymes Unity SDK is a straightforward process. You can either install the SDK from Git or from a tarball. Theymes Unity SDK is distributed as an UPM package and it can be installed either using Git URL or from a tarball. To install the package follow these steps:

Open UPM
Git URL
Tarball

For instructions on how to use OpenUPM refer to the OpenUPM documentation. You can either configure OpenUPM directly in the Unity Editor or use their CLI in terminal. The CLI is the easiest method as it automatically sets up the scoped registry automatically and it can automatically detect the latest version.The Theymes SDK OpenUPM package can be found here: https://openupm.com/packages/com.theymes.sdk/To install the Theymes SDK with the CLI, simply use this command in your terminal while in the project root:

openupm add com.theymes.sdk

If you want to install without the CLI, follow the instructions of the OpenUPM documentation.

You can see the available releases in the Theymes Unity SDK Github repository.

Open the Package Manager window (Window > Package Manager).
Click the + button in the top left corner and select Add package from git URL....
Enter the Git URL with the desired release as the URL, eg: https://github.com/theymes/theymes-unity-sdk.git#v1.1.5
Click Add.

For more information about installing an UPM package from Git URL, see the official Unity documentation.

Download the desired SDK version from https://github.com/theymes/theymes-unity-sdk/releases
Put the SDK tarball (for example com.theymes.sdk-1.1.5.tgz) in your project’s Packages directory.
Open the Package Manager window (Window > Package Manager).
Click the + button in the top left corner and select Add package from tarball....
Select the tarball you downloaded.
Click Open.

For more information about installing an UPM package from tarball, see the official Unity documentation.You should commit the tarball to your version control repository so it is available for other developers in your team.

Initializing the SDK

To initialize the SDK you must call TheymesSdk.Initialize() method in Awake() of your first scene. Create a new file TheymesSdkInitializer.cs and add the following code to it:

TheymesSdkInitializer.cs

using UnityEngine;
using Theymes;

public class TheymesSdkInitializer : MonoBehaviour
{
    void Awake()
    {
        TheymesSdk.Initialize("<token>", "<domain>");
    }
}

Replace <token> with your game token and <domain> with your game domain. You can find these from your game settings in the Theymes application. Next add a new GameObject to your first scene by clicking GameObject > Create Empty. Name the game object as TheymesSdkInitializer and select it from the Hierarchy panel. Next attach the TheymesSdkInitializer.cs script to the game object by dragging it from the Project panel to the GameObject in the Inspector panel. You are now ready to use the SDK!

If you already have another script to do initialization in your scene, you can add the SDK initialization code there instead.

Next steps

To verify that everything is working correctly, you can try to open the help center by calling TheymesSdk.OpenSupport() method. If you have initialized the SDK correctly with valid token and domain, the help center should open. On Windows, macOS, Linux, and in the Unity Editor, the SDK opens the public support site in the system browser.

Example

using UnityEngine;
using Theymes;

public class SupportButtonAction : MonoBehaviour
{
    public void OnButtonClick()
    {
        TheymesSdk.OpenSupport();
    }
}

Get started

Player metadata

API

Installing the SDK

Initializing the SDK

Next steps

​Initializing the SDK

​Next steps

Initializing the SDK

Next steps