Table of Contents

Integrating Wwise into an Unreal or Unity Project

Your Wwise installation can work within the Unity and Unreal game engines; but, it is necessary to install separate integration packages. Fortunately, the Launcher makes this task very easy.

[Note] Note

Within the Launcher, only Wwise 2016.2 and later versions can be integrated into Unreal and Unity.

To integrate Wwise into Unity or Unreal projects:

  1. In The Wwise Launcher, move to the desired game engine tab, namely UNITY or UNREAL ENGINE.

  2. Click the Integrate Wwise into Project... button for the desired project.

    The integration page, such as the Unity one seen below, appears.

  3. Select the desired Unity/Unreal integration version.

  4. For Unity: Specify the packages and platforms for this project. The platform-specific source ZIPs will be copied to the Unity project's root folder.

    [Note] Unity Integration Extensions

    Note that the functionality encompassing the auto-registration of GameObject's has been moved to the Unity Integration Extensions. This code can be extended to allow users to modify auto-registration or add more complex GameObject handling. For those who know that they do not require this functionality, the Unity Integration Extensions do not need to be installed. Without the Unity Integration Extensions, users are responsible for registering all GameObject's either by attaching AkGameObj components or by explicitly calling the API.

    For Unreal: Specify the location of your Wwise SDK files, typically found with your Wwise installation.

    [Note] Note

    A note will appear to explain which folders are required and which platform-specific Wwise SDKs will be copied. If needed or desired, you can click Modify Wwise ####.#.#.### to change these settings.

  5. Enter the corresponding Wwise project path, or leave the field empty to create a new Wwise project version.

  6. For Unity: Specify the Unity Installation location for the selected Unity version.

  7. For Unity: Specify via radio buttons the Unity Installation option you prefer:

    • Install files into a copy of the Unity project directory, then apply changes if successful (recommended).

      This is the default installation method. It is secure because in the event where a Unity script won't compile or a file is locked, having installed the files into a copy of your Unity Project enables you to abort the process and/or fix issues without affecting your original Unity project directory.

    • Install files directly into the Unity project directory.

      This option is only recommended in a few rare scenarios, such as for users with an enormous project or those installing the integration at a late development stage, if they feel it unnecessary and a waste of precious memory to have a full copy of their project.

      [Tip] Tip

      Using a source control management software (such as Git, Subversion, or Perforce) is highly recommended in parallel with the Install files directly into the Unity project directory installation option because version control systems enable its user to revert unwanted changes.

    Optionally for advanced users, within your Unity project, you can also have the Launcher create a WwiseGlobal GameObject or add the AkAudioListener to the MainCamera.

    For Unreal: Enter a number between 0 and 4 for the Max Simultaneous Reverb Volumes.

  8. Click Integrate to apply the operation to your project. Click Cancel if for some reason, such as the indicated Total download size being too great, you do not wish to proceed with the Wwise integration into your Unity project.

To upgrade or modify an integration, select the appropriate project list option:

  • Upgrade Wwise in Project...: Brings you to essentially the same integration page as for Integrating Wwise into an Unreal or Unity Project; but, the integration version is set to the latest version and the button at the bottom is labeled Upgrade.

  • Modify Wwise in Project...: Brings you to essentially the same integration page as for Integrating Wwise into an Unreal or Unity Project; but, the integration version is set to your current version (with the expectation you will modify some of the other settings) and the button at the bottom is labeled Modify.

For further information on installing the...: