VynAI Documentation

🚀 Quick Start Guide

Get up and running with VynAI in under 5 minutes.

1. Create Your Account

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

2. Get Your API Key

After signing up, visit your dashboard to copy your unique API key.

3. Download the Plugin

Download the VynAI plugin for Unreal Engine from the link below.

📦 Installation

Plugin Installation

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

Project Structure

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

⚙️ Configuration

API Key Setup

Configure your VynAI API key in the Project Settings:

1. Open Edit > Project Settings
2. Navigate to Plugins > VynAI
3. Paste your API key in the API Key field
4. Set your preferred API Endpoint (default is fine for most users)
5. Click Save

Plugin Settings

🔧 API Reference

Blueprint Functions

VynAI provides several Blueprint nodes for easy integration:

Generate Texture

Generate AI Texture
├── Inputs:
│   ├── Prompt (String) - Description of the texture
│   ├── Size (Int) - Texture size (512, 1024, 2048)
│   └── Style (Enum) - Texture style
└── Outputs:
    ├── Texture (Texture2D) - Generated texture
    └── Success (Bool) - Operation result

Optimize Mesh

Optimize Static Mesh
├── Inputs:
│   ├── Mesh (Static Mesh) - Input mesh to optimize
│   └── Quality (Float) - Optimization quality (0.0-1.0)
└── Outputs:
    ├── Optimized Mesh (Static Mesh) - Optimized mesh
    └── Reduction Ratio (Float) - Polygon reduction ratio

Generate Material

Generate AI Material
├── Inputs:
│   ├── Base Texture (Texture2D) - Base texture
│   ├── Material Type (Enum) - Material type
│   └── Parameters (Struct) - Material parameters
└── Outputs:
    ├── Material (Material) - Generated material
    └── Success (Bool) - Operation result

C++ API

For C++ developers, VynAI provides a comprehensive API:

// Include the VynAI module
#include "VynAI.h"

// Get the VynAI subsystem
UVynAISubsystem* VynAI = GetGameInstance()->GetSubsystem<UVynAISubsystem>();

// Generate a texture
VynAI->GenerateTexture(
    TEXT("Rusty metal surface"), 
    1024, 
    EVynAITextureStyle::Realistic,
    FVynAITextureDelegate::CreateUObject(this, &AMyActor::OnTextureGenerated)
);

💡 Usage Examples

Example 1: Procedural Texture Generation

Generate textures for your materials using AI:

// Blueprint example
1. Add "Generate AI Texture" node
2. Set Prompt to "Stone brick wall with moss"
3. Set Size to 1024
4. Connect to "Create Dynamic Material Instance"
5. Apply to your mesh

Example 2: Mesh Optimization

Automatically optimize your static meshes:

// C++ example
void AMyActor::OptimizeMesh()
{
    UVynAISubsystem* VynAI = GetGameInstance()->GetSubsystem<UVynAISubsystem>();
    VynAI->OptimizeStaticMesh(
        MyStaticMesh,
        0.7f, // 70% quality
        FVynAIMeshDelegate::CreateUObject(this, &AMyActor::OnMeshOptimized)
    );
}

Example 3: Smart Material Creation

Create materials with AI assistance:

// Blueprint workflow
1. Create base texture with "Generate AI Texture"
2. Use "Generate AI Material" node
3. Set Material Type to "PBR"
4. Configure roughness, metallic, normal parameters
5. Apply to your objects

⚠️ Error Handling

Common Issues

Authentication Errors

• Invalid API Key: Check that your API key is correct in Project Settings
• Expired Subscription: Verify your subscription status in the dashboard
• Insufficient Credits: Purchase additional credits or upgrade your plan

Network Issues

• Connection Timeout: Check your internet connection
• API Unavailable: Visit our status page for service updates
• Rate Limiting: Reduce the frequency of API calls

Error Codes

✨ Best Practices

Performance Optimization

• Cache Results: Enable caching to avoid regenerating the same content
• Batch Operations: Group multiple requests when possible
• Async Workflows: Use async Blueprint nodes to avoid blocking the game thread
• LOD Generation: Generate multiple quality levels for different use cases

Credit Management

• Monitor Usage: Check your credit usage regularly in the dashboard
• Set Budgets: Implement credit limits in your project
• Preview Mode: Use lower quality settings for prototyping
• Efficient Prompts: Write clear, concise prompts for better results

Quality Guidelines

• Prompt Engineering: Use descriptive, specific language
• Reference Images: Provide reference materials when available
• Iterative Refinement: Start with basic prompts and refine
• Style Consistency: Use consistent style parameters across assets

🆘 Support & Community

Getting Help

System Requirements

• Unreal Engine: 4.27+ or 5.0+
• Platform: Windows, Mac, Linux
• Internet: Stable connection required
• RAM: 8GB minimum, 16GB recommended
• Storage: 100MB for plugin + cache space