UnrealClaude  by Natfii

AI coding assistant for Unreal Engine 5.7

Created 2 months ago
271 stars

Top 95.1% on SourcePulse

GitHubView on GitHub
Project Summary

UnrealClaude integrates Anthropic's Claude Code CLI directly into Unreal Engine 5.7, providing AI-powered coding assistance with built-in documentation context. It targets Unreal Engine developers seeking to enhance productivity by leveraging AI for tasks like code generation, Blueprint manipulation, and asset management directly within the editor. The primary benefit is seamless AI integration without context switching, powered by a robust system for understanding and interacting with the UE5.7 environment.

How It Works

This plugin shells out to the claude command-line tool, utilizing existing Claude Code authentication. It features a Model Context Protocol (MCP) server that exposes over 20 editor-specific tools for manipulating actors, Blueprints, levels, and assets. A dynamic context system provides on-demand UE 5.7 API documentation, allowing Claude to generate contextually relevant responses. Prompts are processed by gathering project context and UE5.7 knowledge, then executing the claude CLI with specific flags and appended system prompts.

Quick Start & Requirements

  • Prerequisites:
    • Unreal Engine 5.7.
    • Node.js and npm.
    • Claude Code CLI: Install via npm install -g @anthropic-ai/claude-code and authenticate with claude auth login.
    • Platform-specific build tools.
  • Installation:
    1. Clone the repository with submodules: git clone --recurse-submodules https://github.com/Natfii/UnrealClaude.git.
    2. Build the plugin using platform-specific RunUAT commands (e.g., Engine\Build\BatchFiles\RunUAT.bat BuildPlugin ... for Windows).
    3. Copy the build output to your project's Plugins/ directory (recommended) or the engine's Plugins/Marketplace/ folder.
    4. Install MCP bridge dependencies: cd <PluginPath>/UnrealClaude/Resources/mcp-bridge && npm install.
    5. Launch the Unreal Engine editor.
  • Supported Platforms: Windows (Win64), Linux, macOS (Apple Silicon). Specific setup instructions are available in INSTALL_MAC.md and INSTALL_LINUX.md.

Highlighted Details

  • Native Editor Integration: A docked chat panel offers live-streaming responses, tool call grouping, and code block rendering.
  • MCP Server: Provides 20+ tools for actor manipulation, Blueprint/Animation Blueprint editing, level management, asset querying, material operations, and input configuration.
  • Dynamic UE 5.7 Context: Offers accurate, on-demand UE 5.7 API documentation.
  • Script Execution: Claude can write, compile (via Live Coding), and execute scripts with user permission.
  • Session Persistence: Conversation history is automatically saved and restored across editor sessions.
  • Project-Awareness: Gathers context from project modules, plugins, assets, and editor viewports.

Maintenance & Community

The repository is open for forking ("Feel free to fork for your own needs!"). No specific details regarding active maintainers, community channels (like Discord/Slack), or a formal roadmap are provided in the README.

Licensing & Compatibility

The project is released under the MIT License, which is permissive for commercial use and integration into closed-source projects. It is specifically built for and compatible with Unreal Engine 5.7.

Limitations & Caveats

Blueprint editing functionality is noted to have "few bugs" and should not be fully relied upon. The plugin requires building from source, as no pre-built binaries are provided. Performance may degrade on very large projects due to the Claude Code CLI's file access for context gathering. The MCP server requires port 3000 to be available and specific npm packages to be installed.

Health Check
Last Commit

4 days ago

Responsiveness

Inactive

Pull Requests (30d)
5
Issues (30d)
7
Star History
226 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.