Skip to main content

Create Your Experience

In this section, let's setup the environment by the character you created.

1. Check your assets.

To integrate your own characters into your Unity project, you will need to ensure that you can access:

  1. At least one Workspace.
  2. At least one API Key in your workspace.
  3. At least one Character in your workspace.
  4. At least one Inworld Scene in your workspace.
  5. Ensure that your Inworld Scene contains all the Characters you need to interact with.

If you do not know how to create them, please check our Prerequisities page.

For more information, please check Studio Basics Tutorial Series.

2. Open Inworld Studio Panel in Unity.

If you do not know to open Inworld Studio Panel, please check the Integrate to your Scene page.

3. Login

  1. Click Login.
  2. At, click Integration.
  3. At Studio Access Token, click Generate Studio Access Token.
  4. Click the Copy button to copy it.
  5. Back to Unity, paste the token you copied to Inworld Studio Panel.
  6. Click Login.


⚠️ Note:

  • The token copied this way has an expiration time for 1 hour.
  • Once user logged in, This SDK will try reconnect if expired.
  • If sometimes the reconnection is not working, try clicking the Refresh button located at the bottom of the Inworld Studio Panel.
  • If the problem persists, please check your network connection and copy-paste the login token again.

4. (Optional) Change your user name.

After connecting, the Inworld AI Unity SDK will fetch your Unity UserName (most likely your email address) as the default name used in the SDK.

You can change this name at Inworld Setting Panel > User Settings or Edit > Project Settings > Inworld.AI.


⚠️ Note: Inworld Setting Panel (ScriptableObject of InworldAI) is displayed in Inspector, and may sometimes be covered by other panel. You can manually click Inspector to bring the panel to the foreground

5. Import your own Character into a Unity Scene.

  1. Once you're connected to Inworld Studio Server, you can choose your workspaces. The panel will download the data (key/scene/character references, etc) of that workspace.
  2. Once your workspace has been downloaded, you can select the relevant API Keys and Inworld Scenes to download the data (character thumbnails/models, etc) of that Scene.
  3. After that Inworld Scene have been downloaded, you can click on the thumbnail to navigate to the model and drag it into the Unity Scene.


⚠️ Note:

  • All the asset downloaded would be saved at Inworld.AI/Resources/{YOUR_USER_NAME}/. So if you changed your name, data would be downloaded to a new folder.
  • All the InworldCharacters that are not belonged to the current InworldScene would be deleted. For more information, please check getting-started page.

6. Next steps.

Once you've loaded the InworldCharacter into the scene, you can continue from step 3 of the Integrate to your Scene page.