Home / Documentation Alpha
📖

Introduction#

VynAI is an AI-powered assistant for Unreal Engine that helps developers work faster and smarter. Currently in alpha phase, VynAI focuses on two core pillars of the engine:

💡

Alpha Release: VynAI is currently focusing on stabilizing Blueprint Scripting and Level Editor features before expanding to other asset types.

Current Features

🛠 Blueprint Scripting

  • Generate Blueprint nodes from natural language
  • Create functions and variables automatically
  • Link nodes and build logic flows
  • Detect and fix Blueprint errors

🌎 Level Editor

  • Manipulate actors in your scene
  • Organize World Outliner hierarchy
  • Spatial placement via simple commands
  • Batch operations on multiple actors
🚀

Quick Start Guide#

Get up and running with VynAI in just a few minutes.

  1. Create Your Account

    Sign up for a VynAI account and choose a subscription plan that fits your needs.

    Create Account
  2. Get Your API Key

    After signing up, visit your dashboard to copy your unique API key. Keep this key secure and never share it publicly.

    Go to Dashboard
  3. Download the Plugin

    Download the VynAI plugin for your version of Unreal Engine from the downloads section.

    Installation Guide
  4. Start Using VynAI

    Open the VynAI panel in Unreal Engine and start giving commands in natural language!

📦

Installation#

Plugin Installation

  1. Download the VynAI plugin package (.zip file) from your dashboard
  2. Extract the plugin to your project's Plugins folder
  3. Restart Unreal Engine
  4. Enable the VynAI plugin in Edit > Plugins > VynAI

Project Structure

After installation, your project structure should look like this:

Structure
YourProject/
├── Plugins/
│   └── VynAI/
│       ├── VynAI.uplugin
│       ├── Source/
│       │   ├── VynAI/
│       │   └── VynAIEditor/
│       ├── Content/
│       └── Resources/
├── Content/
└── Source/

Opening the VynAI Panel

Once installed, access VynAI through:

  • Menu: Window > VynAI Assistant
  • Shortcut: Ctrl + Shift + V (customizable)

Important: Make sure to restart Unreal Engine after installing the plugin. The editor needs to compile the plugin modules before they become available.

🔑

API Key Setup#

Configure your VynAI API key to enable AI features in your project.

  1. Open Edit > Project Settings
  2. Navigate to Plugins > VynAI
  3. Paste your API key in the API Key field
  4. Click Save
💡

Where to find your API key: Your API key is available in your VynAI Dashboard under the API section.

🚫

Security Warning: Never commit your API key to version control or share it publicly. Use environment variables or secure configuration files for production builds.

Plugin Settings#

Configure VynAI to match your workflow.

Setting Description Default
API Key Your unique VynAI API key for authentication Empty
Auto-Execute Automatically execute generated commands false
Show Preview Preview changes before applying them true
Undo Support Enable undo/redo for AI operations true
Debug Mode Enable detailed logging for troubleshooting false
🛠

Blueprint Scripting - Overview#

VynAI can assist you with Blueprint visual scripting by understanding natural language commands and translating them into Blueprint operations.

What VynAI Can Do

  • Generate Nodes: Create any Blueprint node from a description
  • Create Functions: Build custom functions with inputs/outputs
  • Manage Variables: Create, modify, and link variables
  • Build Logic: Connect nodes to create complete logic flows
  • Fix Errors: Detect and correct Blueprint compilation errors

Example Commands

Natural Language
"Create a function that takes a float Speed and returns a vector"

"Add an OnBeginOverlap event and print the overlapping actor's name"

"Create a branch node that checks if Health is less than 20"

"Make a for loop that iterates through all actors in the scene"

"Fix the errors in my current Blueprint"

Node Generation#

Generate Blueprint nodes using natural language descriptions.

Basic Node Creation

Simply describe what you want, and VynAI will create the appropriate nodes:

Your Command Generated Node
"Add a print string node" Print String
"Get the player character" Get Player Character
"Create a delay of 2 seconds" Delay (Duration: 2.0)
"Spawn an actor at this location" Spawn Actor from Class
"Check if the actor is valid" IsValid

Complex Node Chains

You can also describe entire logic flows:

Command
"When the player presses E, check if they're near an interactable
object, and if so, call the Interact function on it"

VynAI will generate:

  • Input Action node for "E" key
  • Sphere Overlap check
  • IsValid branch
  • Interface call to Interact

Tip: Be specific in your descriptions. "Create a timer that calls MyFunction every 0.5 seconds" works better than "make something repeat".

📈

Functions & Variables#

Creating Functions

VynAI can create complete functions with proper inputs, outputs, and internal logic:

Command
"Create a function called CalculateDamage that takes a base damage
float and an armor float, then returns the final damage after
armor reduction"

This will create:

  • Function named CalculateDamage
  • Input: BaseDamage (Float)
  • Input: Armor (Float)
  • Output: FinalDamage (Float)
  • Internal calculation logic

Managing Variables

Command Result
"Create a float variable called Health with default 100" Float variable, default value 100
"Make an array of actors called Enemies" Actor Array variable
"Create a boolean IsAlive, set it to true" Boolean variable, default true
"Add a reference variable for the player" Object Reference variable

Linking Variables

Connect variables to your logic flow:

Command
"Connect the Health variable to the progress bar percentage"

"Use the Speed variable as the movement input multiplier"

"Set IsAlive to false when Health reaches zero"
🐛

Error Correction#

VynAI can detect and fix common Blueprint errors automatically.

Automatic Error Detection

Simply tell VynAI to analyze your Blueprint:

Command
"Fix the errors in this Blueprint"

"Why isn't my Blueprint compiling?"

"Find and fix the broken connections"

Common Issues VynAI Can Fix

  • Disconnected Pins: Reconnects broken node connections
  • Type Mismatches: Adds conversion nodes where needed
  • Missing References: Identifies null reference issues
  • Infinite Loops: Detects and warns about potential loops
  • Unused Variables: Cleans up orphaned variables

Review Changes: Always review VynAI's suggested fixes before applying them. Enable "Show Preview" in settings to see changes before they're made.

🌎

Level Editor - Overview#

VynAI can help you manipulate your level directly through natural language commands, making scene setup and organization faster.

What VynAI Can Do

  • Actor Manipulation: Move, rotate, scale, and duplicate actors
  • World Outliner: Organize hierarchy, create folders, rename actors
  • Spatial Placement: Position actors using descriptive commands
  • Batch Operations: Apply changes to multiple actors at once

Example Commands

Natural Language
"Move the selected actor 500 units forward"

"Create a folder called 'Environment' and move all static meshes into it"

"Duplicate this light 5 times in a row with 200 unit spacing"

"Rotate all chairs to face the table"

"Align all these actors to the grid"
🎲

Actor Manipulation#

Control actors in your scene with simple commands.

Transform Operations

Command Action
"Move this up by 100 units" Translates on Z axis +100
"Rotate 45 degrees on the Z axis" Yaw rotation +45
"Scale to 2x size" Uniform scale to 2.0
"Place at world origin" Position (0, 0, 0)
"Match the rotation of the player start" Copies rotation from PlayerStart

Actor Operations

Commands
"Duplicate this actor"

"Delete all actors named 'Cube_*'"

"Hide all lights in the scene"

"Select all static mesh actors"

"Rename this to 'MainEntrance'"
💡

Selection Context: VynAI operates on your current selection. Select actors first, then give your command, or specify actors by name.

📂

World Outliner#

Organize your scene hierarchy efficiently with voice commands.

Folder Management

Commands
"Create a folder called 'Lighting'"

"Move all point lights to the Lighting folder"

"Create subfolders: Interior, Exterior, Ambient under Lighting"

"Collapse all folders"

"Delete empty folders"

Actor Organization

Command Result
"Group selected actors" Creates a group from selection
"Attach this to the car" Parents actor to 'car' actor
"Detach from parent" Removes parent relationship
"Sort actors by type" Organizes into type-based folders
📍

Spatial Placement#

Position actors using intuitive spatial descriptions.

Relative Positioning

Commands
"Place this in front of the door"

"Position the light above the table"

"Put the trigger behind the player start"

"Center this between the two columns"

"Snap to the floor"

Pattern Placement

Create arrangements of actors quickly:

Commands
"Create a circle of 8 torches with radius 500"

"Arrange these in a 3x3 grid with 100 unit spacing"

"Duplicate along this spline"

"Scatter 20 rocks randomly in this area"

"Line up these chairs evenly"

Pro Tip: Combine commands for complex operations: "Create a circle of 12 pillars, 800 radius, all facing the center"

Error Codes#

Reference for VynAI error codes and their solutions.

Code Description Solution
401 Unauthorized - Invalid or missing API key Verify your API key in Project Settings
402 Payment Required - Insufficient credits Purchase more credits from your dashboard
403 Forbidden - Subscription expired Renew your subscription
429 Rate Limited - Too many requests Wait a moment and try again
500 Server Error - Internal issue Retry later or contact support
VYNAI-001 Command not understood Rephrase your command more clearly
VYNAI-002 No actors selected Select actors before running command
VYNAI-003 Blueprint not open Open a Blueprint before using BP commands
🔧

Common Issues#

Authentication Errors

  • Invalid API Key: Double-check that your API key is correctly entered in Project Settings
  • Expired Subscription: Verify your subscription status in the dashboard
  • Insufficient Credits: Purchase additional credits or upgrade your plan

Command Issues

  • "Command not understood": Try rephrasing with more specific terms
  • Wrong action performed: Use more precise language, specify exact names
  • Nothing happens: Check if you have the correct context (Blueprint open, actors selected)

Plugin Issues

  • Plugin Not Found: Ensure the plugin is in the correct Plugins folder
  • VynAI Panel Missing: Check Window menu or restart the editor
  • Commands are slow: Check your internet connection

Best Practices#

Writing Good Commands

  • Be Specific: "Create a float variable called PlayerHealth" works better than "make a variable"
  • Use Unreal Terms: Use terms like "actor", "component", "node", "pin" that match UE vocabulary
  • One Task at a Time: Break complex operations into smaller, clear commands
  • Name Things: Reference actors and variables by their exact names when possible

Workflow Tips

  • Enable Preview: Keep "Show Preview" on to review changes before applying
  • Use Undo: All VynAI operations support Ctrl+Z undo
  • Save Often: Save your work before running batch operations
  • Iterate: It's okay to run multiple commands to refine the result

Performance

  • Batch Wisely: Group similar operations instead of running them one by one
  • Select First: Pre-select actors before giving commands to avoid name lookups
  • Keep It Simple: Simple commands execute faster than complex multi-step ones
🛣

Roadmap#

VynAI is in active development. Here's what's currently available and what's coming next.

Current Release (Alpha)

  • Blueprint Scripting - Node generation, functions, variables, error correction
  • Level Editor - Actor manipulation, World Outliner, spatial placement

Coming Soon

Feature Description Status
Static Meshes AI-assisted mesh creation and modification Planned
Materials & Shaders Generate and edit materials with natural language Planned
Textures AI texture generation and manipulation Planned
VFX / Niagara Particle system creation and editing Future
Animation Animation Blueprint assistance Future
💬

Have a feature request? Join our Discord community or email us at feedback@vynai.com to let us know what you'd like to see next!

💬

Get Help#

Need assistance? We're here to help.

Email Support

Get direct help from our technical team.

Contact Support

Community Discord

Join our community for tips and discussions.

Join Discord

Knowledge Base

Search our comprehensive help articles.

Browse Articles

Bug Reports

Report issues and track fixes.

Report Bug
📋

System Requirements#

Requirement Minimum Recommended
Unreal Engine 5.0+ 5.3+
Operating System Windows 10, macOS 12 Latest versions
RAM 16 GB 32 GB+
Storage 100 MB (plugin) 500 MB+ (with cache)
Internet Stable connection Broadband (10+ Mbps)