Compatibility
Update
We've recently added Windows IL2CPP support and Apple Silicon (M1) support after Ver. 2.1.2.
⚠️ Note: If your current SDK version is below 2.1.0, please delete the
Inworld.AIfolder in your project and download the newest one here. Additionally, please notice that the legacy package (Ver. 2.1.0 or lower) may overwrite Oculus lipsync package if both packages have been installed into your project. We recommend you also upgrade Oculus lipsync as well.
Unity Version
The minimum supported Unity version is 2021.3.2f1. Any version below that may not be compatible. We have tested the package on 2021.3.2f1, 2021.3.6f1, and 2021.3.8f1, 2021.3.11f1, 2021.3.14f1, 2022.1.20f1 for both .NET Standard 2.1 and .NET framework. Other versions of Unity will be added to the list after testing.
Platform
Here are the detailed compatiblity for each platforms, scripting backends, and .net levels.
| Platform | MONO | IL2CPP | .NET |
|---|---|---|---|
| Windows | √ | √ | .NET Standard 2.1 or .NET 4.x+ |
| Mac Intel 64-bit | Only in Editor Mode | Only in Editor Mode | .NET Standard 2.1 or .NET 4.x+ |
| Android | × | √ | .NET 4.x+ |
| Oculus | × | √ | .NET 4.x+ |
| iOS | N/A | √ | .NET 4.x+ |
| Mac Apple Silicon (M1) | Only in Editor Mode | Only in Editor Mode | .NET Standard 2.1 or .NET 4.x+ |
| Linux | × | × | N/A |
| WebGL | × | × | N/A |
Newtonsoft Json
By default, the Newtonsoft Json package is automatically added into Unity. However, it may not be applied to some templates or may be removed in your package.json. If you encounter the error error CS2046: The type or namespace name 'NewtonSoft' could not be found or errors related to JObject, as shown in the image below:
Please refer to this page for more information.
Rendering Pipeline
While the default Inworld avatar (based on Ready Player Me) in the demo works with the Built-in pipeline, all Ready Player Me characters created through https://studio.inworld.ai/ are compatible with all rendering pipelines. If you wish to upgrade your models to use the Scriptable Render Pipeline, simply right-click on your character and select Inworld > Upgrade Materials for Scriptable Render Pipeline."
Input System
We've noticed that our Inworld Player Controller is not compatible with Unity's Input System by default. We'll add this support in future.
Android
Unity cannot proceed Android build by 2021.3.6f1. It’s a known bug for Unity. To solve this, you need to copy the whole Tools folder from the previous Unity version. Check this page for more details.
MacOS
1. Allow Access for grpc bundle
MacOS will automatically delete the grpc_csharp_ext.bundle which is necessary to our package if privacy is not allowed. Once you click the Play button, the following message box will appear,
Navigate to System Preferences > Security & Privacy and click the Lock button. When the grpc_csharp_ext.bundle appears under the Security & Privacy panel, click Allow anyway.
Return back to Unity, and click Cancel in the message box. Do NOT click Move to Trash. The dialog may appear again. If it does, then click Open once you have allowed success.
2. Compatibility with the MacOS build
This is a known issue that we're working on it. The only workable solution for macOS build is using Mac M1 to build the x64 version of app.
3. Microphone Usage Description
If you want to build an iOS app, 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.
