NOTE: This is the Unreal Engine 4 plugin. The Unreal Engine 5 plugin is located here.
Welcome to the FaceFX Unreal Engine 4 plugin source code!
This repository gives you all the information you need to successfully compile and install the FaceFX UE4 plugin.
The FaceFX UE4 plugin currently supports the Windows, Mac, Xbox One, PS4, Nintendo Switch, iOS, and Android platforms.
Starting with the UE4 version 4.27.2 update, the FaceFX UE4 Plugin has been updated to the FaceFX Runtime v2.1. It is important that you use the FaceFX Runtime v2.1 (or newer) data compiler and FaceFX Studio plugin. If you are upgrading from a previous version of the FaceFX UE4 Plugin, please make sure that you fully update your tool chain to the FaceFX Runtime v2.1 (or newer) as well.
Complete licensing information can be found in the LICENSE.md file located in this repository. The short version is:
-
The FaceFX UE4 plugin source code is licensed under the MIT license (this is the code that interfaces with UE4; in other words, the code contained in this repository).
-
The FaceFX Runtime is licensed under the FaceFX Runtime End User License. Once the FaceFX UE4 plugin source code is compiled and linked with the FaceFX Runtime, the resulting binary falls under the FaceFX Runtime End User License.
The FaceFX UE4 plugin supports UE4 version 4.27. It will not work unmodified on earlier versions of UE4.
The FaceFX UE4 Plugin documentation is located in the Documentation directory of this GitHub repository. Be sure to check out the Troubleshooting section if you run into any problems.
First, make sure that you have obtained a binary build of UE4; or, have obtained, and successfully built, the source code distribution of UE4. More information can be found on the Unreal Engine website.
There are two ways to obtain the FaceFX UE4 plugin. You can download a pre-built binary version and simply drop it into your UE4 install, or you can build the plugin from source. The quickest way to get up and running is simply to download and install the pre-built version.
The following steps describe how to install the FaceFX UE4 plugin:
Note: The pre-built binaries distribution will only work with the version of UE4 that is installed from inside the Epic Games Launcher application (currently 4.27). If you are using the UE4 GitHub source code you need to follow the directions for building the plugin from source.
-
Download the pre-built binaries distribution.
-
Unzip the pre-built binaries distribution into your C:\Program Files\Epic Games\UE_4.27\Engine\Plugins\Runtime directory. You should now have this directory: C:\Program Files\Epic Games\UE_4.27\Engine\Plugins\Runtime\FaceFX.
-
Run UE4 from the Epic Games Launcher.
-
Download the pre-built binaries distribution.
-
Unzip the pre-built binaries distribution into your /Users/Shared/Epic Games/UE_4.27/Engine/Plugins/Runtime directory. You should now have this directory: /Users/Shared/Epic Games/UE_4.27/Engine/Plugins/Runtime/FaceFX.
-
Run UE4 from the Epic Games Launcher.
First, make sure you are familiar with the process of cloning Unreal Engine from GitHub and have performed the necessary UE4 build steps for your target platform. The following instructions assume you know how to successfully build the GitHub version of Unreal Engine 4.
-
In order to build the source code you need to download the FaceFX Runtime distribution.
-
Create a directory named FaceFX in your UnrealEngine/Engine/Plugins/Runtime directory. You should now have this directory: UnrealEngine/Engine/Plugins/Runtime/FaceFX.
-
Copy the contents of your cloned repository from step 1 into the newly created FaceFX directory.
-
Unzip the FaceFX Runtime distribution .zip file you downloaded in step 2.
-
Inside the extracted folder from step 5 you should find a facefx-runtime-2.1.0 directory.
-
Copy the facefx-runtime-2.1.0 directory into your UnrealEngine/Engine/Plugins/Runtime/FaceFX/Source/FaceFXLib directory. You should now have this directory: UnrealEngine/Engine/Plugins/Runtime/FaceFX/Source/FaceFXLib/facefx-runtime-2.1.0.
-
Run the GenerateProjectFiles.bat file located in your UnrealEngine directory.
-
Load the UE4 solution in Visual Studio. Set your solution configuration to Development Editor and your solution platform to Win64, then right click on the UE4 target and select Build.
-
Run UnrealEd according to Epic's instructions.
-
In order to build the source code you need to download the FaceFX Runtime distribution.
-
Create a directory named FaceFX in your UnrealEngine/Engine/Plugins/Runtime directory. You should now have this directory: UnrealEngine/Engine/Plugins/Runtime/FaceFX.
-
Copy the contents of your cloned repository from step 1 into the newly created FaceFX directory.
-
Unzip the FaceFX Runtime distribution .zip file you downloaded in step 2.
-
Inside the extracted folder from step 5 you should find a facefx-runtime-2.1.0 directory.
-
Copy the facefx-runtime-2.1.0 directory into your UnrealEngine/Engine/Plugins/Runtime/FaceFX/Source/FaceFXLib directory. You should now have this directory: UnrealEngine/Engine/Plugins/Runtime/FaceFX/Source/FaceFXLib/facefx-runtime-2.1.0.
-
Run the GenerateProjectFiles.sh or double-click the GenerateProjectFiles.command file located in your UnrealEngine directory.
-
Load the UE4 project in Xcode. Select the UE4Editor - Mac for My Mac target in the title bar, then select the 'Product > Build' menu item.
-
Run UnrealEd according to Epic's instructions.
If you would like to contribute to the development of the FaceFX UE4 plugin, we accept contributions through pull requests on GitHub. Pull requests should be based on the master branch and should be associated with a GitHub issue. We use GitHub issues to track bugs, suggestions, questions, and feature requests.
All contributions must be under the MIT license, just like the FaceFX UE4 plugin source code itself.