Skip to content

Getting Started

Welcome to the IntelliVerseX SDK! This guide will help you get up and running quickly.

Before You Begin

Before installing the SDK, ensure your project meets the requirements:

  • Unity Version

    • Minimum: Unity 2023.3 LTS
    • Recommended: Unity 6000.x

  • API Compatibility

    • .NET Standard 2.1 or higher
    • IL2CPP or Mono backend

  • Git

    Required for UPM installation via Git URL

Full Requirements

Installation Path

Choose your installation method:

Add to Packages/manifest.json: 

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

  1. Open Window > Package Manager
  2. Click + > Add package from git URL...
  3. Enter the Git URL
  4. Click Add
  1. Clone the repository
  2. Window > Package Manager
  3. + > Add package from disk...
  4. Select package.json

Full Installation Guide

Quick Start

After installation, follow these steps:

Step 1: Run Project Setup

IntelliVerseX > Project Setup & Validation

Click Apply All Required Settings to configure your project.

Step 2: Initialize the SDK

Add an IVXBootstrap component to a GameObject in your first scene and assign an IVXBootstrapConfig (see the Quick Start for creating config assets and optional AI/Discord configs). With Auto Initialize enabled, the SDK starts on Play.

using UnityEngine;
using IntelliVerseX.Bootstrap;
using IntelliVerseX.Core;

public class GameInit : MonoBehaviour
{
    void Start()
    {
        var bootstrap = IVXBootstrap.Instance;
        if (bootstrap == null)
        {
            IVXLogger.LogWarning("Add IVXBootstrap to the scene with a Bootstrap Config assigned.");
            return;
        }

        if (bootstrap.IsInitialized)
        {
            IVXLogger.Log("IntelliVerseX SDK Ready!");
            return;
        }

        bootstrap.OnBootstrapComplete += success =>
        {
            if (success)
                IVXLogger.Log("IntelliVerseX SDK Ready!");
        };
    }
}

Step 3: (Optional) Connect to Backend

IVXBootstrap connects to Nakama when the Nakama package is installed and your Bootstrap Config has a valid server host/port/key. After bootstrap completes you can run game-specific setup (for example your own services layered on the same session):

using UnityEngine;
using IntelliVerseX.Bootstrap;
using IntelliVerseX.Core;

public class GameInit : MonoBehaviour
{
    void Start()
    {
        var bootstrap = IVXBootstrap.Instance;
        if (bootstrap == null)
            return;

        if (bootstrap.IsInitialized)
        {
            OnBackendReady(bootstrap.IsInitialized);
            return;
        }

        bootstrap.OnBootstrapComplete += OnBackendReady;
    }

    void OnBackendReady(bool success)
    {
        if (success)
            IVXLogger.Log("Connected to backend!");
    }
}

Quick Start Guide

What's Included

When you install the SDK, you get:

Module Description
Core Foundation utilities, logging, singletons
Identity User authentication and session management
Backend Nakama integration (leaderboards, wallets, RPC)
Social Friends system, sharing, referrals
Monetization IAP, ads (multiple networks), offerwalls
Analytics Event tracking via Nakama
Localization Multi-language support with RTL
Storage Secure local and cloud storage
Leaderboards Global and around-player rankings
Quiz Complete quiz game framework
UI Production-ready UI components
Editor Setup wizards and validation tools

Next Steps