Neocortex
IntegrationsUnity SDK

Quick Start

Learn about the Unity integration in Neocortex

The Neocortex Unity SDK is a Unity package that allows you to easily integrate Neocortex into your Unity project. The SDK provides a set of APIs that allow you to interact with the projects created on the Neocortex web platform.

Requirements

Talking to Your First character

Neocortex Unity SDK comes with a sample scenes that demonstrates how to interact with a Smart NPC. Let's install the SDK and run the sample scene to see how it works.

Installation

  • Open your Unity project
  • Go to Window > Package Manager
  • Click on the + button and select Add package from git URL
  • Paste the following URL: https://github.com/neocortex-link/neocortex-unity-sdk.git
  • Click on the Add button

Add Package

After a few seconds, the Neocortex SDK will be installed in your project and you will see the package in the list of installed packages.

Import Sample Projects

  • In the Package Manager, click on the Neocortex Unity SDK package
  • Click on the Samples tab and click on the Import button next to the Text and Audio Samples
  • Wait for the import to finish, it will take a few seconds.
  • Open the Audio Sample scene from the Assets/Samples/Neocortex Unity SDK/X.X.X/Text and Audio Samples folder

You should see a dummy character and UI elements in the scene.

API Key Setup

To start using the Neocortex SDK, you need to initialize it with your Neocortex API key. You can create a new API key from the Neocortex web platform by going to the API Keys page.

  • Create a new API key and copy it
  • Open your Unity project
  • Go to Tools > Neocortex Settings
  • Paste the API key in the API Key field and click on the Save button

Save API Key

Project ID Setup

  • On the Test Character game object, you will see a Neocortex Smart Agent component in the Inspector.
  • Create a new project in the Neocortex web platform and copy the project ID from the URL.

Save API Key

  • Paste the project ID in the Project ID field of the Neocortex Smart Agent component.
  • If you have multiple audio output devices, select the one you want to use on Neocortex Audio Receiver component.

Save API Key

Run the Scene

  • Click on the Play button in the Unity Editor
  • Now yu can speak to the character using your microphone.

Congratulations! You have successfully set up the Neocortex Unity SDK and interacted with your first Smart NPC.

On this page