Install the ACE Plugin#

Before you start:

Installing to a Packaged Engine#

For a packaged engine installed from the Epic Games Launcher, find your engine install location and copy the plugin somewhere under Engine\Plugins\Marketplace.

Note

You may have to create the Marketplace folder if one does not already exist. Installing the plugin to the incorrect engine folder can lead to Expecting to find a type to be declared in a module rules errors when packaging your project.

Install location for packaged engine

Installing to a Source Engine#

For a source engine, such as one acquired through GitHub and built from source, copy the plugin somewhere under Engine\Plugins\Runtime. Then compile your engine.

Installing to a Source Project#

To install the ACE plugin directly to a source project:

  1. Go to your project folder.

  2. Create a Plugins folder if one doesn’t exist already.

  3. Copy the ACE plugin somewhere under Plugins.

Install the ACE plugin to either the engine or a project that uses that engine. Do not install it to both at the same time.

Activate the Plugin#

After you have installed the plugin to either the engine or your project:

  1. Open your project in Unreal Editor.

  2. Go to Edit > Plugins and search for NVIDIA ACE.

  3. Check the box to add the plugin to your project.
    Enable plugin
  4. When prompted, restart the editor.
    Restart dialog

Upgrading from a Previous Plugin Version#

Typically, you must delete any previous copy of the plugin before copying in the new plugin version.

If you have a version of the NVIDIA ACE or Omniverse Live Link plugin prior to 2.0, you must complete extra steps to update your project.

  • Before installing the new plugin, uninstall any previous instances of ACE or OmniverseLiveLink plugins from your engine and project by removing the ACE or OmniverseLiveLink folder. Then install the new ACE plugin using the instructions above.

  • For a C++ project, you may see a compile-time error about Unable to find plugin 'OmniverseLiveLink'. If so, edit your .uproject descriptor file to replace “OmniverseLiveLink” with NV_ACE_Reference.

  • For a blueprint-only project, you may see a dialog box on editor startup about “This project requires the ‘OmniverseLiveLink’ plugin, which could not be found”, and it offers to disable the plugin. Click Yes to disable it.

  • If your project references any content from the pre-2.0 plugin, you may have to set up a project-specific asset redirect to allow it to find the content under the new plugin descriptor name. This particularly affects the custom mh_arkit_mapping_pose_A2F pose asset. If you get errors about missing assets after upgrading the plugin, add this to your project’s Config\DefaultEngine.ini file:

[CoreRedirects]
+PackageRedirects=(OldName="OmniverseLiveLink",NewName="/NV_ACE_Reference/",MatchSubstring=true)
+PackageRedirects=(OldName="/OmniverseLiveLink/mh_arkit_mapping_pose_A2F.mh_arkit_mapping_pose_A2F",NewName="/NV_ACE_Reference/mh_arkit_mapping_pose_A2F.mh_arkit_mapping_pose_A2F",MatchSubstring=true)

  • The redirects allow assets with references to the old plugin version to load, but it’s still recommended to resave those assets after they’re properly loaded, which forces the references to be updated. For MetaHuman models, the asset containing the old plugin references is typically Face_AnimBP.

The legacy LiveLink-based interface from the 1.x version plugin, where input had to be provided to Audio2Face through an external application, is provided as-is and is no longer supported. The legacy interface exists in the current version of the plugin for convenience while upgrading an application from an older version of Audio2Face, but it will be removed in a future plugin release.

On this page