LogoLogo
PlaygroundVideosBlogPricing
  • Welcome
  • Convai Playground
    • Playground Walkthrough
    • Get Started
    • Character Creator Tool
      • Create Character
      • Language and Speech
      • Knowledge Bank
      • Personality and Style
      • State of Mind
      • Memory
      • Actions
      • Narrative Design
      • Character Versioning
    • F.A.Q
  • Plugins & Integrations
    • Introduction
    • Unity Plugin
      • Pre-Requisites
      • Compatibility
      • Downloads
        • Limitations of WebGL Plugin
      • Setting Up Unity Plugin
      • Troubleshooting Guide
        • Disable Assembly Validation
        • Missing Newtonsoft Json
        • Microphone Permission Issues
        • Default Animations Incompatibility
        • Animations have Facial Blendshapes
        • Jaw Bone in Avatar is not Free
        • macOS Permission Issues
      • Creating a Convai Powered Scene from Template
      • Importing Ready Player Me (RPM) Characters
      • Importing Custom Characters
      • Adding Actions to your Character
      • Adding Lip-Sync to your Character
      • Adding Narrative Design to your Character
        • Narrative Design Keys
      • Adding NPC to NPC Conversation
      • Adding Scene Reference and Point-At Crosshairs
      • Utilities
        • Character Emotion
        • Player Data Container
        • Long Term Memory
        • Language Support
        • Managing sessionID Locally
        • Transcript UI System
        • Pre-built UI Prefabs
        • Input Management
        • Notification System
        • Settings Panel
        • Dynamic Information Context
      • Building For Supported Platforms
        • Building for iOS/iPadOS
        • Building for WebGL
        • Convai XR
          • Building for VR
            • VR Automatic Installation
            • VR Manual Installation
          • Building for MR
            • MR Automatic Installation
            • MR Manual Installation
          • Building for AR
          • Interacting with XR UI Elements
        • Building for macOS Universal apps
      • Changelogs
      • Tutorials
        • Narrative Design
        • NPC2NPC
    • Unreal Engine
      • Supported Platforms
      • Installation
      • Guides
        • Dynamic Environment Info
        • Change AI Character Movement Speed
        • Integration with Pixel Streaming
        • Adjust Interaction Radius
        • Creating MetaHuman Characters
          • Adding MetaHuman
          • Adding LipSync to MetaHuman (From plugin version 3.0.0 or later )
          • Change the Parent Class for MetaHuman
          • Change the parent class for Player.
          • Adding LipSync to MetaHuman (Deprecated)
        • Creating ReadyPlayerMe Characters
          • Download Plugins
          • Adding ReadyPlayerMe Character
          • Change the parent class for Player.
        • Creating Reallusion Characters
          • Creating a Reallusion Character
          • Importing Reallusion character and setting up the Convai plugin
          • Binding objects to Reallusion Character
        • Event-Aware Convai Characters
        • Operations Based on the Presence of Certain Words
        • Narrative Design
          • Narrative Design Trigger
          • Narrative Design Keys
        • Actions Guide
          • Stage 1: Default Actions
            • Moves To
            • Follows
          • Stage 2: Custom Actions
            • Simple actions
            • Adding Descriptions to Actions
          • Stage 3: Custom Actions with Single Parameter
          • Main Character and Attention Object
        • Customization
          • Push to Talk
          • Alter Character Response Audio Rate
        • Speech To Text Transcription
        • Enable Multiplayer Support
        • 3D Chat Widget
        • Long Term Memory
        • Saving and Loading Session
      • Blueprints Reference
        • Convai Player
        • Convai Chatbot
        • Convai Environment
        • Convai Object Entry
        • Convai Result Action
        • Convai Extra Params
        • Speech To Text
        • Text To Speech
        • Utility Functions
      • Troubleshoot Guide
        • Missing Unreal Engine Tool Set in Microsoft Visual Studio Toolchain
        • Convai Module Not Found
        • MetaHuman Plugin Conflict
        • Failure to Load Character IDs
      • Microphone Settings
        • Set Audio Gain
        • Set Microphone
        • Microphone test
        • List Microphone Devices
      • Mac Microphone Permission: Required for UE 5.0 and 5.3
      • Guides V2 (Under Development)
        • Getting Started
          • Installation
          • Simple Talking Cube
          • Adding Premade Chat and Settings UI
    • Web Plugin
      • PlayCanvas Plugin
        • Adding External Script
        • First Person View
        • Adding characters to scene
        • Character Animations
        • Convai Integration
        • Chat Overlay
      • Convai Web SDK
        • Getting Started
        • Facial Expressions
        • Actions
      • JavaScript Chat UI SDK
        • Getting Started
        • ChatBubble Props
      • Narrative Design Guide
        • Narrative Design Triggers
        • Narrative Design Keys
      • GLB Characters for Convai
      • GLB/FBX animations for Convai
    • Modding Framework
      • Modding Cyberpunk 2077
    • Other Integrations
      • Roblox
        • Sample Game 1
        • Sample Game 2
        • Code Example
          • Character Conversation API
      • Discord
        • Create a Discord Bot
        • Hosting Discord Bot from Personal Server
        • Hosting Discord Bot from Replit
      • Omniverse Extension
      • Third-Party API Integrations
        • ElevenLabs API Integration
  • Reference
    • Core API Reference
      • Character Base API
      • Interaction API
      • Core AI Setting API
      • Backstory API
      • Chat History API
      • Knowledge Bank API
      • Narrative Design API
      • Action API
      • Language List API
      • Voice List API
      • Character List API
      • Evaluation API
Powered by GitBook
On this page
  • Version 3.2.4 (Current)
  • Announcement:
  • Version 3.2.3
  • Bug Fix:
  • Version 3.2.2
  • Bug Fix:
  • Version 3.2.1
  • New Features:
  • Bug Fixes:
  • Version 3.2.0
  • New Features
  • Improvements
  • Hotfix
  • Version 3.1.2
  • Hotfix
  • Version 3.1.1
  • Hotfix
  • Version 3.1.0
  • What's Changed
  • Improvements
  • Bug Fixes and Improvements
  • Version 3.0.1
  • Bug Fixes and Improvements
  • Version 3.0.0
  • What's Changed
  • Improvements
  • Bug Fixes
  • Version 2.1.0
  • What's Changed
  • Bug Fixes and Improvements
  • Version 2.0.0
  • What's Changed
  • Bugs and Improvement

Was this helpful?

  1. Plugins & Integrations
  2. Unity Plugin

Changelogs

Convai Unity Plugin Changelogs - Stay updated with the latest changes.

Version 3.2.4 (Current)

Released: March 5, 2025

Announcement:

  • We are transitioning away from the Ready Player Me (RPM) - based character creator in the Convai Playground to a significantly higher-quality character creation system. As a result, the Character Importer, which previously allowed importing RPM-created characters from the Playground, will no longer be supported.


Version 3.2.3

Released: January 30, 2025

Bug Fix:

  • Fixed version of the Ready Player Me package to ensure compatibility


Version 3.2.2

Released: January 23, 2025

Bug Fix:

  • Fixed Character Importer Issue.


Version 3.2.1

Released: January 20, 2025

New Features:

  • Core API Access Implementation

Bug Fixes:

  • Fixed Pause and Resume functionality

  • Fixed Ready Player Me package auto-update issue in Character Importer


Version 3.2.0

Released: October 31, 2024

New Features

  • Implemented Dynamic Config Feature:

    • This feature allows you to dynamically pass variables to NPCs. For example, you can update NPCs with the player’s current health, inventory items, or information about the world, enhancing interactivity and immersion.

  • Implemented Narrative Design Keys:

    • This feature enables dynamic variable passing within the Narrative Design section and triggers. For instance, you can use placeholders like {TimeOfDay} to create personalized dialogues, such as "Welcome, player! How is your {TimeOfDay} going?"

  • Added MR Demo Scene

  • Added MR Automatic Installation and Manual Installation

  • Added Convai XR Package (compatibility with Meta SDK and other XR SDKs provided)

Improvements

  • Added Long Term Memory API(s) to View and Delete Speaker ID(s)

  • Improved VR Manual Installation

  • Improved Custom Package Installation

Hotfix

  • Minor Bug Fixes


Version 3.1.2

Released: September 16, 2024

Hotfix

Minor Bug Fixes


Version 3.1.1

Released: September 12, 2024

Hotfix

Fixed NPC2NPC response delay


Version 3.1.0

Released: Aug 28, 2024

What's Changed

  • New Convai Setup Editor Window

  • Long term memory (beta) integration in Unity SDK

  • ChatBox UI revamp with RTL support

  • Input system revamp and Mobile UI improvements

Improvements

  • UI Improvements

    • Revamped ChatBox UI

    • Improved mobile UI

    • Implemented chat disabling feature

    • Added usage limit exceeded notification

    • Dialog box added for no API Key scenario

  • API and Backend

    • Refactored ProcessUserQuery for better transcript handling

    • Implemented fuzzy matching for Action System

    • Ready Player Me and CC_Tools automatic import process

  • Character and Animation

    • Updated Character Importer Pipeline

    • Added OVR effectors for RPM characters

    • Fixed animators for all characters

    • Provided Weight Multiplier for LipSync user preference

    • RPM Characters will have Lipsync added when imported

Bug Fixes and Improvements

  • Bug Fixes

    • Fixed character resuming dialogue after toggle

    • Fixed section deletion issue in NarrativeDesignManager

    • Fixed layer issues

    • Optimised Convai LipSync

  • Developer Tools and Workflow

    • Improved Convai Logger System

    • Updated namespace and formatting for all editor scripts

    • Removed CC Tools Folder and other temporary/junk files

    • Added "Update Triggers" button to NarrativeDesignTrigger inspector

    • Implemented approximate string matching for actions system

  • Miscellaneous

    • Added PlayerDataHandler and PlayerDataSO

    • Updated NPC positions and topics in demo scenes

    • Fixed Convai logo in Convai Setup window


Version 3.0.1

Released: Jun 21, 2024

Bug Fixes and Improvements

  • Fix macOS TMP UGUI render issue in demo scene

  • Prefab missing animator

  • Updated ActiveNPC layer check logic


Version 3.0.0

Released: Jun 13, 2024

What's Changed

NPC2NPC System

  • Implemented NPC2NPC conversation flow system.

  • Added handling for conversation interruptions and restarts.

  • Enhanced conversation history tracking and flow management.

Narrative Design

  • Added Narrative Design-related files and trigger narrative section function.

  • Refactored Narrative Design API, created new behavior trees for movement and added section change events.

  • Folder Restructuring

    • Complete folder and scripts folder restructure

  • Gender-Based Animator: Added gender-based Animator controller

  • Feedback System

    • Implemented a feedback system with thumb icons and animations

    • Updated Transcript UI Prefabs with feedback buttons

  • Convai Custom Packages: Updated Convai Custom Package Installer and added iOS DLL Downloader

  • Scene Perception: Added feature to allow players to point at game objects and talk about them

Improvements

  • Texture and Material Compression

    • Compressed Amelia and other images (POT and Crunch)

    • Updated image names and removed unused image assets

  • UI Updates

    • Updated UI prefabs, including Transcript UI, Mobile UI, and Mobile QA UI

    • Transcript UIs and text updated

    • Updated logos and logo paths

  • System Improvements

    • Refactored Lipsync system with added teeth support and implemented facial expression proto files

    • Updated ConvaiURPConverterPackage, burst and TMPro packages; Convai Custom Package Installer/Exporter

    • Updated NavMesh and NPC2NPC character rotation

    • Added new demo scene and RPM characters

    • Updated various demo scenes for consistency

  • Microphone Manager: Updated Microphone Manager to a singleton class

  • API Key Access: Simplified API Key access

  • Convai Scene Template: Created new scene template and dynamic input system assigner

  • Demo Scenes

    • Added NPC2NPC demo scene

    • Added Narrative Design demo scene

    • Added new demo scene with all features encompassed

    • "Convai Essentials" prefab for desktop and mobile

  • Lipsync Overhaul

    • Overhauled lipsync system, added AR-Kit and Reallusion character support

    • Updated version and added various improvements to frame processing

  • Input System

    • Added new input system pragma checks and Convai Character Layer

    • Simplified Input Manager and ensured future-proofing

Bug Fixes

  1. Transcript UI Bug Fixes: Fixed bugs and improved system for Transcript UI character list

  2. Microphone Permission: Fixed Android and iOS microphone permission issues


Version 2.1.0

What's Changed

  • VR Support: Implement Virtual Reality features to create a fully immersive experience with the press of a button.

  • AR Support: Integrate Augmented Reality capabilities, allowing characters and environments to interact with you in the real world with the press of a button.

  • Settings Panel: Introduce a comprehensive settings panel that allows users to customize their experience.

  • Microphone Test System: Incorporate a microphone testing feature to ensure optimal audio input quality.

  • Notification System: Implement a robust notification system to inform users of in-game events - specifically microphone-based issues.

  • Input Manager: Develop a custom input management system that supports various input devices such as keyboards, gamepads, and touchscreens using Unity's new Input System.

Bug Fixes and Improvements

  • Fixed: Head Tracking Doesn’t Work Without Action Component issue fixed.

  • Improvement: Added support for a customizable and dynamic Chatbox.

  • Improvement: Improved Lip-Sync Smoothing and audio-visual synchronization.

  • Improvement: Implement Action Events and Event Callbacks.

  • Improvement: Improved Logging System.

  • Improvement: Added ability to interrupt Character Response with Voice Interruption.

  • Improvement: Improved mobile platform transcription UI.


Version 2.0.0

What's Changed

  • Lip-sync: Integrate off-the-shelf Lip-sync for Reallusion and Oculus-based Characters.

  • Text-in Voice-out: Chat with the character using text.

  • Character Importer: Import Ready Player Me characters created on the Convai Playground.

  • Feature Control System: Enable Convai features as needed through the Convai NPC component.

  • Logging System: Have better control over what Convai information you see on the debug console.

  • Enhanced player controller: Automatically triggers the characters when you focus on them and then deactivates them when your focus has shifted.

  • URP Upgrader: Upgrade the Render Pipeline to Universal Render Pipeline with the URP Upgrader package (present in the Convai Folder).

  • UI Improvements: Improved user experience with automatically fading UI canvas.

Bugs and Improvement

  • Fixed: Unlocking the cursor will still cause the first-person camera to move around.

  • Fixed: Exiting play mode before the character is done speaking will cause Unity to crash or not complete compilation.

  • Fixed: Extra space between multiple chunks of text in the UI Text Fields.

  • Fixed: Actions crashing the Android scene.

  • Fixed: Empty responses from the server will not crash the game but only throw an error.

  • Improvement: Smoothened Blinking.

  • Improvement: Smoothened Gaze-Following-based Neck movement.

  • Improvement: Plugin structure reorganization.

PreviousBuilding for macOS Universal appsNextTutorials

Last updated 2 months ago

Was this helpful?