OpenAI-Api-Unreal  by KellanM

Unreal Engine plugin for OpenAI API integration

created 4 years ago
744 stars

Top 47.6% on sourcepulse

GitHubView on GitHub
Project Summary

This plugin provides integration for the OpenAI API within Unreal Engine, enabling developers to leverage advanced AI capabilities like text generation, image creation, and speech transcription directly in their games and applications. It targets Unreal Engine developers seeking to incorporate cutting-edge AI features without leaving the engine's ecosystem.

How It Works

The plugin utilizes asynchronous HTTP requests to interact with various OpenAI API endpoints, including Completions (GPT-3, GPT-4), DALL·E 2 for image generation, and Whisper for speech-to-text. It exposes these functionalities through Blueprint nodes, allowing for easy integration into game logic and workflows. The approach simplifies complex API interactions into user-friendly Blueprint components.

Quick Start & Requirements

  • Installation: Copy the pre-built plugin binaries into the YourProject/Plugins/ directory.
  • Prerequisites: Unreal Engine versions 4.26 through 5.3.
  • Authentication: API key can be set directly in Blueprints or via the OPENAI_API_KEY environment variable.
  • Documentation: Video Tutorial (Note: Tutorial may be out of date).

Highlighted Details

  • Supports runtime image generation with DALL·E 2.
  • Enables speech transcription using Whisper v2-large.
  • Facilitates powering NPCs with GPT-4 and GPT-3.5-Turbo via the chat endpoint.
  • Offers Blueprint nodes for API calls, completion settings, and result parsing.

Maintenance & Community

This is a community plugin with no official affiliation with OpenAI.

Licensing & Compatibility

The license is not explicitly stated in the README. Compatibility is confirmed for Windows, Mac, and Android platforms within Unreal Engine.

Limitations & Caveats

Streaming functionality for completions is listed as "supported soon." The provided video tutorial is noted as potentially out of date, requiring users to rely on the Blueprint examples for current usage. Security advice is given regarding API key encryption before packaging.

Health Check
Last commit

11 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
2
Star History
23 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.