GenAI for Unreal - Home

GenAI for Unreal Banner

Welcome to the official documentation for GenAI for Unreal, the most comprehensive, up-to-date resource for integrating cutting-edge AI into your Unreal Engine projects. This plugin provides a powerful, unified framework that simplifies the process of connecting your games to industry-leading AI models from providers like OpenAI, Anthropic, and Google.

Whether you’re building dynamic NPC dialogue, procedurally generated quests, or next-generation audio and visual features, this guide is designed to help you ship remarkable AI-driven experiences with confidence. We cover everything from a five-minute quick start for beginners to advanced topics like response streaming, structured data, and secure key management for enterprise-level projects.


Getting Started

New to GenAI for Unreal? Here’s a recommended path to get you up and running:

  1. Quick Start πŸš€
    • Get your first AI-powered chat running in less than five minutes. This tutorial is perfect for verifying your setup and seeing the plugin in action.
  2. Initial Project Setup βš™οΈ
    • Follow our step-by-step guide to install the plugin, configure your C++ and Blueprint projects, and ensure all dependencies are correctly linked.
  3. Getting API Keys πŸ”‘
    • Learn how to obtain the necessary API keys from providers like OpenAI, Anthropic, and Google.
  4. Core Concepts πŸ’‘
    • Understand the fundamental principles of the plugin, including its asynchronous design, lifetime safety features for preventing crashes, and how to use custom AI models.
  5. Usage Guides & Examples πŸ“˜
    • Once you understand the core concepts, explore practical examples, walkthroughs, and project templates to see advanced features in action.

Why GenAI for Unreal?

GenAI for Unreal is more than just a toolβ€”it’s a complete solution designed to make advanced AI integration seamless, secure, and scalable.

  • Unified and Simplified API

    Say goodbye to writing boilerplate code for multiple AI services. Our plugin provides a single, intuitive API that works across OpenAI, Anthropic, DeepSeek, XAI, and Google Gemini. You can switch between providers with minimal code changes, allowing you to choose the best model for the job without vendor lock-in.

  • Full Blueprint & C++ Support

    We believe in empowering the entire development team. The plugin offers feature parity between Blueprints and C++, with self-managing asynchronous nodes that handle complex operations like network requests and response handling. This ensures that both engineers and designers can build and iterate on AI features with ease.

  • Built for Real-time Experiences

    Create truly interactive and immersive worlds with features like real-time text streaming for dynamic dialogue, multimodal vision support for analyzing in-game scenes, and structured JSON output for complex game logic. These tools are designed for the high-performance demands of modern games.

  • Secure Key Storing

    Security is a top priority. GenAI for Unreal includes a robust system for secure API key management that avoids storing sensitive information in plain text. For larger teams, our optional proxy support provides an additional layer of security and centralized control over API access.

  • Cross-Platform and Future-Proof

    Built with standard Unreal Engine modules, the plugin is designed for seamless cross-platform compatibility. As the AI landscape evolves, we are committed to providing continuous updates, ensuring you always have access to the latest models and features.

Quick Navigation

  1. Quick Start πŸš€ β€” Your First AI Chat in 5 Minutes
  2. Initial Project Setup βš™οΈ β€” Installation & C++ Configuration
  3. Getting API Keys πŸ”‘ β€” Obtain Keys from OpenAI, Anthropic, & More
  4. Authentication & Security πŸ”’ β€” Secure Key Storage & Proxying
  5. Core Concepts πŸ’‘ β€” Async Design, Lifetime Safety, Custom Models
  6. Usage Guides & Examples πŸ“˜ β€” Blueprint & C++ Walkthroughs
  7. Building Long Conversations πŸ“ β€” Chat Context Strategies
  8. Streaming ⚑️ β€” Real-Time Response Chunks
  9. Structured Output πŸ—‚οΈ β€” JSON Schema Enforcement
  10. Text-to-Speech & Transcription πŸ”Š β€” Audio I/O
  11. Image Generation 🎨 β€” AI-Powered Art
  12. Realtime Conversational AI 🎭 β€” Advanced Interactions
  13. How to Run Tests πŸ§ͺ β€” Verify Integration
  14. Quick Links & API Reference 🌐 β€” External Docs
  15. Additional Notes πŸ“‹ β€” Tips & Gotchas


× Full-size image