Discord Social SDK Integration¶

The Discord module wraps the Discord Social SDK so IntelliVerseX games get social features that support retention, growth, and community engagement. It connects your game systems (multiplayer, live-ops, leaderboards) with Discord’s social graph.

1. Overview¶

Components¶

2. Setup & Configuration (IVXDiscordConfig)¶

Prerequisites¶

1. Discord Developer Portal application and Application ID
2. Rich Presence art assets (e.g. 1024×1024 PNG) under Rich Presence → Art Assets
3. OAuth2 redirect URIs (desktop https://localhost, mobile custom URL scheme, console flows as applicable)
4. For communication scopes (DMs, lobbies, voice): apply for production access where required

Install the Discord Social SDK¶

The IntelliVerseX assembly defines INTELLIVERSEX_HAS_DISCORD when the package is present:

{
    "versionDefines": [
        {
            "name": "com.discord.social-sdk",
            "expression": "0.1.0",
            "define": "INTELLIVERSEX_HAS_DISCORD"
        }
    ]
}

Create the config asset¶

Assets → Create → IntelliVerseX → Discord Config → assign the asset to IVXDiscordManager.

Recommended GameObject layout¶

Attach Discord components to a persistent DontDestroyOnLoad object (subset as needed):

DiscordSocial (GameObject)
├── IVXDiscordManager
├── IVXDiscordPresence
├── IVXDiscordFriends
├── IVXDiscordLobby
├── IVXDiscordVoice
├── IVXDiscordInvites
├── IVXDiscordLinkedChannels
├── IVXDiscordMessages
├── IVXDiscordModeration
└── IVXDiscordDebug

IVXDiscordConfig fields¶

3. Account Linking¶

States¶

Basic OAuth2¶

using IntelliVerseX.Discord;

IVXDiscordManager.Instance.Initialize(config);
IVXDiscordManager.Instance.OnAccountLinked += (id, name) => { /* ... */ };
IVXDiscordManager.Instance.LinkAccount();

const discord = IVXDiscordSocial.getInstance();
await discord.initialize({ applicationId: '...' });
const user = await discord.linkAccount();

Entry-point linking from Discord¶

When the user starts linking from Discord, the client can request authorization:

mgr.OnAuthorizeRequested += () => ShowLinkUi();
mgr.RegisterAuthorizeRequestCallback(() => StartLinkFlowFromDiscord());
// When inappropriate (match, cutscene):
mgr.RemoveAuthorizeRequestCallback();

Mobile PKCE¶

Use the mobile OAuth2 + PKCE path with your app’s URL scheme (must align with MobileRedirectScheme / portal config):

mgr.StartMobileOAuth2Flow("mygame://", success => { /* ... */ });

Console device code¶

Display the code returned to the user on TV/console:

mgr.StartConsoleOAuth2Flow(
    code => ShowDeviceCodeUi(code),
    success => { /* ... */ });

Provisional accounts¶

mgr.CreateProvisionalAccount(ok => { if (ok) ContinueAsGuestSocial(); });

Merge later when you have a backend or OAuth token:

mgr.MergeProvisionalAccount(externalAuthToken, ok => { /* ... */ });

Publisher-level linking¶

• Set PublisherId on the config and/or call SetPublisherId(string) at runtime for cross-game shared authentication with Discord.

Token refresh / external browser¶

mgr.UpdateToken(newBearerToken);

4. Rich Presence¶

Basic activity¶

var p = IVXDiscordPresence.Instance;
p.SetActivity("Ranked Match", "Score: 1,500");
p.SetParty("lobby_abc", 2, 4, joinSecret: "secret_abc");
p.StartTimer();
p.SyncFromGameState(); // reads IVX game systems when implemented
p.ClearPresence();

Field URLs & asset URLs¶

Clickable links on state/details lines and large/small images:

p.SetFieldUrls(stateUrl: "https://...", detailsUrl: "https://...");
p.SetAssetUrls(largeUrl: "https://...", smallUrl: "https://...");

Status display type & platforms¶

p.SetStatusDisplayType(IVXStatusDisplayType.Details); // Name | State | Details
p.SetSupportedPlatforms(IVXActivityPlatforms.Desktop | IVXActivityPlatforms.Mobile);

Buttons & invite cover¶

p.AddButton("Watch Trailer", "https://...");
p.ClearButtons();
p.SetInviteCoverImage("invite_cover_key"); // also config default via `InviteCoverImageKey`
p.SetSmallImage("badge_key", "Season 2");

RPC-only mode¶

Desktop-only path: presence updates without full Connect() / manager auth:

p.InitializeRPCOnly(applicationIdLong);

IsRPCOnlyMode reflects this state.

5. Unified Friends List & Relationship Management¶

IVXUnifiedFriend includes DiscordRelationshipType and GameRelationshipType (IVXRelationshipType: None, Friend, PendingIncoming, PendingOutgoing, Blocked) — dual relationship model for Discord vs Nakama layers.

Refresh & filters¶

var f = IVXDiscordFriends.Instance;
f.OnFriendsUpdated += list => { /* bind UI */ };
f.Refresh();
var ingame = f.GetInGameFriends();
var discordOnly = f.GetBySource(IVXFriendSource.Discord);

Game (Nakama) friend requests¶

SendGameFriendRequest, SendGameFriendRequestById, AcceptGameFriendRequest, RejectGameFriendRequest, CancelGameFriendRequest, RemoveGameFriend.

Discord friend requests¶

SendDiscordFriendRequest, SendDiscordFriendRequestById, AcceptDiscordFriendRequest, RejectDiscordFriendRequest, CancelDiscordFriendRequest, RemoveDiscordAndGameFriend.

Block / unblock¶

BlockUser, UnblockUser — plus GetBlockedUsers() and GetPendingRequests() for UI lists.

Events¶

OnFriendRequestReceived, OnFriendRequestAccepted, OnFriendRemoved, OnUserBlocked, OnUserUnblocked, plus online/in-game presence events.

6. Direct Messages (IVXDiscordMessages)¶

Requires EnableDirectMessages where applicable.

Models: IVXDirectMessage (incl. ModerationMetadata), IVXDMSummary. Events: OnDMReceived, OnDMUpdated, OnDMDeleted.

Default history limit is aligned with IVXDiscordConfig.DmHistoryLimit.

7. Lobbies (IVXDiscordLobby)¶

IVXDiscordLobbyInfo exposes LobbyId, Secret, MemberCount, VoiceActive, Metadata, LobbyMetadata, MemberIds.

8. Voice Chat (IVXDiscordVoice)¶

Core¶

JoinCall(lobbyId), LeaveCall, AutoJoinFromLobby(), SetSelfMute, SetSelfDeafen, SetInputVolume / SetOutputVolume / SetParticipantVolume.

VAD¶

v.SetVADThreshold(useCustom: true, thresholdDb: -35f);

Audio callbacks (FMOD / Wwise / custom)¶

v.JoinCallWithAudioCallbacks(
    lobbyId,
    onReceived: (userId, data, samplesPerChannel, sampleRate, channels, ref muteFrame) => { },
    onCaptured: (data, samplesPerChannel, sampleRate, channels) => { });

Delegates: IVXAudioReceivedCallback, IVXAudioCapturedCallback.

Global controls & state¶

SetSelfMuteAll, SetSelfDeafenAll, EndAllCalls, GetParticipantVoiceState(userId).

Events include OnParticipantMuteChanged, OnParticipantDeafenChanged, speaking and participant list updates.

9. Game Invites (IVXDiscordInvites)¶

var inv = IVXDiscordInvites.Instance;
inv.OnInviteReceived += invite => { /* show UI */ };
inv.OnJoinRequested += (requesterId, name) => { /* Ask to Join */ };
inv.OnInviteAccepted += joinSecret => { IVXDiscordLobby.Instance.CreateOrJoinLobby(joinSecret); };
inv.SendInvite(discordUserId, "Join my lobby!");
inv.AcceptInvite(invite);
inv.DeclineInvite(invite);
inv.ApproveJoinRequest(requesterId);
inv.DenyJoinRequest(requesterId);
inv.RegisterCallbacks();

Rich Presence joinSecret + lobby bridging ties invites to sessions.

10. Linked Channels (IVXDiscordLinkedChannels)¶

Bridge IVX/world chat to a Discord text channel (bidirectional where supported):

var ch = IVXDiscordLinkedChannels.Instance;
ch.LinkChannel(lobbyId, guildId, channelId);
ch.SendToLinkedChannel("GG!");
ch.UnlinkChannel();

11. Moderation (IVXDiscordModeration)¶

EnableAutoModeration on config aligns with IVXDiscordModeration.AutoModerateEnabled / EnableAutoModeration(bool).

12. Debug & Logging (IVXDiscordDebug)¶

• Enum IVXDiscordLogLevel: Verbose, Debug, Info, Warning, Error
• SetLogLevel, SetLogCallback for file or analytics sinks
• OnLogMessage for each filtered line
• IVXDiscordConfig.EnableDebugLogging complements native SDK verbosity

13. Social Settings (IVXDiscordManager)¶

• OpenConnectedGamesSettingsInDiscord() — Connected Games / DM-related settings
• OpenUserProfileInDiscord(userId) — jump to a user profile in the Discord client

DM-specific entry: IVXDiscordMessages.OpenDMSettingsInDiscord().

14. API Reference — Key Classes¶

Integration with IntelliVerseX¶

Platform notes¶

Native Discord Social SDK does not target WebGL; IVX falls back to stub mode. Console/desktop/mobile follow Discord’s platform matrix and your program agreements.

Prefabs¶

The SDK provides ready-made prefabs under Assets/Intelli-verse-X-SDK/Prefabs/:

Generate or regenerate prefabs: IntelliVerseX > Generate All Prefabs in the Unity menu.

Quick setup via prefab¶

1. Drag IVX_DiscordManager.prefab into your first scene.
2. Assign your IVXDiscordConfig asset to the IVXDiscordManager component.
3. The prefab persists via DontDestroyOnLoad.

Setup Wizard¶

The Setup Wizard (IntelliVerseX > SDK Setup Wizard) now includes a Discord section under the Features tab with:

• Package detection (com.discord.social-sdk)
• One-click Create Discord Config asset generation
• One-click Add Discord Manager to the scene

Related links¶

• Social module — Nakama friends
• Backend module
• Discord Social SDK overview