Skip to main content

Quickstart

Now that you meet the prerequisites, it's time to install the Genies Avatar SDK into your Unity project.

Create a Unity Project​

Open Unity Hub and click the New project button at the top right. Select the Universal 3D template and a Unity version at 2022.3.62f2 or later. Give the project a name and click the Create project button.

URP Template

info

The Genies Avatar SDK needs to be used with a project that supports the Universal Render Pipeline (URP). The Universal 3D template is a blank URP project. You may need to download the template before being able to create a project with it.

Download the Wizard​

You should have received a custom Unity package named genies-sdkbootstrap.unitypackage which contains the Genies Avatar SDK Bootstrap Wizard.

Import the Wizard​

Once Unity is open, right click in the Project window and select Import Package > Custom Package. Select the bootstrap wizard Unity package. Then click Import at the bottom right of the popup window.

Import Wizard

Use the Wizard​

Open the SDK Bootstrap Window​

Once imported, select Tools > Genies > SDK Bootstrap Window from the top menu.

Wizard Window

Fix the First Prerequisite​

The SDK Bootstrap Window window should appear. This will fix some prerequisites for installing the Genies Avatar SDK. Start by clicking the Fix button next to the Newtonsoft JSON Package.

First Fix

Fix Remaining Prerequisites​

The remaining prerequisites should appear. One by one, click the Fix All or Fix button for the remaining prerequisites. Once they all have a green checkmark, click the Install 'Genies SDK Avatar' button.

Install SDK

Complete the Install​

Once the SDK installation is complete, a Success window will appear. Click the OK button to start the auto-compilation.

Install Success

Restart Editor​

Once the compilation is complete, a Warning window will appear. click the Yes button to restart the Unity Editor. The Genies Avatar SDK is now fully installed!

Restart Editor

Add App Credentials​

Now that the Unity project has the SDK installed, it is required to add your app tokens so the APIs will work.

Copy the Tokens​

In the Genies Hub, create a new App if you you haven't already. Then get ready to copy the client ID and client secret tokens.

Client ID

Paste the Tokens​

In Unity, open the Project Settings window from the Edit menu at the top. Select the Genies > Auth Settings section on the left menu. Then paste the copied tokens and click the Save JSON to Resources button.

Add Auth

Import TMP Essentials​

TextMeshPro is a external package that is used for UI elements like text and buttons. It is required to import the TMP Essential Resources in order for you to use UI elements.

  • Click Windows tab at the top.
  • Select TextMeshPro and click Import TMP Essential Resources.
  • Once installed, restart Unity.

Import TMP