Prerequisites

Before you install the Wwise Addressables package, ensure that your system and projects meet the following requirements:

• If your Wwise project requires a license, the license must be applied. See License Manager.
• The Wwise and Unity projects must be created in or migrated to the desired software versions.
• In Unity, the following Wwise Integration settings (see Adjusting Unity Editor Settings) must be set:
  • Wwise Application Path
  • WAAPI Port
  • WAAPI IP Address
• Ensure that the Wwise Addressable Installer settings are appropriate for your needs. You can change these settings through the editor or in the WwiseSettings.xml file.

Wwise Addressable Installer Settings

The Wwise Addressable Installer settings are located in the Project Settings Window under Wwise Integration.

• Install from a git repository
  • Description: Whether to install the package from a git repository or from a local copy of the Wwise Addressable Package.
  • Default: True
  • Options:
    • True: Install the package from git. Use this option if you plan to use the Wwise Addressable package as is.
    • False: Install a local copy of the package. Use this option if you plan to edit the Wwise Addressables code.
• Package source
  • Description: The source where the Installer should fetch the Wwise Addressable Package.
  • Default: The official Wwise Addressables package release based on the current Integration version being used: https://github.com/audiokinetic/WwiseUnityAddressables.git#v2x.1.x
  • Options:
    • Git Repository URL: Automatically set based on the Wwise Integration version.
    • Path: A local or network location that contains the package.json file for the Wwise Unity Addressables package.
• Addressable SoundBanks folder
  • Description: The directory in which to store the addressable SoundBanks.
  • Default: WwiseData/Bank
  • Options:
    • Path: The destination directory path, which can be anywhere under the Assets folder in the Unity project.
• Use custom build script
  • Description: Whether to use a custom build script.
  • Default: False
  • Options:
    • True: Use a custom build script. If you select this option, you must specify a path in the Addressable asset build path setting.
    • False: Use the default Wwise Addressable build script.
• Addressable asset build path (Only visible if Use existing custom build script is set to True.)
  • Description: Path to the custom build script Scriptable Object asset.
  • Default: Assets/AddressableAssetsData/DataBuilders/BuildScriptWwisePacked.asset
  • Options:
    • Path: The path to the Scriptable Object .asset file.
• Automatically update external source path
  • Description: Whether to update the external source path at the same time as the SoundBanks path.
  • Default: False
  • Options:
    • True: Update the external source. If you select this option, you must specify a path in the External Source Path setting.
    • False: Do not change the external source path.
• External source path (Only visible if Automatically update external sources path is set to True.)
  • Description: The directory in which to store the external sources.
  • Default: WwiseData/Bank
  • Options:
    • Path: The destination directory path for external source.
• Enable uninstallation prompt
  • Description: Whether to show a prompt about changes to project settings during uninstallation.
  • Default: True
  • Options:
    • True: Shows a prompt that informs users that certain settings will be changed and lists the reasons for the changes.
    • False: Do not show the prompt and continue the uninstallation based on the current settings (under Disable asynchronous bank loading).
• Disable asynchronous bank loading
  • Description: Whether to disable asynchronous bank loading after uninstalling the addressables package.
  • Default: False
  • Options:
    • True: Disable asynchronous bank loading after uninstallation.
    • False: Maintain asynchronous bank loading after uninstallation.

Running the Wwise Addressable Installer

The Wwise Addressable Installer is located under the Wwise in the Main Menu. After you ensure that you meet the prerequisites, and make any desired changes to the Wwise Addressable Installer Settings, click Install Addressable. The installation process automatically performs the following actions:

1. Installs the Wwise Addressables Package through the Unity Package Manager.
2. Sets the target directory for your generated SoundBanks.
3. Generates the SoundBanks.
4. Creates and imports the bank and wems assets.
5. Adds the .bnk and .wem assets to Platform Specific Addressables groups.
6. Creates a Wwise Build Script for Addressables.
7. Adds the Build Script to the Addressables settings.
8. Builds the Addressables.
9. Reloads all the Scenes in order to set the Init Bank Holder.

Remember that you must rebuild the Addressable groups if you modify or add new SoundBanks to your project. When using auto-defined SoundBanks, this also applies to Events. Also remember to rebuild Addressable groups after you switch platforms.

Uninstalling the Wwise Addressables Package

After the Addressables Package is installed, the Install Addressable option in the Wwise Addressable Installer changes to Uninstall Addressable, which you can click to uninstall the package. The uninstallation process automatically performs the following actions:

1. Deletes the folder that contains the generated SoundBanks from your Unity assets folder.
2. Uninstalls the package.
3. Cleans up the Addressables groups.
4. Sets the SoundBank Paths to a path outside of the Assets folder.
5. Regenerates your SoundBanks.