Unrealgenaisupport

🚀 Unreal Engine Generative AI Support Plugin

This is a toolkit that integrates various generative AI models into Unreal Engine. It supports multiple AI service providers such as OpenAI, Anthropic (Claude), XAI, Meta AI (Llama), Deepseek, and Google Gemini, offering powerful functions for text generation, code generation, material generation, and node generation.

🚀 Quick Start

The Unreal Engine Generative AI Support Plugin is a powerful tool that integrates multiple generative AI models into Unreal Engine. It enables users to leverage the capabilities of various AI providers for different content creation tasks within the Unreal Engine environment.

✨ Features

1. Multi-model Support: Integrates multiple mainstream generative AI models.
2. Code Generation: Generates Blueprint scripts and C++ code through LLM.
3. Material Generation: Automatically creates materials/functions.
4. Text Generation: Used for descriptions, storylines, and other content creation.
5. Node Generation: Automatically generates and configures node networks.
6. Plugin Manager Integration: Can be installed via the plugin marketplace and supports offline mode.

📦 Installation

Obtain from Unreal Marketplace

• Open the Unreal Engine editor.
• Navigate to "Window -> Asset Store".
• Search for and download the "Generative AI Support" plugin.

Manual Installation

• Download the compressed package.
• Extract it to the "Content/Plugins" folder in your project directory.

📚 Documentation

Configuration Guide

Environment Variable Setup

export OPENAI_API_KEY="your_key_here"

This will be automatically loaded when the Unreal Engine editor starts.

Configure Plugin Settings

• Open the plugin's settings interface.
• Fill in the necessary API keys and preference settings.
• Enable/disable the required functional modules.

Advanced Features

OpenAI Integration

• Supports models like GPT - 4, GPT - 4 Turbo, GPT - 3.5.
• Provides a full context window and supports complex conversation flows.
• Supports file attachments and uploads.

Anthropic Integration

• Uses Claude series models for code generation.
• Automatically handles errors and provides alternatives.
• Directly generates Blueprint node networks.

XAI Integration

• Utilizes XAI's API for material generation.
• Supports multiple model versions, such as "grok - 3 - latest".

Gemini and Llama Support

• Integrates Google's Gemini model.
• Performs inference using the local Llama model.

Deepseek Support

• Supports Deepseek's multilingual models.
• Offers full context window support.

Model Control Protocol (MCP)

• Supports tools like Claude Desktop App and Cursor.
• Automatically starts the MCP server (optional).
• Provides a Python script interface.

Known Issues

• Node connection issues
• Lack of undo/redo functionality
• Context window issues in Deepseek inference
• Complexity limitations in material generation

Development Guide

Set Up the Development Environment

1. Install the necessary Python packages:

pip install unreal

2. Configure the Python interpreter in your IDE to support intelligent code completion.
3. Familiarize yourself with the project structure and code organization.

References

• The environment variable setup refers to OpenAI - Api - Unreal.
• The inspiration for the MCP server comes from Blender - MCP.

Quick Links

• OpenAI API Documentation
• Anthropic Documentation
• XAI Documentation
• Meta AI Documentation
• Google Gemini Documentation

Contribution Guide

Developers are welcome to fork the project, submit Pull Requests, and report ISSUEs.