Connect with Godot

Installation

From the Godot SDK checkout, prepare the addon on macOS. Install Python 3, Git, JDK 17, Android SDK 36 and its required NDK, Xcode, SCons, and XcodeGen first:

python3 scripts/prepare-native.py
python3 scripts/pack.py

Extract dist/nuxie-godot-0.4.0.zip so your game contains addons/nuxie. Then:

1. Enable Nuxie under Project → Project Settings → Plugins. This registers the Nuxie autoload.
2. For Android, install the matching build templates, enable Gradle builds, and select a 64-bit ABI: arm64-v8a or x86_64.
3. For iOS, enable NuxieGodot in the export preset.

See the build guide for native toolchain setup.

Initialize

Copy your app’s public keys from Connect your app. Use pk_test_ keys in development builds and pk_live_ keys in release builds. Keep the default service environment for both; the key selects preview or live content.

Configure the autoload from a startup Node:

extends Node

func _ready() -> void:
    var options := NuxieOptions.new()
    options.ios_api_key = "YOUR_IOS_PUBLIC_KEY"
    options.android_api_key = "YOUR_ANDROID_PUBLIC_KEY"

    var result: NuxieResult = await Nuxie.configure(options)
    if not result.ok:
        push_error(result.error.message)
        return

Check result.ok before continuing. The autoload stays configured across scene changes.

Run your app on a device or simulator. Connect your app shows Connected after Nuxie receives a request from the SDK.

Trigger an Experience

Publish an Experience for this app with the event trigger integration_test. Set its re-entry rule to Every time if you want to show it repeatedly while integrating. Add this call to a button handler after setup:

var result: NuxieResult = await Nuxie.trigger("integration_test")
if not result.ok:
    push_error(result.error.message)

Tapping the button sends the event. Nuxie displays the Experience when the customer matches its audience and delivery rules. For an existing Experience, replace integration_test with its published event name.

Connect your app changes to Shown after the SDK reports that the Experience appeared. For games, run this in an iOS or Android player or export. Your game controls pause, audio, and input while the Experience is visible.

Update an Experience

Edit the Experience and publish your changes. Bring the app back to the foreground to fetch the update, then send the event again with a customer who can re-enter. New Journeys use the updated version; a Journey already in progress keeps the version it started with. The app code stays the same.

See the SDK reference for identity, feature access, and App Actions. Delivery explains trigger and audience configuration.