🚀 Quick Start Guide

Step 1: Install the Plugin

Quick Install:

1. Extract LLMAI folder to YourProject/Plugins/LLMAI/
2. Enable Plugin: Edit > Plugins > Search "LLMAI" > Check Enabled
3. Restart the editor

For detailed installation steps and troubleshooting, see Plugin Installation Guide

Step 2: Configure AI Service

Option A: OpenAI (Cloud)

1. Go to Edit > Project Settings
2. Navigate to Plugins > LLMAI
3. Enter your OpenAI API Key
4. Optional: Set your preferred model and voice

Option B: LocalAI (Offline)

For local/offline AI processing, use the LLMAI LocalAI distribution (available separately). No API key required.

See LocalAI Quick Start Guide for download and setup.

Step 3: Try the Demos

LLMAI comes in two demo projects. Both use the same Terminal interface but showcase different AI capabilities:

Step 4: Add AI to Your Project

Blueprint Method (Easy)

1. Open any Blueprint Actor
2. Add Component: Search for "LLMAI Client Component"
3. In Begin Play:
   • Use Connect to AI node
   • Set Instructions: You are a helpful assistant
   • Set Modalities: text, audio
4. Send Text to AI:
   • Use Send Text to AI node to trigger a conversation
   • Connect a string input (e.g., "Hello, how are you?")
   • This automatically triggers an AI response (no additional trigger needed)
   • This can be triggered by user input, button press, or any game event
5. Handle Responses:
   • Easiest Method: Bind to On AI Text Response Complete event
     • This provides the full response when complete (recommended for most use cases)
   • Streaming Method (Optional): For real-time streaming text:
     • Bind to On AI Text Response Start event (response begins)
     • Bind to On AI Text Response Delta event (each text chunk)
     • Bind to On AI Text Response End event (response complete)
   • Print the response or update your UI

C++ Method (Advanced)

// In your Actor's header file
UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = "AI")
class ULLMAIClientComponent* AIClient;

// In constructor
AIClient = CreateDefaultSubobject<ULLMAIClientComponent>(TEXT("AIClient"));

// In BeginPlay
AIClient->OnAITextResponseComplete.AddDynamic(this, &AMyActor::HandleAIResponse);
TArray<FString> Modalities = {"text", "audio"};

// Connect to AI (OpenAI example)
AIClient->ConnectToAI(
    "OpenAI",           // Provider: "OpenAI" or "LocalAI"
    "gpt-realtime", 
    "You are a helpful assistant", 
    {"text", "audio"}
);

// To send text to AI (trigger this from user input, button press, etc.)
AIClient->SendTextToAI("Hello, how are you?");
// This automatically triggers an AI response - no additional call needed

Step 5: Enable Voice (Optional)

Start Voice Mode

// In Blueprint: use "Start Voice Mode" node with voice name "alloy"  
// In C++:
AIClient->StartVoiceMode("alloy");
// Audio capture and streaming are handled automatically!

Note:

• StartVoiceMode() automatically handles audio setup - no manual setup required
• Audio streaming starts automatically when voice mode activates

🔧 Step 6: Add AI Functions (Optional)

Let the AI call functions in your game!

Create Function Definition

1. Right-click in Content Browser
2. Miscellaneous > LLMAI Function Definition
3. Name: "spawn_enemy"
4. Description: "Spawn an enemy in the game"
5. Add Parameters as needed

Register and Handle

// Register the function
AIClient->RegisterAIFunction(MyFunctionDefinition);

// Handle AI function calls
AIClient->OnAIFunctionCallRequested.AddDynamic(this, &AMyActor::HandleFunctionCall);

// In your handler
void AMyActor::HandleFunctionCall(const FLLMFunctionCall& FunctionCall)
{
    if (FunctionCall.Name == "spawn_enemy")
    {
        // Your game logic here
        SpawnEnemy();
        
        // Tell AI it worked
        AIClient->SendAIFunctionCallResult(FunctionCall.CallId, "Enemy spawned successfully!");
    }
}