DocsGetting Started

Getting Started

Install the plugin, configure an AI agent, and run your first prompt inside Unreal Engine.

# Prerequisites

- Unreal Engine 5.4 or newer (source or Launcher build).

- Node.js -- Required for CLI agents (Claude Code, Codex). The plugin searches PATH, npm global, bun, cargo, volta, fnm, asdf, mise, scoop, and Homebrew locations automatically.

- At least one AI agent CLI installed (see Agent Setup below).

# Installation

From Fab

  1. 1. Purchase or download Blueprint Stack from Fab (Unreal Marketplace).
  2. 2. Enable the plugin in Edit > Plugins and restart the editor.

Manual Install

  1. 1. Copy the BlueprintStack folder into your project's Plugins/ directory.
  2. 2. Regenerate project files and restart the editor.

# Opening the Chat Panel

Once the plugin is enabled, open the chat panel from the menu bar:

Window > Blueprint Stack

The panel opens as a dockable tab. You can dock it alongside your Blueprint editor, Content Browser, or any other panel.

# Agent Setup

Blueprint Stack ships with two built-in agents: Claude Code and Codex. Install them via npm in your terminal:

Built-in Agents

# Claude Code
npm install -g @zed-industries/claude-code-acp
# Codex
npm install -g @openai/codex
npm install -g @zed-industries/codex-acp

Some agents require their own authentication (e.g., running claude login or setting an API key environment variable before first use).

Custom Agents

You can register additional agents in Project Settings > Plugins > Blueprint Stack > Agents. Any ACP-compatible CLI can be added here.

Agent Picker

The agent picker dropdown shows a status label next to each agent:

- Available -- The CLI and API key are both detected. Ready to use.

- Not Installed -- The CLI binary was not found on any search path.

- Missing API Key -- The CLI is installed but its required API key is not set.

# Path Resolution

The plugin automatically searches for agent CLIs and Node.js across the following locations:

- System PATH

- npm global install directory

- bun, cargo, volta, fnm, asdf, mise

- scoop (Windows), Homebrew (macOS/Linux)

# Your First Prompt

  1. 1. Select an agent from the dropdown (make sure it shows Available).
  2. 2. Type a message in the input field, for example:
Read the Blueprint at /Game/ThirdPerson/BP_ThirdPersonCharacter and summarize its event graph.
  1. 3. The agent will call the read_file tool, read the Blueprint's structure, and respond with a summary.

# Attaching Context

You can provide additional context to the AI by attaching Blueprint nodes, assets, or images:

- Ask AI about a node -- Right-click a node in the Blueprint graph and select Ask AI about this node. The node's pins, connections, and properties are serialized and sent with your next prompt.

- Add asset to context -- Right-click an asset in the Content Browser and select Add to AI context. The asset's structure (variables, components, functions, events) is serialized.

- Drag and drop -- Drag assets directly from the Content Browser onto the chat input area.

- Paste images -- Paste an image from your clipboard (Ctrl/Cmd+V) into the chat input. The image is base64-encoded and sent to vision-capable models.

# What's Next?

- Explore the full list of editor tools in the Tools Reference.

- If anything fails during setup, check the Troubleshooting page for quick fixes (Node path issues, missing CLIs, API key configuration, and more).