Pilot SDK for Unity

Remote debug panel, logging, and metrics for Unity applications.

Requirements

• Unity 2020.3+
• .NET Standard 2.1 or .NET Framework 4.x

Installation

Unity Package Manager (Git URL)

Add the following to your Packages/manifest.json:

{
  "dependencies": {
    "com.pilot.sdk": "https://github.com/irov/unitypilot.git"
  }
}

Or in Unity Editor: Window → Package Manager → + → Add package from git URL and enter:

https://github.com/irov/unitypilot.git

Quick Start

using Pilot.SDK;
using UnityEngine;

public class PilotSetup : MonoBehaviour
{
    void Awake()
    {
        // 1. Initialize
        var config = new PilotConfig.Builder("https://pilot.example.com", "plt_your_token")
            .SetDeviceId("my-device")
            .SetDeviceName("Unity Editor")
            .Build();
        PilotSDK.Initialize(config);

        // 2. Build UI
        PilotUI ui = PilotSDK.GetUI();
        PilotTab tab = ui.AddTab("Game Controls");
        PilotLayout root = tab.Vertical();

        root.AddButton("Restart")
            .Variant("contained").Color("error")
            .OnClick(action => {
                Debug.Log("Restart clicked!");
                PilotSDK.AcknowledgeAction(action.Id);
            });

        root.AddStat("FPS")
            .Unit("fps")
            .ValueProvider(() => (1f / Time.unscaledDeltaTime).ToString("F0"));

        root.AddSwitch("God Mode")
            .DefaultValue(false)
            .OnChange(action => {
                bool value = action.Payload?.GetBool("value") ?? false;
                Debug.Log("God mode: " + value);
            });

        // 3. Send logs
        PilotSDK.Log(PilotLogLevel.Info, "Game started");

        // 4. Connect (if autoConnect is false)
        // PilotSDK.Connect();
    }

    void OnDestroy()
    {
        PilotSDK.Shutdown();
    }
}

Features

Remote UI Panel

Build interactive panels with declarative widget builders:

PilotUI ui = PilotSDK.GetUI();
PilotTab tab = ui.AddTab("Controls");
PilotLayout root = tab.Vertical();

// Buttons
root.AddButton("Action").OnClick(action => DoAction());

// Labels with dynamic providers
root.AddLabel("Status: Idle")
    .TextProvider(() => "Status: " + currentStatus);

// Stat displays
root.AddStat("Memory").Unit("MB")
    .ValueProvider(() => (GC.GetTotalMemory(false) / 1048576.0).ToString("F1"));

// Toggle switches
root.AddSwitch("Debug Mode").DefaultValue(false)
    .OnChange(action => debugMode = action.Payload?.GetBool("value") ?? false);

// Text inputs
root.AddInput("Command")
    .Placeholder("Type a command...")
    .OnSubmit(action => ExecuteCommand(action.Payload?.GetString("value")));

// Select dropdowns
root.AddSelect("Level")
    .Options(new[] {
        new[] { "1", "Level 1" },
        new[] { "2", "Level 2" },
        new[] { "3", "Level 3" }
    })
    .DefaultValue("1")
    .OnChange(action => LoadLevel(action.Payload?.GetString("value")));

// Nested layouts
PilotLayout row = root.AddHorizontal();
row.AddButton("A").OnClick(action => DoA());
row.AddPadding(1.0);
row.AddButton("B").OnClick(action => DoB());

// Collapsible sections
PilotLayout debug = root.AddCollapsible("Debug Options");
debug.AddButton("Clear Cache").OnClick(action => ClearCache());

Logging

PilotSDK.Log(PilotLogLevel.Info, "Player spawned");
PilotSDK.Log(PilotLogLevel.Warning, "Low FPS detected", "performance");
PilotSDK.Log(PilotLogLevel.Error, "Failed to load asset", new Dictionary<string, object> {
    { "asset", "player_model.fbx" },
    { "error_code", 404 }
});

Structured Events

PilotSDK.Event("level_complete", new Dictionary<string, object> {
    { "level", 5 },
    { "score", 12500 },
    { "time_seconds", 45.3 }
});

PilotSDK.ChangeScreen("gameplay", "Level 5");

Metrics

Built-in metrics collected automatically:

• FPS and frame time
• Memory (total allocated)
• Video memory (GPU driver allocated)
• Battery level and charging status

Add custom metrics:

PilotSDK.GetMetrics().Record(PilotMetricType.DrawCalls, Camera.main.GetDrawCallsCount());

// Custom metric type
var customMetric = PilotMetricType.Create("enemies_alive");
PilotSDK.GetMetrics().Record(customMetric, activeEnemies.Count);

Custom collectors:

public class GameMetricCollector : IPilotMetricCollector
{
    public void Collect(List<PilotMetricEntry> output)
    {
        output.Add(new PilotMetricEntry(PilotMetricType.DrawCalls, GetDrawCalls()));
    }
}

// In config
var metricConfig = new PilotMetricConfigBuilder()
    .SetEnabled(true)
    .SetSampleIntervalMs(200)
    .AddCollector(new GameMetricCollector());

var config = new PilotConfig.Builder(url, token)
    .SetMetricConfig(metricConfig)
    .Build();

In-App Purchases

// Publish product catalog
PilotSDK.SetInAppProducts(new List<Dictionary<string, object>> {
    new Dictionary<string, object> {
        { "product_id", "coins_100" },
        { "price", "$0.99" },
        { "title", "100 Coins" }
    }
});

// Track purchases
PilotSDK.PurchaseInApp("txn_123", new List<string> { "coins_100" });

Session Attributes

var sessionAttrs = new PilotSessionAttributeBuilder()
    .Put("app_version", Application.version)
    .Put("platform", Application.platform.ToString())
    .PutProvider("scene", () => UnityEngine.SceneManagement.SceneManager.GetActiveScene().name);

var config = new PilotConfig.Builder(url, token)
    .SetSessionAttributes(sessionAttrs)
    .Build();

Session Lifecycle

public class MySessionListener : IPilotSessionListener
{
    public void OnPilotSessionConnecting() => Debug.Log("Connecting...");
    public void OnPilotSessionWaitingApproval(string requestId) => Debug.Log("Waiting for approval");
    public void OnPilotSessionStarted(string sessionToken) => Debug.Log("Session active!");
    public void OnPilotSessionClosed() => Debug.Log("Session closed");
    public void OnPilotSessionRejected() => Debug.Log("Connection rejected");
    public void OnPilotSessionAuthFailed() => Debug.Log("Auth failed - check API token");
    public void OnPilotSessionError(PilotException e) => Debug.LogError("Error: " + e.Message);
}

var config = new PilotConfig.Builder(url, token)
    .SetSessionListener(new MySessionListener())
    .Build();

Configuration Reference

Parameter	Default	Description
baseUrl	required	Pilot server URL
apiToken	required	Project API token (plt_...)
deviceId	auto	Device identifier (defaults to SystemInfo.deviceUniqueIdentifier)
deviceName	auto	Device display name (defaults to model + Unity version)
pollIntervalMs	10000	Approval polling interval (ms)
actionPollIntervalMs	2000	Action polling interval (ms)
autoConnect	true	Connect automatically on Initialize()

License

MIT