Docs/Getting Started/SDK Installation

SDK Installation

Install the Ilara SDK for your game engine — Unity, Unreal Engine, Godot, or any platform via REST API.

5 min read

Unity SDK

The Unity SDK supports Unity 2020.3 LTS and newer, with both Mono and IL2CPP scripting backends.

Method 1: Unity Package Manager (Recommended)

Add the package via git URL in your manifest.json:

Packages/manifest.json

json

{
  class="code-string">"dependencies": {
    class="code-string">"com.ilara.sdk": class="code-string">"https:class="code-commentclass="code-string">">//github.com/ilara/unity-sdk.git"
  }
}

Or use the Package Manager UI: Window > Package Manager > + > Add package from git URL

Method 2: Manual Import

Download the latest release from GitHub
Import the .unitypackage into your project
The SDK will be in Assets/Ilara/

Configuration

Create a configuration asset: Assets > Create > Ilara > Config

Config Properties

csharp

class=class="code-string">"code-comment">// IlaraConfig ScriptableObject
apiKey = class="code-string">"pk_live_your_key"    class=class="code-string">"code-comment">// Required
baseUrl = class="code-string">"https:class="code-commentclass="code-string">">//api.ilara.ai"  // Default
debugMode = false               class=class="code-string">"code-comment">// Enable console logging
cacheFlags = true               class=class="code-string">"code-comment">// Cache feature flags locally
flagCacheDuration = 300         class=class="code-string">"code-comment">// Cache TTL in seconds
autoTrackSessions = true        class=class="code-string">"code-comment">// Auto track session events
eventBatchSize = 10             class=class="code-string">"code-comment">// Events per batch
eventFlushInterval = 30         class=class="code-string">"code-comment">// Seconds between flushes

Platform Support: iOS, Android, Windows, macOS, Linux, WebGL

Unreal Engine SDK

The Unreal SDK supports Unreal Engine 5.0+ with both C++ and Blueprint access.

Method 1: Copy to Plugins (Recommended)

bash

# Clone the SDK to your Plugins folder
git clone https:class=class="code-string">"code-comment">//github.com/ilara/unreal-sdk.git YourProject/Plugins/Ilara
 
# Regenerate Visual Studio/Xcode project files
# In Unreal Editor: File > Generate Visual Studio Project Files
 
# Enable the plugin
# Edit > Plugins > Search class="code-string">"Ilara" > Enable

Method 2: Engine Plugin

For use across multiple projects, copy to your engine installation:

bash

cp -r Ilara Engine/Plugins/Marketplace/Ilara

Configuration

Configure in Project Settings > Plugins > Ilara:

Setting	Description	Default
API Key	Your Ilara API key	(required)
Game ID	Optional game identifier	(auto-generated)
Base URL	API endpoint	https://api.ilara.ai
Debug Logging	Enable verbose logs	false
Auto Track Sessions	Track session start/end	true
Event Batch Size	Events per batch	50
Event Flush Interval	Seconds between sends	30

Godot SDK

The Godot SDK supports Godot 4.0+ with both GDScript and C# support.

Installation

bash

# Clone to your addons folder
git clone https:class=class="code-string">"code-comment">//github.com/ilara/godot-sdk.git addons/ilara
 
# Or add as a git submodule
git submodule add https:class=class="code-string">"code-comment">//github.com/ilara/godot-sdk.git addons/ilara

Enable the plugin: Project > Project Settings > Plugins > Ilara > Enable

Configuration

Initialize in your main scene

gdscript

extends Node
 
func _ready() -> void:
    # Basic initialization
    Ilara.initialize(class="code-string">"pk_live_your_key")
 
    # Or with custom settings
    Ilara.initialize(
        class="code-string">"pk_live_your_key",
        class="code-string">"",  # Game ID(optional)
        class="code-string">"https:class="code-commentclass="code-string">">//api.ilara.ai"  # Custom base URL(optional)
    )

REST API

Use the REST API directly for any platform without SDK support, or for server-side integration.

Base URL

Environment	Base URL
Production	`https://api.ilara.ai/v1`
Development	`http://localhost:18000/v1`

Authentication

Include your API key in the X-API-Key header:

cURL Example

bash

curl -X POST class="code-string">"https:class="code-commentclass="code-string">">//api.ilara.ai/v1/events/events" \
  -H class="code-string">"X-API-Key: pk_live_your_key" \
  -H class="code-string">"Content-Type: application/json" \
  -d '{
    class="code-string">"player_id": class="code-string">"player-uuid",
    class="code-string">"event_name": class="code-string">"level_complete",
    class="code-string">"properties": {
      class="code-string">"level": 5,
      class="code-string">"score": 12500
    }
  }'

Client Libraries

We provide example clients for common languages:

Python — requests-based client
Node.js — fetch-based client
Go — net/http client

Verify Installation

After installation, verify the SDK is working:

Unity Verification

csharp

async void Start()
{
    await IlaraClient.Instance.Initialize();
 
    class=class="code-string">"code-comment">// Check initialization
    Debug.Log($class="code-string">"Ilara initialized: {IlaraClient.Instance.IsInitialized}");
 
    class=class="code-string">"code-comment">// Track a test event
    IlaraClient.Instance.TrackEvent(class="code-string">"sdk_test", new {
        test = true,
        timestamp = DateTime.UtcNow.ToString(class="code-string">"o")
    });
 
    class=class="code-string">"code-comment">// Force send
    await IlaraClient.Instance.FlushEvents();
 
    Debug.Log(class="code-string">"Test event sent! Check your dashboard.");
}

Verification Checklist

SDK initializes without errors
Test event appears in Dashboard > Events > Live Stream
No network errors in console/logs

Next Steps

Quick Start Guide — Track your first real events
Unity SDK Reference — Complete Unity API docs
Unreal SDK Reference — Complete Unreal API docs
Godot SDK Reference — Complete Godot API docs

Understanding Events

Events & Properties