Skip to content
Back to search

UnrealClaude

SkillWorks with Claude CodeGitHub

Claude Code CLI integration for Unreal Engine 5.7 - Get AI coding assistance with built-in UE5.7 documentation context directly in the editor.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/natfii--unrealclaude/badge.svg)](/listings/natfii--unrealclaude)

HTML

<a href="/listings/natfii--unrealclaude"><img src="/api/listings/natfii--unrealclaude/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

npm install -g @anthropic-ai/claude-code

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 412 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # UnrealClaude
  2. ![Unreal Engine](https://img.shields.io/badge/Unreal%20Engine-5.7-313131?style=flat&logo=unrealengine&logoColor=white)
  3. ![C++](https://img.shields.io/badge/C%2B%2B-20-00599C?style=flat&logo=c%2B%2B&logoColor=white)
  4. ![Platform](https://img.shields.io/badge/Platform-Win64%20%7C%20Linux%20%7C%20Mac-0078D6?style=flat&logo=windows&logoColor=white)
  5. ![Claude Code](https://img.shields.io/badge/Claude%20Code-Integration-D97757?style=flat&logo=anthropic&logoColor=white)
  6. ![MCP](https://img.shields.io/badge/MCP-20%2B%20Tools-8A2BE2?style=flat)
  7. ![License](https://img.shields.io/badge/License-MIT-green?style=flat)
  8. **Claude Code CLI integration for Unreal Engine 5.7** - Get AI coding assistance with built-in UE5.7 documentation context directly in the editor.
  9. > **Supported Platforms:** Windows (Win64), Linux, and macOS (Apple Silicon). Claude Opus 4.7 and its Claude Code release supported.
  10. ## Overview
  11. UnrealClaude integrates the [Claude Code CLI](https://docs.anthropic.com/en/docs/claude-code) directly into the Unreal Engine 5.7 Editor and runs a MCP server for access to other coding agents.
  12. <p align="center">
  13. <img width="45%" height="400" alt="Screenshot in editor chat" src="https://github.com/user-attachments/assets/5eff6f0d-8900-485c-b692-141bfb45d397" />
  14. <img width="45%" height="500" alt="Screenshot claude code" src="https://github.com/user-attachments/assets/abcd41ce-7caf-4e7b-87b8-39a406d29cd5" />
  15. </p>
  16. **Key Features:**
  17. - **Native Editor Integration** - Chat panel docked in your editor with live streaming responses, tool call grouping, and code block rendering
  18. - **MCP Server** - 20+ Model Context Protocol tools for actor manipulation, Blueprint editing, level management, materials, input, and more
  19. - **Dynamic UE 5.7 Context System** - The MCP bridge includes a dynamic context loader that provides accurate UE 5.7 API documentation on demand
  20. - **Blueprint Editing** - Create and modify Blueprints, Animation Blueprints, state machines (Few bugs still, don't rely on fully)
  21. - **Level Management** - Open, create, and manage levels and map templates programmatically
  22. - **Asset Management** - Search assets, query dependencies and referencers
  23. - **Async Task Queue** - Long-running operations won't timeout
  24. - **Script Execution** - Claude can write, compile (via Live Coding), and execute scripts with your permission
  25. - **Session Persistence** - Conversation history saved across editor sessions
  26. - **Project-Aware** - Automatically gathers project context (modules, plugins, assets) and is able to see editor viewports
  27. - **Uses Claude Code Auth** - No separate API key management needed
  28. ## Prerequisites
  29. ### 1. Install Claude Code CLI
  30. ```bash
  31. npm install -g @anthropic-ai/claude-code
  32. ```
  33. ### 2. Authenticate Claude Code
  34. ```bash
  35. claude auth login
  36. ```
  37. This will open a browser window to authenticate with your Anthropic account (Claude Pro/Max subscription) or set up API access.
  38. ### 3. Verify Installation
  39. ```bash
  40. claude --version
  41. claude -p "Hello, can you see me?"
  42. ```
  43. ## Installation
  44. <img width="1222" height="99" alt="Screenshot 2026-02-06 112433" src="https://github.com/user-attachments/assets/61d72364-f7bc-4f34-a768-aedc0f5cea2e" />
  45. (Check the Editor category in the plugin browser. You might need to scroll down for it if search doesn't pick it up)
  46. ### Step 1: Clone and Build
  47. This plugin must be built from source for your platform and engine version. No prebuilt binaries are included.
  48. 1. Clone this repository (includes the MCP bridge submodule):
  49. ```bash
  50. git clone --recurse-submodules https://github.com/Natfii/UnrealClaude.git
  51. ```
  52. If you already cloned without `--recurse-submodules`, run:
  53. ```bash
  54. cd UnrealClaude
  55. git submodule update --init
  56. ```
  57. 2. Build the plugin:
  58. **Windows:**
  59. ```bash
  60. Engine\Build\BatchFiles\RunUAT.bat BuildPlugin -Plugin="PATH\TO\UnrealClaude\UnrealClaude\UnrealClaude.uplugin" -Package="OUTPUT\PATH" -TargetPlatforms=Win64
  61. ```
  62. **Linux:**
  63. ```bash
  64. Engine/Build/BatchFiles/RunUAT.sh BuildPlugin -Plugin="/path/to/UnrealClaude/UnrealClaude/UnrealClaude.uplugin" -Package="/output/path" -TargetPlatforms=Linux
  65. ```
  66. **macOS:**
  67. ```bash
  68. Engine/Build/BatchFiles/RunUAT.sh BuildPlugin -Plugin="/path/to/UnrealClaude/UnrealClaude/UnrealClaude.uplugin" -Package="/output/path" -TargetPlatforms=Mac
  69. ```
  70. ### Step 2: Install the Plugin
  71. Copy the built plugin to either your **project** or **engine** plugins folder.
  72. **Option A: Project Plugin (Recommended)**
  73. Copy the build output to your project's `Plugins` directory:
  74. ```
  75. YourProject/
  76. ├── Content/
  77. ├── Source/
  78. └── Plugins/
  79. └── UnrealClaude/
  80. ├── Binaries/
  81. ├── Source/
  82. ├── Resources/
  83. ├── Config/
  84. └── UnrealClaude.uplugin
  85. ```
  86. **Option B: Engine Plugin (All Projects)**
  87. Copy to your engine's plugins folder:
  88. **Windows:**
  89. ```
  90. C:\Program Files\Epic Games\UE_5.7\Engine\Plugins\Marketplace\UnrealClaude\
  91. ```
  92. **Linux:**
  93. ```
  94. /path/to/UnrealEngine/Engine/Plugins/Marketplace/UnrealClaude/
  95. ```
  96. ### Step 3: Install MCP Bridge Dependencies
  97. Required for Blueprint tools and editor integration:
  98. ```bash
  99. cd <PluginPath>/UnrealClaude/Resources/mcp-bridge
  100. npm install
  101. ```
  102. ### Step 4: Launch
  103. Launch the editor - the plugin will load automatically.
  104. ### Step 5: (Optional) Use with Claude Code CLI or Claude App
  105. 1. **Launch Claude Code or Claude CLI** and point it to your UnrealClaude install.
  106. <img width="1097" height="154" alt="image" src="https://github.com/user-attachments/assets/05a88a96-abce-4ebb-93ef-1ea405e5f28a" />
  107. 2. After the all clear, **restart just Claude Code / CLI for changes to save.**
  108. <p align="center">
  109. <img height="200" alt="Screenshot 1" src="https://github.com/user-attachments/assets/251f1580-aec2-415c-abab-6a2e50662a8e" />
  110. <img height="200" alt="Screenshot 2" src="https://github.com/user-attachments/assets/ffda3096-d808-41e7-85ba-176dfe6385d8" />
  111. </p>
  112. ## macOS Quick Start (Apple Silicon)
  113. For full details, see [INSTALL_MAC.md](INSTALL_MAC.md).
  114. 1. **Install Node.js and Claude Code CLI:**
  115. ```bash
  116. brew install node
  117. npm install -g @anthropic-ai/claude-code
  118. claude
  119. ```
  120. 2. **Install the plugin** into your project's `Plugins/` directory
  121. 3. **Install MCP bridge dependencies:**
  122. ```bash
  123. cd YourProject/Plugins/UnrealClaude/Resources/mcp-bridge
  124. npm install
  125. ```
  126. 4. **Launch** the editor and open **Tools > Claude Assistant**
  127. ## Linux Quick Start (Rocky/Fedora)
  128. For full details, see [INSTALL_LINUX.md](INSTALL_LINUX.md).
  129. 1. **Install Libraries:**
  130. ```bash
  131. sudo dnf install -y nss nspr mesa-libgbm libXcomposite libXdamage libXrandr alsa-lib pciutils-libs libXcursor atk at-spi2-atk pango cairo gdk-pixbuf2 gtk3
  132. ```
  133. 2. **Install Clipboard Support:**
  134. ```bash
  135. sudo dnf install -y wl-clipboard # Wayland
  136. sudo dnf install -y xclip # X11 fallback
  137. ```
  138. 3. **Setup Wayland:**
  139. ```bash
  140. export SDL_VIDEODRIVER=wayland
  141. export UE_Linux_EnableWaylandNative=1
  142. ```
  143. 4. **Build and Launch:**
  144. ```bash
  145. ./UnrealEditor -vulkan
  146. ```
  147. ## Usage
  148. ### Opening the Claude Panel
  149. Menu → Tools → Claude Assistant
  150. <img width="580" height="340" alt="{778C8E0B-C354-4AD1-BBFF-B514A4D5FC16}" src="https://github.com/user-attachments/assets/2087ef40-9791-4ad9-933b-2c64370344e8" />
  151. ### Example Prompts
  152. ```
  153. How do I create a custom Actor Component in C++?
  154. What's the best way to implement a health system using GAS?
  155. Explain World Partition and how to set up streaming for an open world.
  156. Write a BlueprintCallable function that spawns particles at a location.
  157. How do I properly use TObjectPtr<> vs raw pointers in UE5.7?
  158. ```
  159. ### Input Shortcuts
  160. | Shortcut | Action |
  161. |----------|--------|
  162. | `Enter` | Send message |
  163. | `Shift+Enter` | New line in input |
  164. | `Escape` | Cancel current request |
  165. ## Features
  166. ### Session Persistence
  167. Conversations are automatically saved to your project's `Saved/UnrealClaude/` directory and restored when you reopen the editor. The plugin maintains conversation context across sessions.
  168. ### Project Context
  169. UnrealClaude automatically gathers information about your project:
  170. - Source modules and their dependencies
  171. - Enabled plugins
  172. - Project settings
  173. - Recent assets
  174. - Custom CLAUDE.md instructions
  175. ### Scripting
  176. <img width="707" height="542" alt="{AB6AC101-4A4C-4607-BFB6-187D49F5E65B}" src="https://github.com/user-attachments/assets/e0c2e398-8fcd-4ac6-ade7-d50870215ec1" />
  177. Claude can write, compile (C++ via Live Coding), and run Python / Console / Editor Utility scripts — each gated by a **permission dialog** (deny-by-default; see *Auto-approve script execution* under [Configuration](#configuration)).
  178. > **Note — scripting & console tools are hidden by default.** The MCP bridge does **not** advertise `execute_script`, `run_console_command`, `cleanup_scripts`, or `get_script_history` to the model. They're a deliberate power-user fallback, kept off in releases so the model uses the structured editor tools (and to keep the tool list small). They remain *callable by exact name*, and every execution still passes through the C++ permission dialog. To surface them to the model, move the names out of `HIDDEN_TOOL_NAMES` in `Resources/mcp-bridge/tool-router.js`. **`run_console_command` can reach the Python interpreter (`py …`) — treat un-hiding it as enabling arbitrary code execution; keep it to trusted setups only.**
  179. ### MCP Server
  180. The plugin includes a Model Context Protocol (MCP) server with 20+ tools that expose editor functionality to Claude and external tools. The MCP server runs on port 3000 by default and starts automatically when the editor loads.
  181. **Tool Categories:**
  182. - **Actor Tools** - Spawn, move, delete, inspect, and set properties on actors
  183. - **Level Management** - Open levels, create new levels from templates, list available templates
  184. - **Blueprint Tools** - Create and modify Blueprints (variables, functions, nodes, pins)
  185. - **Animation Blueprint Tools** - Full state machine editing (states, transitions, conditions, batch operations)
  186. - **Asset Tools** - Search assets, query dependencies and referencers with pagination
  187. - **Character Tools** - Character configuration, movement settings, and data queries
  188. - **Material Tools** - Material and material instance operations
  189. - **Enhanced Input Tools** - Input action and mapping context management
  190. - **Utility Tools** - Console commands, output log, viewport capture, script execution
  191. - **Async Task Queue** - Background execution for long-running operations
  192. For full MCP tool documentation with parameters, examples, and API details, see [UnrealClaude's MCP Bridge](https://github.com/Natfii/ue5-mcp-bridge) repository.
  193. #### Dynamic UE 5.7 Context System
  194. The MCP bridge includes a dynamic context loader that provides accurate UE 5.7 API documentation on demand. Use `unreal_get_ue_context` to query by category (animation, blueprint, slate, actor, assets, replication) or search by keywords. Context status is shown in `unreal_status` output.
  195. ## Configuration
  196. ### Project Settings
  197. In **Project Settings → Plugins → Unreal Claude**:
  198. - **Auto-approve script execution** (default: OFF) — when ON, every Python / C++ / Console / Editor Utility script triggered through the MCP bridge or the in-editor chat runs immediately without showing the permission dialog. Each auto-approved script writes a `LogUnrealClaude` Log entry with its type and description so the audit trail is preserved. Designed for trusted MCP-driven / agent-driven workflows where the per-script confirmation becomes dominant friction; **only enable on machines and projects where the connected client is trusted**.
  199. The setting is persisted to `Config/DefaultEditor.ini` under `[/Script/UnrealClaude.UnrealClaudeSettings]`.
  200. ### Custom System Prompts
  201. You can extend the built-in UE5.7 context by creating a `CLAUDE.md` file in your project root:
  202. ```markdown
  203. # My Project Context
  204. ## Architecture
  205. - This is a multiplayer survival game
  206. - Using Dedicated Server model
  207. - GAS for all abilities
  208. ## Coding Standards
  209. - Always use UPROPERTY for Blueprint access
  210. - Prefix interfaces with I (IInteractable)
  211. - Use GameplayTags for ability identification
  212. ```
  213. ### Allowed Tools
  214. By default, the plugin runs Claude with these tools: `Read`, `Write`, `Edit`, `Grep`, `Glob`, `Bash`. You can modify this in `ClaudeSubsystem.cpp`:
  215. ```cpp
  216. Config.AllowedTools = { TEXT("Read"), TEXT("Grep"), TEXT("Glob") }; // Read-only
  217. ```
  218. ## How It Works
  219. 1. User enters a prompt in the editor widget
  220. 2. Plugin builds context from UE5.7 knowledge + project information
  221. 3. Executes: `claude -p --skip-permissions --append-system-prompt "..." "your prompt"`
  222. 4. Claude Code runs with your project as the working directory
  223. 5. Response is captured and displayed in the chat panel
  224. 6. Conversation is persisted for future sessions
  225. ### Command Line Equivalent
  226. ```bash
  227. cd "C:\YourProject"
  228. claude -p --skip-permissions \
  229. --allowedTools "Read,Write,Edit,Grep,Glob,Bash" \
  230. --append-system-prompt "You are an expert Unreal Engine 5.7 developer..." \
  231. "How do I create a custom GameMode?"
  232. ```
  233. ## Troubleshooting
  234. ### "Claude CLI not found"
  235. 1. Verify Claude is installed: `claude --version`
  236. 2. Check it's in your PATH: `where claude`
  237. 3. Restart Unreal Editor after installation
  238. ### "Authentication required"
  239. Run `claude auth login` in a terminal to authenticate.
  240. ### Responses are slow
  241. Claude Code executes in your project directory and may read files for context. Large projects may have slower initial responses.
  242. You might also have too many global Claude Code plugins enabled (i.e. Superpowers, ralp-loop, context7). The context for those plugins
  243. getting injected can cause slowdowns up to 3+ minutes.
  244. ### Plugin doesn't compile
  245. Ensure you're on Unreal Engine 5.7. Supported platforms are Windows (Win64), Linux, and macOS.
  246. ### MCP Server not starting
  247. Check if port 3000 is available. The MCP server logs to `LogUnrealClaude`.
  248. ### MCP tools not available / Blueprint tools not working
  249. If Claude says the MCP tools are in its instructions but not in its function list:
  250. 1. **Install MCP bridge dependencies**: The most common cause is missing npm packages:
  251. ```bash
  252. cd YourProject/Plugins/UnrealClaude/Resources/mcp-bridge
  253. npm install
  254. ```
  255. 2. **Verify the HTTP server is running**: With the editor open, test:
  256. ```bash
  257. curl http://localhost:3000/mcp/status
  258. ```
  259. You should see a JSON response with project info.
  260. 3. **Check the Output Log**: Look for `LogUnrealClaude` messages:
  261. - `MCP Server started on http://localhost:3000` - Server is running
  262. - `Registered X MCP tools` - Tools are loaded
  263. 4. **Restart the editor**: After installing npm dependencies, restart Unreal Editor.
  264. ### Request Hangs
  265. New watchdog should warn about hung requests (60s). Make sure all files are on disk (DISABLE OneDrive, DropBox, etc.)
  266. ### Debugging the MCP Bridge
  267. The MCP bridge is also available as a [standalone repository](https://github.com/Natfii/ue5-mcp-bridge) with its own Vitest test suite. If you're experiencing bridge-level issues (tool listing, parameter translation, context injection), you can run the bridge tests independently:
  268. ```bash
  269. cd path/to/ue5-mcp-bridge
  270. npm install
  271. npm test
  272. ```
  273. This tests the bridge without requiring a running Unreal Editor.
  274. ## Contributing
  275. Feel free to fork for your own needs! Possible areas for improvement:
  276. - [x] Linux support (thanks [@bearyjd](https://github.com/bearyjd))
  277. - [x] Mac support (thanks [@lateralsummer](https://github.com/lateralsummer))
  278. - [ ] Additional MCP tools (current tools need refractoring, no new ones for now)
  279. ## License
  280. MIT License - See [LICENSE](UnrealClaude/LICENSE) file.
  281. ## Credits
  282. - Built for Unreal Engine 5.7
  283. - Integrates with [Claude Code](https://claude.ai/code) by Anthropic

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.