LLMAI Plugin Installation Guide

The LLMAI plugin is distributed as source code that compiles automatically when you enable it. This ensures compatibility with all Unreal Engine 5.6+ versions on Windows 64-bit platforms.

Installation Steps

Step 1: Extract Plugin

Download and extract the LLMAI plugin from fab.com or other distribution source
Copy the LLMAI folder to your project's Plugins/ directory:

YourProject/ └── Plugins/ └── LLMAI/ # Complete plugin folder here

Step 2: Enable Plugin & Auto-Compile

Open your Unreal Engine project
Go to Edit > Plugins
Search for "LLMAI"
Check the Enabled checkbox
Click "Yes" when prompted to compile the plugin
Wait for compilation to complete (1-3 minutes depending on system)
Restart the editor when prompted

Note: The plugin will compile automatically from source code. This works with both Blueprint and C++ projects.

Step 3: Configure AI Service

Choose one of the following options:

Option A: OpenAI (Cloud Service)

Go to Edit > Project Settings
Navigate to Plugins > LLMAI
Enter your OpenAI API Key:
- Enter your key in "Default OpenAI API Key" field
- Alternative methods if needed:
  - Environment Variable: Set LLMAI_OPENAI_API_KEY or OPENAI_API_KEY
  - Command Line: Launch with -OpenAIKey=your_key_here parameter
Optionally adjust other settings like default model and voice

Note: The plugin checks for API keys in this priority order and uses the first valid key found.

Option B: LocalAI (Offline/Local Processing)

For offline operation, use the LLMAI LocalAI distribution (available separately):

No OpenAI API key required
Supports local STT and TTS voice synthesis
Configure endpoint URL in Project Settings

See LocalAI Quick Start Guide for download and setup instructions.

Verification

Test Plugin Installation

Create a new Actor Blueprint
Add Component > Search for "LLMAI Client Component"
If the component appears in the list → Installation successful!
If not found → Check troubleshooting section below

Test Basic API Connection

Add LLMAI Client Component to any Actor
In Begin Play: Add "Connect to AI" node
Set parameters: Model = gpt-realtime, Instructions = You are helpful
Play the level and check Output Log for connection status
Look for: "AI Session Ready" message = Success!

Test Complete Setup

If you have the complete LLMAI project with demos, try the LLMAI Terminal Demo:

Open level: Content/LLMAITerminal/Levels/LVL_LLMAITerminal
Play in editor
Connect to AI using the dialog
Chat with AI to verify everything works

Troubleshooting

Plugin Not Appearing in Plugin List

Ensure the plugin is in the correct Plugins/LLMAI/ directory
Check that LLMAI.uplugin file exists in the plugin root
Restart Unreal Engine editor completely
Verify you're using Unreal Engine 5.6+ on Windows 64-bit

Compilation Errors

Ensure Visual Studio 2022 is installed (required for plugin compilation)
Verify Windows SDK is installed and up to date
Check Output Log during plugin enable for specific error details
Try closing all other applications during compilation to free up memory
For persistent issues: Delete Binaries/ and Intermediate/ folders from plugin, then re-enable

Plugin Compilation Taking Too Long

Normal time: 1-3 minutes for first compilation
If stuck: Check Output Log for progress details
If frozen: Close editor, delete plugin's Binaries/ and Intermediate/ folders, restart editor

API Connection Issues

For OpenAI:

Verify your OpenAI API Key is correct and active
Check internet connection and firewall settings
Review Output Log for specific error messages
Try debug command: llmai.debug.OpenAILevel 2 in console for detailed logs

For LocalAI:

Verify LocalAI server is running
Check the endpoint URL in Project Settings matches your LocalAI server
Review Output Log for connection errors

Complete Documentation

For comprehensive guides, demos, and examples beyond basic plugin installation:

Complete Project Documentation - See the root Documentation folder if you have the full LLMAI project
Plugin API Reference - See API.htm for complete function documentation
Debug & Troubleshooting - See Debug-Logging.htm for detailed troubleshooting
Plugin Architecture - See Plugin-README.htm for technical details

This installation guide focuses specifically on the plugin. For quick-start tutorials, demo walkthroughs, and integration examples, refer to the main project documentation.