UE4 Troubleshooting
Troubleshooting common problems with the Unreal Engine 4 Avatar SDK and known issues/limitations.

Common Errors

Crashes on built applications

Missing materials error
A common cause of crashes on built applications using our SDK is missing files or folders, like the glTFRuntime materials. To fix this, you can adjust the packaging settings by going to: Edit > Project Settings > Packaging From here, expand the Packaging section and look for "Additional Asset Directories to Cook." Alternatively, you can search for this setting from the top of the Project Settings Window. Now add the to folders "ReadyPlayerMe" and "glTFRuntime" as shown below. On the glTFRuntime documentation page, you will also see this tip for fixing build issues.

Unable to compile/build

Errors on Blueprint projects
It is mentioned on our documentation page here, but our plugin only currently works in a C++ project. Hence, if you use it in a Blueprint project and having build or compilation issues, you need to convert it to C++. The easiest way to do this is to add a new C++ script to your project. To be clear, you do not need to convert all your existing project blueprints to C++. You can continue to develop your application with blueprints.
Unable to compile or open project
When importing our plugin to your Unity project, you should extract the plugin zip file into the /Plugins directory as shown in our getting started guide. If you encounter some errors that prevent you from compiling the solution or opening the project. The most common fix is to remove all generated files/folders and perform a clean build. You can do this by following these steps
    Delete the following folders Binaries, Intermediate, Saved
    Delete the [PROJECT_NAME].sln file (if using visual studio)
    Also, delete the Binaries and Intermediate folders side our plugin folders Plugins/glTFRuntime, Plugins/ReadyPlayerMe
    Now that you have cleaned all the generated files navigate back to the project root folder and right-click the [PROJECT_NAME].uproject file. Then click "Generate Visual Studio Project Files"
    After that, try reopening the project
If the above does not fix your issues, you can also try opening the .sln file and debugging the issue or contacting us at [email protected] with an email explaining your issue.

Known Issues/Limitations

Significant lag when loading avatars at runtime

This is currently a known limitation to the 3rd part glTFRuntime importer plugin that we use. They are actively working on updates and have said that performance improvements are in development. You can also ask them on their discord server.
Last modified 15d ago