Documentation
Search
K

Omniverse Extension

This guide will show you how to integrate the Convai and NVIDIA Omniverse using the Convai Extension plugin.
Extension Overview

Installation

To install the Convai Omniverse Extension, follow these steps:
  1. 1.
    Download the latest version of the extension.
  2. 2.
    Extract the zip file into your chosen directory.
  3. 3.
    Open the Omniverse app of your choice (e.g Code) and from the Window menu click Extensions.
  4. 4.
    In the Extensions tab, click the gear icon in the top right.
  5. 5.
    Click the green plus icon in the Edit column and add the absolute path to the exts folder found in the repository directory.
  6. 6.
    Select the Third Party tab and search for Convai in the top left search bar, make sure to check Enabled.
  7. 7.
    The Convai window should appear, drag it and dock it in any suitable area of the UI.
  8. 8.
    If the Convai window does not appear, go to the Window menu and select Convai from the list.

Configuration

To add your API Key and Character ID, follow these steps:
  1. 1.
    Sign up at Convai.
  2. 2.
    On the website click the gear icon in the top-right corner of the playground then copy and paste the API key into the Convai API Key field in the Convai extension window.
  3. 3.
    Go to the Dashboard and on the left panel and either create a new character or select a sample one.
  4. 4.
    Copy the Character ID and paste it in the Character ID field in the extension window.

Interacting with the character

  1. 1.
    Click Start Talking to initiate the conversation
  2. 2.
    Click Stop when done talking for the character to respond.

Running the Demo

  1. 1.
    Open your chosen Omniverse app (e.g., Code).
  2. 2.
    Go to File->Open and navigate to the repo directory.
  3. 3.
    Navigate to <repo directory>/ConvaiDemoStage/ConvaiDemo.usd and click `open it.
  4. 4.
    Click the play button from the Toolbar menu on the left.
  5. 5.
    Click Start Talking in the Convai window to talk to the character then click Stop to send the request.

Actions

Actions can be used to trigger events with the same name as the action in the Action graph. They can be used to run animations based on the action received. To try out actions:
  1. 1.
    Add a few comma-separated actions to Comma seperated actions field (e.g jump, kick, dance, etc.).
  2. 2.
    The character will select one of the actions based on the conversation and run any event with the same name as the action in the Action Graph.

Notes

  • The demo stage includes only talk and idle animations. However, it is possible to add more animations and trigger them using the action selected by the character. More on that in the future.