Getting Started
This tutorial will show you how to get started using the Genies Avatar SDK on your computer. It will require some prerequisites, creating a Unity project, and then installing the Genies SDK packages.
Prerequisites
You must have a registered Genies account before you are able to start building using the Genies SDK. You also must have the correct Unity version installed.
Check Operating System
The Genies Avatar SDK requires developers to use a minimum operating system spec:
- Windows 11+
- macOS 15+
For Linux Users, our SDK is currently tested for development on Windows and Mac platforms. While it may be possible to develop with our SDK on Linux, your experience may differ than what's on these documentation, or there may be functionality that does not work.
Download Unity Hub
Unity Hub is the software tool to create and launch Unity projects and choose which version of Unity to use for the project.
Start by downloading Unity Hub.
Download Unity Version
The Genies Avatar SDK works with a minimum Unity 2022.3 version.
Please make sure you download this recommended version or a later patch of 2022.3:
Install Build Modules
Once you download Unity Hub and the correct Unity version, open Unity Hub.
Click the Installs tab on the left side. Next to the appropriate version, click the Manage button to the right of it. Select the Add modules option.
Add any build modules necessary for your target builds such as:
- Android Build Support
- iOS Build Support
- Mac Build Support
- Windows Build Support
Click Continue and after installation, the Unity Hub should display the modules below the Unity version.
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.
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.
Install the Package
Add the Package
Go to the Unity Asset store page for the Genies Avatar SDK package.
Click the Add to My Assets button.
Download the Package
In Unity, click the top dropdown menu Windows > Package Manager. When the Package Manager window opens, change the top left option to Packages: My Assets. Then search and select the Genies Avatar SDK package in the left side list. Click the Download button at the top right.
Import the Package
Once the package is downloaded, click the Import button at the top right.
Import All Assets
A window will popup with import settings, click the All button at the top left. Then click the Import button at the bottom right.
Ignore the Restart
After the import is complete, a warning popup may appear requesting to restart the editor. Click the No button.
Restarting the Unity Editor to enable the backends is not required until the Genies Avatar SDK is successfully installed using the Bootstrap Wizard in the following steps.
Use the Bootstrap Wizard
The Genies Avatar SDK Bootstrap Wizard is a tool to setup the Unity project so the Genies Avatar SDK is successfully installed and can be built to the desired platform.
Open the Bootstrap Wizard
Select Tools > Genies > SDK Bootstrap Wizard from the top dropdown menu.
The Bootstrap Wizard window will open automatically after importing the Genies Avatar SDK package.
Open the Build Settings
Once the Genies SDK Bootstrap Wizard window opens, click the Open Build Settings button.
Select a Platform Build
Once the Build Settings window opens, choose the desired build platform and click the Switch Platform button.
Android and iOS are the only supported platforms currently. Windows and Mac standalone builds are coming soon.
Fix the Prerequisites
In the Genies SDK Bootstrap Wizard window, click Fix and Fix All buttons next to all the prerequisites until all the check marks are green. Then change the Active Input Handling by clicking the Use New button.
Restart the Unity Editor
Once all prerequisites are fixed, restart the Unity Editor. This also may be prompted by switching the Active Input Handling prerequisite.
Register your Project
Now that the Unity project has the Genies Avatar SDK installed, it is required to create a Genies account and register your project. This allows the APIs to fetch your authentication tokens and store your Genies data.
Create a Genies Account
Navigate to the Genies Hub page. Start the account creation by typing your email into the input field and clicking the Continue button.
Finish the Sign Up
Fill out the necessary information. Then click the Sign up button to create your Genies account.
Create a Genies App
Once you finish the account creation, sign into Genies Hub using the email OTP. Then click the circle plus-sign button to create your first Genies app.
A Genies app is used to grant a Unity project authentication tokens so it can use the Genies Avatar SDK APIs. It also is how you can create and upload custom wearables.
Finish App Creation
Give the app a name and then click the Save button.
Copy the Tokens
Once you created the Genies app, the app's page should open. Get ready to copy the client ID and client secret tokens.
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.
Once you click the Save JSON to Resources button the Genies Avatar SDK is now able to fetch your authentication tokens and let you use the APIs.
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.
Sample Scenes
The Genies Avatar SDK package is now installed and the Unity project is setup to use it. A good place to start is to check out the Sample Scenes page.
You can find the sample scenes in the Package Manager window by switching to Packages: In Project at the top left dropdown. Then select the Genies Avatar SDK package on the left side menu and click the Samples tab.
The Samples tab will not be visible if the Package Manager window is displaying Packages: My Assets.