Install

The SDK is a Unity package, com.pairiquium.sdk. Install it with OpenUPM or from a git URL. It needs Unity 2021.3 LTS or newer.

OpenUPM (recommended)

With the OpenUPM CLI, run this from your project folder:

openupm add com.pairiquium.sdk

Or add the scoped registry to Packages/manifest.json yourself:

{
  "scopedRegistries": [
    {
      "name": "package.openupm.com",
      "url": "https://package.openupm.com",
      "scopes": ["com.pairiquium.sdk"]
    }
  ],
  "dependencies": {
    "com.pairiquium.sdk": "1.2.0"
  }
}

You can also add the same registry in Edit → Project Settings → Package Manager → Scoped Registries, then add the package by name from the Package Manager window.

Git URL

In Window → Package Manager, choose + → Add package from git URL and enter:

https://github.com/Pairiquium/UnitySDK.git?path=/package#v1.2.0

The #v1.2.0 pins a release. Use the tag of the version you want.

Dependencies

Installing the package also installs com.unity.nuget.newtonsoft-json, which the SDK uses for JSON. Nothing else is added to your project.

The samples are the one exception: they need the Unity Input System package (com.unity.inputsystem), which is not installed with the SDK. See Samples & Troubleshooting.

Updating and pinning

Every release is tagged in the GitHub repository and described in the changelog. The SDK follows semantic versioning, and each release implements a specific version of the API Specs. Keep the version in manifest.json (or the git tag) pinned so an update only happens when you choose it.

Check it worked

The package should appear in the Package Manager as Pairiquium Matchmaking SDK, and you should be able to add using Pairiquium.Unity; to a script without a compile error.

Don't want the package?

The core of the SDK is plain C# with no Unity references, shipped as source. You can read it, copy it, or port it to another engine. See Custom Providers & Platforms.