Heathen Engineering

Install the Discord Social SDK

// Config: Engine - [], Toolkit - [v1.0.0]

Foundation for Discord Social is a layer on top of Discord’s own Social SDK. Discord distributes that SDK under its own terms and does not permit it to be redistributed inside other packages, so Heathen packages do not include it. You download it from Discord and add it to your project once.

Until the SDK is installed the Foundation compiles nothing, which means no compiler errors and no missing reference warnings. A window tells you what is missing, and it closes by itself when the SDK arrives. Scenes and prefabs that use Discord Social components show missing scripts until then and recover on their own afterwards.

Requirements #

  • Discord Social SDK 1.10.0 or newer, installed as the package com.discord.partnersdk.
  • Heathen Game Framework (com.heathen.gameframework), free and Apache-2.0. Heathen Toolbox installs it for you.
  • Unity 6000.0 or newer.

Steps #

  1. Create or open your application in the Discord Developer Portal and enable the Social SDK for it. Note the Application Id.
  2. Download the Unity plugin from the Discord Social SDK overview.
  3. Unpack it to a folder outside your Assets folder. The folder must contain a package.json whose name is com.discord.partnersdk.
  4. In Unity open Window, Package Manager, choose Add package from disk, and pick that package.json.
  5. Open Project Settings, Subsystems, Discord Social and enter your Application Id.

Install it as a package, not by copying its files into Assets. The Foundation detects the SDK through the package manifest, so an Assets copy is not seen.

Platforms #

The SDK supports Windows, macOS, Linux, Android and iOS. Voice noise processing (Krisp) ships with the SDK as extra native files and models that its own Editor scripts manage. On Android the SDK needs the External Dependency Manager for the AndroidX dependency it declares.

Checking the install #

Choose Help, Heathen, Discord Social, Check Dependencies to see what is installed. The Foundation also checks on every domain reload.

Terms #

Your use of the Discord Social SDK is governed by Discord’s developer terms and policies. Read them before you ship.

Next: Foundation for Discord Social.

Rate This Article!

Contents