IMPORTANT: This tutorial is based on Gamebryo 2.x. While some of it may still apply to current versions of Gamebryo/LightSpeed and the Wwise integration, some changes might be needed. Refer to the current version's documentation for up-to-date information.

Introduction

Welcome to this first Gamebryo Wwise Integration tutorial!

As you may know, Wwise is a complete cross-platform audio solution created by Audiokinetic. Designed to make the lives of sound designers and developers easier, this audio pipeline solution is the perfect companion for Emergent's Gamebryo Game Engine.

The Gamebryo Wwise Integration is a library that will help you get started with the integration of Wwise into your Gamebryo game. It contains full source code for the integration library so you can modify and enhance it as you get more familiar with Wwise and how you want to use it in your game.

Sample Gamebryo applications such as SceneApp and MetalWars have been modified to integrate Wwise, and their sources are also part of the integration package so you have examples of how to use it.

This series of tutorials will guide you through the process of integrating Wwise into your Gamebryo game using the Gamebryo Wwise Integration.

Based on the SceneApp sample, this first tutorial covers the basics -- Setting up your project/makefile, initializing the sound engine, calling it every frame to render audio, and finally playing a simple 2D sound to make sure it all works fine. The other tutorials will cover things such as 3D positioning, environments, and so on.

Note: Screenshots and code may differ slightly from what you have depending on the actual version of the various engines and tools that are mentionned in this tutorial.

Before We Begin: Where to Get the Gamebryo Wwise Integration

The Gamebryo Wwise Integration is available through the Gamebryo Forums. Depending on the platforms you are working on, visit the appropriate forums:

• PC Partner Integrations
• Xbox 360 Partner Integrations
• Wii Partner Integrations
• PS3 Partner Integrations

Several versions of the integration are available. Be sure to download the one that matches the versions of Gamebryo and Wwise you are planning on using. Posts on the forums specify which versions are supported, and a complete table of Gamebryo vs. Wwise vs. Integration versions is available in the Gamebryo Wwise Integration help file.

The integration installs in its own directory (by default c:\Emergent\Integrations\Gamebryo_Wwise_1.0). It creates an environment variable named GAMEBRYO_WWISE_PATH that points to the installation directory. As we will see in the next step, we will use that environment variable in projects and makefiles to help them locate files in the Gamebryo Wwise Integration.

Note: The "PC" package contains all the "common" code (code that is shared between all platforms), so you must always install the PC integration first (even if you do not plan on coding for that platform), and then the additional platforms you need.

Note: The Wwise SDK must also be installed before you can integrate it into your game using the Gamebryo Wwise integration.