Godot Engine¶

IntelliVerseX addon for Godot 4, using GDScript with full async/await support. The runtime loads the official Nakama Godot client when present, or falls back to a built-in stub so the project still opens without the addon installed.

SDK version (manager): 5.8.0 (see IntelliVerseX.SDK_VERSION in ivx_manager.gd).

Requirements¶

• Godot 4.2+
• Nakama Godot addon v3.5+ (recommended path: addons/com.heroiclabs.nakama/) for real backend connectivity

Installation¶

1. Install the Nakama Godot addon from Heroic Labs.
2. Copy addons/intelliversex/ from SDKs/godot/ into your project’s addons/ folder.
3. Enable both plugins under Project → Project Settings → Plugins (Nakama + IntelliVerseX).

The IntelliVerseX editor plugin registers an autoload singleton named IntelliVerseX pointing at res://addons/intelliversex/core/ivx_manager.gd.

Quick Start¶

extends Node

func _ready() -> void:
    var config := IVXConfig.new()
    config.nakama_host = "127.0.0.1"
    config.nakama_port = 7350
    config.nakama_server_key = "defaultkey"
    config.enable_debug_logs = true

    IntelliVerseX.initialize(config)
    IntelliVerseX.auth_success.connect(_on_auth)

    if not IntelliVerseX.restore_session():
        IntelliVerseX.authenticate_device()

func _on_auth(session) -> void:
    print("Logged in: ", IntelliVerseX.username)
    var profile = await IntelliVerseX.fetch_profile()
    print("Profile: ", profile)

API Surface¶

Use these types as your map of what ships in addons/intelliversex/. Most subsystems are nodes or RefCounted types you instantiate and add to the tree (or hold as resources)—only IntelliVerseX is registered as an autoload by the plugin.

Feature Coverage¶

Values below are the Godot 4 column from the repo’s audited matrix. Legend: Y = implemented | S = stub/mock (API present, local or non-functional backend) | P = partial | - = not applicable or not present.

Core platform¶

AI voice and host¶

AI LLM stack¶

Multiplayer and game modes¶

Hiro live-ops¶

Discord social SDK¶

Satori analytics¶

Platform and extras¶

XR (selected)¶

For the full cross-platform comparison, see FEATURE_COVERAGE_MATRIX.md.

Key Classes (summary)¶

Signals Reference¶

IntelliVerseX (ivx_manager.gd)¶

IVXMultiplayer¶

IVXGameModes¶

IVXHiroSystems¶

IVXAIClient¶

IVXDiscordSocial¶

IVXDeepLinks¶

IVXXRHelper¶

IVXDiscordDebug¶

Advanced Examples¶

1. Hiro spin wheel with await (GDScript)¶

Instantiate IVXHiroSystems after the player has a Nakama session (same nakama_client and session references you get from successful auth via IntelliVerseX).

extends Node

@onready var _hiro: IVXHiroSystems = IVXHiroSystems.new()

func _ready() -> void:
    add_child(_hiro)
    IntelliVerseX.auth_success.connect(_on_authenticated)
    _hiro.spin_wheel_result.connect(_on_spin_result)

func _on_authenticated(_session) -> void:
    _hiro.initialize(IntelliVerseX.nakama_client, IntelliVerseX.nakama_session)
    var state := await _hiro.spin_wheel_get()
    print("Spin wheel state: ", state)

func spin_daily() -> void:
    var reward := await _hiro.spin_wheel_spin()
    print("Spin RPC result: ", reward)

func _on_spin_result(reward: Dictionary) -> void:
    print("Signal spin_wheel_result: ", reward)

2. AI NPC dialog flow (stubs + real voice client)¶

For production voice/host, use IVXAIClient against your IntelliVerseX AI base URL. The IVXAINPCDialogManager class exists for API parity with Unity but emits warnings and returns empty data until implemented—structure your game so you can swap in real dialog later.

extends Node

var _ai: IVXAIClient
var _npc: IVXAINPCDialogManager

func _ready() -> void:
    _ai = IVXAIClient.new()
    _npc = IVXAINPCDialogManager.new()
    add_child(_ai)
    add_child(_npc)

    _ai.initialize("https://your-ai-gateway.example", "optional-api-key")

    IntelliVerseX.auth_success.connect(_on_auth)

func _on_auth(_session) -> void:
    var uid := IntelliVerseX.user_id
    var voice := await _ai.start_voice_session("host-persona", uid)
    if voice.has("session_id"):
        await _ai.send_text(voice["session_id"], "Hello from Godot!")

    # Stub NPC path: register/start when IVXAINPCDialogManager is implemented server-side
    _npc.initialize(null)
    _npc.set_auth_token(IntelliVerseX.nakama_session.token if IntelliVerseX.nakama_session else "")
    var dialog := await _npc.start_dialog("shop_keeper", uid, "first_visit")
    print("NPC dialog session (stub): ", dialog)

Troubleshooting¶

Nakama Client¶

Built on nakama-godot (official Heroic Labs client). IntelliVerseX creates the HTTP client and can open a real-time socket using the same addon. Refer to Nakama documentation for matchmaking, storage, and RPC semantics.

Source¶

• Addon and examples: SDKs/godot/
• Broader SDK repo: Intelli-verse-X-SDK

Further Reading¶

• Nakama client libraries — Godot
• Nakama Godot on GitHub
• IntelliVerseX feature coverage matrix (all platforms, Godot column)
• Godot Engine — XR / OpenXR
• IntelliVerseX Godot README in-repo: SDKs/godot/README.md (feature overview and snippet index)
• .cursor/skills/ivx-cross-platform/SKILL.md — cross-engine parity and stub expectations