Skip to main content

Setup for Windows

Introduction#

The Windows version of the Antidote SDK is compatible with various Unity versions:

  • Unity 6: fully supported
  • LTS 2023: fully supported
  • LTS 2022: fully supported
  • LTS 2021: fully supported
  • LTS 2020: fully supported
  • LTS 2019 and older versions might be supported, but these haven't been officially tested

Setup#

Unity#

Here's how to integrate the Antidote SDK with your Unity game on Windows:

  1. Download the latest version of the Antidote SDK.
  2. Make sure you have TextMesh Pro (TMPro) installed.
    note

    You can check this in Unity's Package Manager by searching for TextMeshPro. See the "Tips & Troubleshooting" section below for detailed instructions.

  3. When the TMP Importer window appears, import TMP Essentials.
  4. Go to Assets/Import Package/Custom Package....
  5. Select the Antidote SDK file you downloaded: unity/antidote-sdk.unitypackage).
  6. Click Import.
  7. Go to Assets/AntidoteSDK/Scenes in the Project Explorer.
  8. Open the AntidoteSetup scene.
    Project Explorer
  9. Go to File/Build Settings....
  10. Click Add Open Scenes.
    Build Settings
  11. Ensure the AntidoteSDK scene is at the top of the list. If not, drag it to the top.
    Setup Object
  12. Close the window.
  13. Configure the features you want to use from Antidote SDK.
  14. Go to the AntidoteSetup/Setup object.
  15. On the Setup object, mark the features you want to enable/disable.
    Configure features
  16. (Optional) On the Watermark Prefab, edit the features to your preference.
    Configure watermark features

Watermark Settings#

When you select the Watermark Prefab:

Configure watermark features

You will have access to the following settings:
FeatureDescription
SpeedAdjusts the speed of the ticker(s) across the display.
Change Position TimerSets the interval before the watermark behavior updates. Relevant for Ticker, DVD, and Random behaviors.
BehaviorSelects the watermark behavior to display.

Game Events#

Events can be emitted during gameplay to track once-off events, and the duration of long-running events. These can be viewed on the session recording. To send events you can either:

  1. Create a new C# script alongside the script(s) that need to call it
  2. Create an assembly reference to the AntidoteSDK assembly

Game Events (custom script)#

Add the following script in the same folder as the scripts that need to call it:

using UnityEngine;
using System.Runtime.InteropServices;
public static class AntidoteService
{
[DllImport( "antidote", CallingConvention = CallingConvention.Cdecl )]
private static extern void Antidote_sendEvent( [MarshalAs( UnmanagedType.LPWStr )] string action_value, [MarshalAs( UnmanagedType.LPWStr )] string event_value );
public static void SendEvent(string action, string eventName) {
Antidote_sendEvent(action, eventName);
}
}

Then, to emit an event:

AntidoteService.SendEvent("action", "eventName");

Game Events (assembly reference)#

  1. open the assembly definition in the folder where it needs to be called
    Open assembly definition
  2. scroll down to Assembly Definition References
  3. click on +
    Add assembly reference
  4. click on the dot icon where it says (Missing Reference)
    Select AntidoteSDK
  5. double click on AntidoteSDK

Then, to emit an event add the following to your code:

using AntidoteSDK;
...
AntidoteSDK.Antidote.SendEvent("action", "eventName");

Game Events Data structure#

All game events consist of an action and an event name, where action can be one of the following:

ActionDescription
startmark the start of a long-running event (e.g. boss_battle)
endmark the end of a long-running event (e.g. boss_battle)
onceemit a once-off event (e.g. collected_powerup)

Tips & Troubleshooting#

How to Install TMPro on Unity 2023 and older#

TextMeshPro is essential for the Watermark text elements to work. Here's how to install it:

  1. Open the Package Manager and ensure you're on the Unity Registry.
  2. Search for TextMeshPro or locate it manually.
  3. Click Install. If it's already installed, you'll see Remove or Update.
  4. If the TMP Importer appears, click Import TMP Essentials. You don't need to import TMP Examples & Extras.
note

If the Watermark has broken references due to TMPro missing, reimporting the AntidoteSDK Package will fix it after following the above steps.

How to Install TMPro on Unity 6#

TextMeshPro is essential for the Watermark text elements to work. Here's how to install it:

  1. Open the Package Manager and ensure you're on the Unity Registry.
  2. Search for Unity UI or locate it manually.
  3. Click Install. If it's already installed, you'll see Remove or Update.
  4. If the TMP Importer appears, click Import TMP Essentials. You don't need to import TMP Examples & Extras.
note

If the Watermark has broken references due to TMPro missing, reimporting the AntidoteSDK Package will fix it after following the above steps.

Edit this page