Unity SDK

Requirements

• Unity 6000.6. Older versions have not been tested.
• The Input System package 1.20.0 and the UI Toolkit module (the package lists both as dependencies).
• C# 9 and .NET Standard 2.1, Mono or IL2CPP, managed code stripping at Minimal.
• Desktop players: macOS (universal), Windows (x64) and Linux (x64). Dedicated servers: Linux (x64).

Install

1. Add the package com.gameway.sdk to your project: Window, Package Manager, +, Add package from tarball… and choose the file you were given, or add "com.gameway.sdk": "file:<path>/com.gameway.sdk" to Packages/manifest.json for a package on disk.
2. Open Edit, Project Settings, Gameway. Enter the app id from the developer portal (the number next to your app's name), look at the default overlay hotkey, and press Validate.
3. Build. The build checks warn about hotkey collisions and fail a build whose target has no native library.

The package carries three native libraries, one per desktop platform, that it loads by itself. Never replace them by hand: they are built together with the C# bindings, and the SDK refuses to run in a development build when the two disagree.

Start and stop

Initialise once, from the main thread, when your game starts. Everything below must be called from that same thread.

using Gameway.Sdk;
using GW = Gameway.Sdk.Gameway;

public class PlatformBootstrap : UnityEngine.MonoBehaviour
{
    void Start()
    {
        GwResult r = GW.Init();   // the app id and options come from Project Settings
        if (r == GwResult.NotLaunchedByClient)
        {
            // started by double-click instead of by the app: show "restart via Gameway" and offer it
            bool quitNow;
            GW.RestartAppIfNecessary(GW.AppId, out quitNow);
            if (quitNow) UnityEngine.Application.Quit();
            return;
        }
        if (r.IsError()) UnityEngine.Debug.LogWarning("Gameway SDK: " + r.CodeName());

        GW.ConnectionStateChanged += (now, before, why) => UnityEngine.Debug.Log("connection: " + now);
        GW.TicketReady += e => { byte[] ticket = e.Payload; /* hand it to your connection code */ };
    }

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

• Init() reads your app id from Project Settings. Init(appId) passes it yourself.
• NotLaunchedByClient means the game was started without the app. Ask the player to restart it through the app; RestartAppIfNecessary does that.
• In the Editor the SDK runs in a developer mode that uses your own signed-in client; it never counts as an integration check on the portal.
• The package pumps its own events from the Unity player loop every frame. Your code only subscribes.

What you can call

Result codes

Every call returns a GwResult. Ok and the positive values are successes (Pending means the answer comes as an event, NoData means there is nothing to return). Negative values are errors: NotInitialized, WrongThread, Offline, NotOwned, RateLimited, NotFriend, NotJoinable, Denied, the Ticket… family and Internal. CodeName() gives the stable name for your logs.

Builds

• A dedicated-server build (UNITY_SERVER) compiles the Runtime and Server assemblies only. The overlay is never part of it.
• Headless players (-batchmode -nographics) run without the overlay.
• On macOS, if you re-sign the app yourself, sign with codesign --deep so the library keeps a valid signature. The package can check an output with -executeMethod Gameway.Sdk.Editor.GamewayBuildChecks.VerifyMacBundleCli -gwApp <path to the .app>.

Samples

• NGO ticket approval: Netcode for GameObjects connection approval with launch tickets, from throttling to online redemption with a pending approval.
• Overlay demo: initialisation, pausing your input while the overlay is open, the effective hotkey, rich presence and friends.

Import them from the package's entry in the Package Manager.