Unity Engine / .NET¶

The Unity SDK is the most feature-complete IntelliVerseX implementation, with native support for Hiro, Satori, monetization, localization, social features, and more.

Requirements¶

Platforms: Android, iOS, WebGL, Windows, macOS, Linux

XR / VR / AR: Meta Quest, SteamVR (OpenXR), Apple Vision Pro (visionOS), PSVR2, Windows Mixed Reality, AR Foundation (ARKit/ARCore). See XR/VR/AR guide.

Consoles: PS5, Xbox Series X|S, Nintendo Switch (via adapter pattern, NDA SDKs required). See Console guide.

Installation¶

Add to your Packages/manifest.json:

{
  "dependencies": {
    "com.intelliversex.sdk": "https://github.com/Intelli-verse-X/Intelli-verse-X-SDK.git?path=Assets/_IntelliVerseXSDK"
  }
}

With specific version tag:

{
  "dependencies": {
    "com.intelliversex.sdk": "https://github.com/Intelli-verse-X/Intelli-verse-X-SDK.git?path=Assets/_IntelliVerseXSDK#v5.8.0"
  }
}

Quick Start¶

using UnityEngine;
using IntelliVerseX.Core;
using IntelliVerseX.Identity;

public class GameInit : MonoBehaviour
{
    void Start()
    {
        IntelliVerseXUserIdentity.InitializeDevice();
        IVXLogger.Log("IntelliVerseX SDK Ready!");
    }
}

For production, prefer dropping an IVXBootstrap prefab (or scene object) and assigning IVXBootstrapConfig so Nakama, optional Discord, and feature modules initialize in one place. See Platform-specific configuration below.

API Surface¶

Key Unity entry points and managers. Names reflect the public types in the package; a few rows note primary types where aliases or split APIs are common in docs or samples.

Related systems (often composed with IVXHiroRpcClient or dedicated MonoBehaviours): IVXDailyRewardsBackendService, IVXDailyMissionsManager, IVXSeasonPassManager, IVXFortuneWheelManager, IVXLeagueManager, IVXTournamentManager, IVXAchievementManager, IVXBadgeManager, IVXFriendStreakManager, IVXRetentionManager, IVXGoalsManager, IVXCharacterManager, IVXPushNotificationManager, IVXDeepLinkManager, and Hiro subsystem types under IntelliVerseX.Hiro.Systems.

Feature Coverage¶

Values are taken from the Feature Coverage Matrix for Unity only.

Legend: Y = Implemented | S = Stub / partial platform adapter | P = Partial | - = Not present

Core¶

AI Voice¶

AI LLM Stack¶

Multiplayer¶

Hiro¶

Discord¶

Satori¶

Platform Extras¶

Nakama Live Systems¶

XR / Console (Unity column)¶

At v5.8.0, Unity is the reference platform (~82% fully implemented in the audited matrix). For cross-engine comparison, keep using the full matrix.

Platform-Specific Configuration¶

ScriptableObjects and assets¶

Create assets from the Unity menu where CreateAssetMenu is defined (e.g. IntelliVerseX → Discord Config). The SDK Setup Wizard (Editor) can generate common assets under Assets/_IntelliVerseXSDK/.

Define symbols (automatic)¶

The editor IVXDefineSymbolManager detects optional third-party assemblies and adds INTELLIVERSEX_* defines so runtime code can compile against Nakama, Photon, DOTween, ad mediation, etc.

Game code uses these in #if regions—for example, IVXMatchmakingManager only calls RemoveMatchmakerAsync when INTELLIVERSEX_HAS_NAKAMA is defined. If you expect Nakama but the symbol is missing, the package is not referenced or assemblies failed to compile.

Assembly definitions¶

Each functional area ships as an .asmdef (see Module reference – Assembly Definitions): IntelliVerseX.Core, IntelliVerseX.Identity, IntelliVerseX.Backend, IntelliVerseX.AI, IntelliVerseX.Hiro, IntelliVerseX.Satori, IntelliVerseX.Demos, etc. Reference only the assemblies your game needs to keep compile times and IL2CPP builds lean.

Advanced Examples¶

Hiro-style daily rewards (Nakama RPC)¶

Use IVXDailyRewardsBackendService after the player has a valid Nakama session (typically via your Nakama bootstrap / IVXNManager). The service uses the same RPC ids as the backend (daily_rewards_get_state, daily_rewards_claim, daily_rewards_get_calendar).

using System.Threading.Tasks;
using UnityEngine;
using IntelliVerseX.DailyRewards;

public class DailyRewardPrompt : MonoBehaviour
{
    public async Task TryClaimDailyAsync()
    {
        var svc = IVXDailyRewardsBackendService.Instance;
        if (svc == null)
        {
            Debug.LogError("Add IVXDailyRewardsBackendService to the scene.");
            return;
        }

        var state = await svc.GetStateAsync();
        if (state == null || !state.canClaim)
            return;

        var result = await svc.ClaimTodayAsync();
        if (result != null)
            Debug.Log($"Claimed day {result.day}, streak {result.streak}");
    }
}

For other Hiro systems, instantiate IVXHiroRpcClient with IClient + ISession and call your RPC id with CallAsync<T>(...).

AI NPC conversation¶

using UnityEngine;
using IntelliVerseX.AI;

public class ShopkeeperNPC : MonoBehaviour
{
    [SerializeField] private IVXAIConfig _aiConfig;
    [SerializeField] private IVXAINPCProfile _profile; // configured in Inspector or via code

    private void Start()
    {
        var mgr = IVXAINPCDialogManager.Instance;
        mgr.Initialize(_aiConfig);
        mgr.RegisterNPC(_profile);

        mgr.OnNPCResponse += (sessionId, text) =>
            Debug.Log($"NPC: {text}");
    }

    public void OpenDialog(string playerId)
    {
        var mgr = IVXAINPCDialogManager.Instance;
        mgr.StartDialog(_profile.NpcId, playerId, "Standing near the shop counter.");

        // After StartDialog, capture session id from callback or ActiveSessions if needed,
        // then mgr.SendMessage(sessionId, playerLine, _ => { });
    }
}

Multiplayer matchmaking¶

using UnityEngine;
using IntelliVerseX.GameModes;

public class PlayOnlineButton : MonoBehaviour
{
    private void OnEnable()
    {
        IVXMatchmakingManager.Instance.OnMatchFound += OnMatchFound;
        IVXMatchmakingManager.Instance.OnSearchCancelled += reason =>
            Debug.LogWarning($"Matchmaking cancelled: {reason}");
    }

    private void OnDisable()
    {
        IVXMatchmakingManager.Instance.OnMatchFound -= OnMatchFound;
    }

    public void QuickPlay()
    {
        // Assign IVXNManager (or provider) on IVXMatchmakingManager in the Inspector for live Nakama.
        IVXMatchmakingManager.Instance.QuickMatch();
    }

    private void OnMatchFound(IVXMatchFoundResult result)
    {
        Debug.Log($"Matched: {result.OpponentDisplayName}");
    }
}

Troubleshooting¶

Nakama Client¶

Built on nakama-unity (468 stars, 82 forks).

Full Documentation¶

See the Unity modules documentation for complete API reference.

Source¶

Assets/_IntelliVerseXSDK/

Further Reading¶

• Feature Coverage Matrix — All platforms side by side.
• Modules index — Architecture, dependencies, assembly list.
• API reference index — Generated-style API pages: Core, Identity, Backend, AI, Hiro, Multiplayer, Satori, Discord, Monetization, Localization, Leaderboards, Quiz, Platform, Demos.
• Getting started / Quickstart — End-to-end bootstrap checklist.
• XR / VR / AR and Console platform guides.
• Configuration: feature flags — Remote and local toggles.