Installing the Wwise Addressables Package with the Unity Package Manager and GitHub

The official repository for the Wwise Addressables Package is : https://github.com/audiokinetic/WwiseUnityAddressables.

1. In the Unity Editor, select Window > Package Manager.
2. Click + and select Add package from git URL.
3. Paste https://github.com/audiokinetic/WwiseUnityAddressables.git in the text field and click Add.

More information about using packages hosted on Git repositories can be found in the Unity documentation.

Note:

If you see an error containing the message "No 'git' executable was found", you will have to add the directory containing the git.exe executable to your system environment and possibly restart your system for the changes to take effect.

Note:

The Unity Addressables Package must also be added to the project for Wwise addressables to function properly. The package is listed as a dependancy of the Wwise Addressables Package and should be installed automatically.

Updating the Wwise Unity Addressables Package

When updating to a newer version of Wwise, we recommend updating the Unity Integration before updating the Wwise Unity Addressables package.

Updates to the Wwise Unity Addressables Package are published at the same time as minor or major Wwise releases, but are not necessarily as frequent. Each update is tagged with the version of Wwise it was released (and tested) with. We aim to maintain compatibility between newer versions of the Unity Integration and older versions of the Wwise Unity Addressables package, unless major changes are needed. For example, the Wwise Unity integration version 2021.1.7 and newer are not compatible with versions of the Wwise Unity Addressables package older than the 21.1.7 tag (and vice-versa). Each GitHub tag has a corresponding entry on the repository's releases page which describes the changes made and their version compatibility.

Compatibility with the Unity Addressables Package

The Wwise Unity Addressables Package should be compatible with the latest version of the Unity Addressables package. It should also be compatible with older versions, but versions prior to 1.16.0 are untested. By default, the Wwise Unity Addressables Package uses the latest "verified" version of the Addressables package for minimum Unity version supported by the Unity Integration. Refer to Release Notes - Wwise Unity Integration 2024.1.0 for the list of supported Unity versions.

Setting Up and Building with the Wwise Addressables Package

Step 1: Set the target directory for your generated SoundBanks in Project Settings > Wwise Integration > SoundBanks Path.

Caution: This directory must be inside your Assets folder for the SoundBanks to be properly imported.

• In this example we set the target directory to Assets\WwiseData\Banks.
• Changing this path automatically modifies the output target directories in Wwise.
  • If Wwise Authoring is open when this change is made, a dialog opens prompting you to reload the project.

Step 2: Generate SoundBanks, either from within Wwise Authoring or using the Wwise Picker.

• At this point, the custom asset importers for .bnk and .wem files create Unity assets for generated SoundBanks and streaming media files.
• Metadata files and platform-specific groups are automatically generated in the AddressableAssetsData directory.
• You can confirm that your assets were properly imported by inspecting the files in the Generated SoundBanks Path.
• For more details, see Wwise Addressable Assets Explained.

Step 3: Click Window > Asset Management > Addressables > Groups. The Wwise Addressables Groups window opens.

By default, one group is created for each deployment platform containing the platform-specific SoundBank assets. Separate groups are created containing only the Init SoundBank for each deployment platform.

If you inspect the WwiseGlobal object in the scene, you will find that an Init Bank Holder component has been added to it.

Note:

The Init Bank Holder will only be added to the currently open scene. If the project contains multiple scenes, make sure all the scenes have been opened and saved, or alternatively, use the script under Tools > Reload All Scenes.

Step 4: Create a Wwise Build Script for Addressables.

• We recommend placing this in AddressableAssetsData/DataBuilders alongside the default build scripts.
• Right-click anywhere in the browser and select Create > Addressables > Content Builders > Wwise Build Script.
• This creates an asset named BuildScriptWwisePacked.
  

Step 5: Inspect the Addressables settings.

• By default, they are found in AddressableAssetsData/AddressableAssetSettings
• From the Groups window: Tools > Inspect System Settings
• From the editor: Window > AssetManagement > Addressables> Settings
  

Step 6: Add BuildScriptWwisePacked to the Addressables build scripts. In the inspector for AddressableAssetSettings, add the BuildScriptWwisePacked asset you created in Step 4 to the Build and Play Mode scripts.

Building the Project

Build the Addressable asset bundles from the Groups window using the Wwise Build Script. This will generate all general asset bundles (e.g. Default Local Group) as well as platform specific asset bundles in Library\com.unity.Addressables\StreamingAssetsCopy\aa\<Platform Name>.

Caution: The Wwise Build Script modifies the Include in Build property of WwiseData group schemas. If a group has WwiseData in its name, it will only be included if the name also contains the target build platform name. This behaviour can be modified in the BuildScriptWwisePacked.cs script. If you want to manually control which groups are included using the Include in Build property, you may simply use the default build script.

Once the addressable assets have been built, the project can be built as usual.

Caution: You will have to rebuild the Addressable groups if you modify or add new SoundBanks to your project. Also remember to rebuild Addressable groups after you switch platforms.

In the build directory :

• Addressable asset bundles are copied to StreamingAssets\aa\ .

Removing the Wwise Addressables Package

Removing this package requires a few additional steps for the Wwise integration to function properly.

• Delete the folder containing generated SoundBanks from your Unity assets folder.
• Uninstall the package, either through the Unity package manager or by deleting the corresponding line in the <UnityProject>\Packages\manifest.json file.
• In your Wwise Project Settings, set the SoundBank Paths to a path outside of the Assets folder.
• Regenerate your SoundBanks.
• If you are still using the Unity Addressables package, be sure to clean up your Addressables groups.