NexusFlow

English

简体中文

English

简体中文

Appearance

Quick Start ​

Get up and running with NexusFlow in 5 minutes

This guide walks you through installation, configuration, and your first AI conversation.

Prerequisites ​

Before you begin, make sure your environment meets the following requirements:

ItemRequirement
Operating SystemWindows 10 / 11
Unreal EngineUnreal Engine 5.6 or 5.7
LLM API KeyAny one of: OpenAI / Anthropic / Google Gemini / DeepSeek / Zhipu GLM / MiniMax / Qwen / Kimi

Installation ​

  1. Download the latest .exe installer from GitHub Releases
  2. Run the installer to complete the NexusFlow desktop app setup
  3. Purchase and install the UE plugin from Fab.com (see Installation Guide for details)

First-Run Wizard ​

When you first launch NexusFlow and click the floating ball on your screen, a setup wizard will guide you through all the necessary configuration. The wizard has 6 steps:

Step 1: Welcome ​

Setup Wizard - Welcome

A brief introduction to NexusFlow. Click "Start Setup" to continue, or "Skip" to go straight to the app.

Step 2: Configure AI Model ​

Setup Wizard - AI Model Configuration

This is the most important step — you need to add at least one AI model to use the chat feature.

  1. Select a Provider: OpenAI, Anthropic, Google Gemini, DeepSeek, Zhipu GLM, MiniMax, Qwen, Kimi, or Custom
  2. Enter a Model Name (a custom label for display in the model list)
  3. Enter your API Key
  4. Enter the Model ID (e.g., gpt-5.4, claude-opus-4-6)
  5. Optionally adjust Temperature and Max Tokens
  6. Click Save

TIP

If you choose Custom Provider, you'll also need to enter an API endpoint URL and select the communication protocol (OpenAI Compatible / OpenAI Responses API / Anthropic Messages API / Google Gemini API).

Step 3: UE Plugin Check ​

Setup Wizard - Plugin Check

The wizard automatically detects whether Unreal Engine is installed on your computer and whether the NexusFlow plugin is properly set up.

  • ✅ Plugin detected: You're good to go
  • ❌ Plugin not found: See Installation Guide for manual installation

Step 4: Anonymous Analytics ​

Choose whether to allow anonymous usage data collection. This data is used solely to improve the product and contains no personal information. You can change this setting at any time.

Step 5: Feature Tour ​

A quick overview of NexusFlow's three core features:

  • Floating Ball: A desktop quick-access entry point — click to open AI chat
  • AI Chat Sidebar: The main interface for communicating with AI, supporting floating and docked modes
  • UE Quick Menu: 17 AI operations across right-click menus and toolbars in the UE Editor

Step 6: Complete ​

Setup Wizard - Complete

You're all set! Click "Get Started" to enter the AI chat interface.

Keyboard Shortcuts

During the wizard, press Enter to proceed to the next step, or Escape to skip the wizard entirely.

UE Plugin Setup Dialog ​

The first time UE starts with the NexusFlow plugin enabled, you may see a NexusFlow Setup dialog. This is normal — the plugin checks whether the desktop app is installed and whether the embedding model is ready.

Your First Conversation ​

Once the wizard is complete, you're ready to start using NexusFlow:

  1. Launch NexusFlow — A floating ball appears on your desktop (a blue-purple gradient circle)
  2. Launch the UE Editor — Make sure the NexusFlow plugin is enabled
  3. Wait for connection — The status bar at the bottom of the sidebar turns from red to green, showing the project name and UE version
  4. Open a Blueprint — Open the Blueprint you want to work with in UE
  5. Click the floating ball — Opens the AI chat sidebar
  6. Type a message — For example: "Explain what this Blueprint does"

The AI will automatically read the information from your currently open Blueprint, analyze it, and respond.

Important

Make sure UE is connected before starting a conversation (the bottom status bar should show a green dot). If not connected, the AI won't be able to operate on Blueprints.

Next Steps ​