Skip to main content

Compatibility

Supported Unity Versions

Inworld's Unity SDK supports up to Unity 6.

The minimum supported Unity version is 2020.3.48f1. Any version below this may not be compatible.

MacOS Version

If you are using MacOS and want to build MacOS applications, there is a known bug for Unity.

To avoid this, it is recommended you upgrade to 2022.3.10f1 or newer.

Unity SDK Developments

Support for Inworld Unity SDK v3.3 NDK has ended. Going forward, Inworld's focus has shifted exclusively to the Websocket client.

While the NDK offers a noticeable advantage in terms of package size, the performance speed between Websocket and NDK is comparable. However, the user base for Websocket significantly exceeds that of the NDK. Considering the substantial effort required to maintain both systems with future updates, Inworld has deprecated the NDK client.

From Inworld Unity SDK v3.2. we offered two different Unity SDK versions: full package InworldAI.Full and core package inworld-unity-core. We have separated the various modules using Unity's Assembly Definitions.

Inworld-unity-core supports lightweight projects with a significantly smaller download size (less than 1 megabyte). It does not include any character models from ReadyPlayerMe or Inworld avatars, which is suitable for developers with capabilities to import their own character skeletons and animations in Unity. Ideal for WebGL deployments or projects where package size is a consideration.

⚠️ Note: inworld-unity-core is provided as a Package, catering to core functionalities, whereas InworldAI.Full, offered as a Unitypackage, encompasses the entire suite of features and assets, and includes a reference to inworld-unity-core for foundational capabilities.

Platforms

Detailed Unity SDK compatibility for each platform is listed below:

PlatformInworld v3
Windows Minimum Version2020.3.48f1
Mac Intel 64-bit2022.3.10f1
Mac Apple Silicon2022.3.10f1
Android✔️
Oculus✔️
iOS✔️
Linux✔️
WebGL✔️

Rendering Pipeline

While some of Inworld's demo scenes use the Built-in Pipeline, the Innequin avatar (included in the Inworld sample assets) is compatible with all rendering pipelines. Inworld AI does not require a specific rendering pipeline to function.

Input System

By default, the Inworld Player Controller is currently not compatible with Unity's Input System.

Android

A known Unity bug in version 2021.3.6f1 may prevent Android builds. To resolve this, copy the entire Tools folder from a previous Unity version. For more details, refer to the Unity Forum

Oculus

Network permission

Our SDK requires an internet connection to function properly. If you are developing for XR, please ensure that you set the Internet Access option to Require in the Player Settings. xrnetwork

Mac/iOS/Vision Pro

Microphone Usage Description

If you want to build an app for an Apple device, please fill in Microphone Usage Description under Project Settings > Player > iOS > Other Settings > Configuration.

Also, for the default iOS app, the sound only comes out of the earpiece and may be relatively quiet. To output sound from the loudspeaker, you need to set Force IOS Speakers When Recording as well.

iOSSpeaker