Lumberyard
User Guide (Version 1.16)

Setting up a Wwise Project

The Audio Controls Editor looks for Wwise project files in the lumberyard_version\dev\game_project\Sounds\wwise_project\ directory.

Lumberyard looks for the Wwise Soundbanks in the lumberyard_version\dev\game_project\Sounds\wwise\ directory.

Creating a Wwise Project

To create a Wwise project

  1. From the Start menu, open Wwise Launcher.

  2. On the WWISE tab, click Launch Wwise (64-bit).

    Note

    If you have multiple versions of Wwise installed, open the version that you installed for Lumberyard.

  3. In the Project Launcher dialog, click New.

  4. In the New Project dialog, enter a Name for the project.

    Note

    Wwise uses the name of your project to create a directory with the same name. However, you later rename the directory wwise_project.

  5. For the Location, select the lumberyard_version\dev\game_project\Sounds directory. If this directory doesn't exist, create it.

  6. Review and adjust the remainder of the options and then click OK.

  7. If you are using the full version of Wwise, the License Manager dialog appears. Paste or import your license key if you have one and click Save.

    If you don't have your license key, click Close.

  8. Exit Wwise.

  9. In a file explorer, navigate to the lumberyard_version\dev\game_project\Sounds directory.

  10. Rename the project directory you created in step 4 to wwise_project.

  11. Open Wwise again.

  12. Click Open Other.

  13. Navigate to the lumberyard_version\dev\game_project\Sounds\wwise_project directory.

  14. Select the .wproj file and click Open.

Generating New Soundbanks

To generate new soundbanks

  1. If the Wwise project is not currently open, open it.

  2. Choose Project, Project Settings.

  3. On SoundBanks tab, in the SoundBank Paths section, edit the SoundBank Folder and select the wwise directory that you created in Creating a Wwise Project and then click OK.

  4. If you are using Wwise LTX, click Generate Soundbank.

    If you are using the Wwise full version:

    1. Press F7 to open the SoundBank Manager Layout.

    2. If no soundbanks exist, you must create one.

      To create a soundbank, select all SoundBanks, Platforms, and Languages.

    3. Click Generate.

  5. Ensure that the soundbank generation succeeded. To do this, navigate to the lumberyard_version\dev\game_project\Sounds\wwise directory and verify that you have an Init.bnk file and other .bnk or .wem files.

For information on how to map soundbanks to ATL preloads so that Lumberyard can load them, see Using the Audio Controls Editor.

Creating Wwise Events for the Default ATL Controls

To create Wwise events for the default ATL controls

  1. If the Wwise project is not currently open, open it.

  2. Select the Events tab.

  3. Under the Default Work Unit, select or create a directory to contain default ATL controls.

  4. Right-click the directory to display the context menu and choose New Child, Empty Event.

  5. Create five empty events named the following:

    • do_nothing

    • get_focus

    • lose_focus

    • mute_all

    • unmute_all

    Note

    • The get_focus and unmute_all events unmute the Master Audio Bus.

    • The lose_focus and mute_all events mute the Master Audio Bus.

  6. Save the project.

  7. Generate soundbanks.

  8. In Lumberyard Editor, open the Audio Controls Editor.

  9. Map these Wwise events to the default ATL controls.

  10. Click File, Save All.