Table of Contents

Installing or Upgrading Wwise and its Packages

The Launcher makes it easy to install Wwise and its component packages.

[Note] Be Sure to Install All the Mandatory Code Dependencies

It is not uncommon for a crash to occur due to one or multiple missing dependencies when installing Wwise without the Launcher. The required dependencies are detailed in the following rows of the Wwise System Requirements table: Microsoft .NET Framework, Microsoft DirectX, and Microsoft Visual Studio Redistributable. Installing the Authoring tool through the Launcher is less troublesome because you don't have to worry about the dependencies since they are automatically provided.

There are two primary installation methods:

  1. Using an offline installer. This method, described in the Working with Offline Installers section, is probably the easiest and most common way to install Wwise while ensuring that everyone on a team of developers or designers has the same version and setup.

  2. Working directly within the Wwise Launcher. This method, described in the following lines that make up the rest of this section, offers more control over what you decide to install for Wwise. It may be better suited to project administrators.

In the Wwise tab, the INSTALL NEW VERSION block helps you keep track of multiple versions of each Wwise component; the build and version number are prominently displayed.

If you obtain authorization to develop on more platforms, contact sales to change your profile and then you can download and install the new platform files.

To select the installation:

  1. In The Wwise Launcher, go to the Wwise tab.

  2. In the Install New Version section, select the version you wish to install from the versions list.

  3. Click the Install... button

To install Wwise:

  1. In the Packages list, select Authoring to have the Wwise Authoring Tool.

  2. Select the other packages you wish to install.

    [Tip] Tip

    For more information about the different packages, click the ? beside the Packages title.

  3. Select the platforms on which you will be deploying.

    [Note] Note

    Some check box options may be grayed out. Normally, this is because your user account is not associated with a project that has full rights to use certain licensed products, which can include different deployment platforms.

  4. Click Next.
    You are brought to the CHOOSE PLUG-INS page.

    CHOOSE PLUG-INS

    This page lists all the optional plug-ins developed by Audiokinetic and its partners. Next to the plug-in name is the developer name. And, if it requires an additional license to be published in-game, a "premium" icon appears next to that. (Plug-ins are free to use within the authoring tool.) Each plug-in includes a description and a version number. There is also a More Info list where you can select:

    • More Info to go to the website overview of the plug-in; or, as applicable,

    • Online Documentation to go to the online plug-in-specific documentation.

    • For all plug-ins you wish to install, click anywhere on the plug-in to enable the check box (upper right corner). (Plug-ins that were already installed will display Installed instead of the check box.)
      The plug-in outline turns blue.

    [Tip] To Install Other Plug-ins...

    Click Add from directory... or Add from archive... in the INSTALL NEW PLUG-INS section of the PLUG-INS tab, and select an appropriately packaged Wwise plug-in.

  5. Click Install.
    Wait until the installation completes.

[Tip] Tip

After successfully installing Wwise, if the Launcher detects a Unity or Unreal installation it will display buttons to bring you straight to the correct tab for Integrating Wwise into an Unreal or Unity Project.

Working with Multiple Versions of the Wwise SDK

When you install a new version of the SDK, the new installation overwrites the WWISESDK environment variable that points to the SDK location. This means that projects from older versions that use this variable will not point to their corresponding SDK version. To solve this issue, you will need to set the environment variable based on the version that you want to use. You could do this in one of the following ways:

  • Use the Launcher to set the environment variables for you. This is the newest and easiest method. From the Wwise tab, open the Settings list of the older installed version of Wwise that you wish to use with the SDK, then select Set Environment Variables.... A prompt will ask you to confirm the proposed WWISEROOT and WWISESDK environment variable changes to that version of Wwise.
  • Use an existing build script to set the path correctly before the build is started.

  • Set the environment variable in the command prompt before launching the build tool.

The WWISEROOT environment variable points to the main installer folder (for example c:\Program Files\Audiokinetic\Wwise v2015.1 build XXXX\). It can be used, for example, by tools or scripts that look for WwiseCLI.exe to build SoundBanks.