Wwise Installation and Migration Guide

Similar documents
Tzunami Deployer FileNet Exporter Guide Supports extraction of FileNet contents and migrate to Microsoft SharePoint using Tzunami Deployer.

Connect Install Guide

Tzunami Deployer Hummingbird DM Exporter Guide

Tzunami Deployer Hummingbird DM Exporter Guide

Tzunami Deployer Confluence Exporter Guide

Tzunami Deployer DocuShare Exporter Guide

Tzunami Deployer Documentum Exporter Guide

Galileo Desktop SM 2.1. Installation Guide

Tzunami Deployer Confluence Exporter Guide

Installation Guide Worksoft Certify

Silk Performance Manager Installation and Setup Help

Tzunami Deployer HPE Content Exporter Guide Supports migration of EMC HPE Content Manager into Microsoft SharePoint using Tzunami Deployer

Version 2.8. Installation Guide

KingStar Motion 2.1 SDK and Runtime Installation Guide

LifeSize Control Installation Guide

Media Archive Server for Small Teams

Installation Guide Install Guide Centre Park Drive Publication Date: Feb 11, 2010

Tzunami Deployer Hummingbird DM Exporter Guide

x10data Application Platform v7.1 Installation Guide

KINGSTAR 3.5. SOFT MOTION SDK INSTALLATION GUIDE KS-DOC-x R19

QuaRC 2.0. Installation Guide. Single-User and Network Installations/License Configuration (Windows, QNX, and Gumstix Verdex)

NTP Software File Auditor for Windows Edition

ControlPoint. Advanced Installation Guide. September 07,

Tzunami Deployer Exchange Exporter Guide

QuickBooks 2008 Software Installation Guide

Symantec ediscovery Platform

Installation & Activation Guide. Lepide Exchange Recovery Manager

Lite Depreciation Quick Start Guide

PRODUCT GUIDE. L e p i d e S o f t w a r e P r i v a t e L i m i t e d

Tzunami Deployer Licensing Guide

Tzunami Deployer eroom Exporter Guide

Tzunami Deployer Oracle WebCenter Interaction Exporter Guide

School Installation Guide ELLIS Academic 5.2.6

FAS Asset Accounting FAS CIP Accounting FAS Asset Inventory Installation & Administration Guide Version

Installing Lotus Notes on Your Computer Lotus Notes release (Standard and Basic versions)

Release Notes RayEval 4.0

Network Scanner Tool V3.3. User s Guide Version

Tzunami Deployer Oracle WebCenter Interaction Exporter Guide

Abila MIP DrillPoint Reports. Installation Guide

FAS Asset Accounting FAS Asset Inventory FAS CIP Accounting Network Installation & Administration Guide Version

Proficy* Workflow. Powered by Proficy SOA GETTING STARTED

Rapid Recovery DocRetriever for SharePoint User Guide

Inmagic Content Server Standard Version 9.00 Installation Notes for New and Upgrade Installations

Installation Guide. EventTracker Enterprise. Install Guide Centre Park Drive Publication Date: Aug 03, U.S. Toll Free:

Print It Right, Right Away

Mercury QuickTest Professional. Installation Guide Version 9.0

Guide Citrix administrator guide

Function Point WORKBENCH Release 7.0k INSTALLATION GUIDE TABLE OF CONTENTS

SAP Workforce Performance Builder 9.5

Tzunami Deployer AquaLogic Exporter Guide Supports extraction of Web Components on the server and guides migration to Microsoft SharePoint.

ControlPoint. Installation Guide for SharePoint August 23,

Citrix administator guide

Release Notes for Avaya Proactive Contact 5.0 Supervisor. Release Notes for Avaya Proactive Contact 5.0 Supervisor

Installation and User Guide Worksoft Certify Content Merge

DRAWings 8 and Wings modular 8 Embroidery Software INSTALLATION GUIDE

xpresso for Adobe InDesign 2.5 Installer s Handbook

Sage Fixed Assets Network Installation Guide

User and training guides and related documentation from Parametric Technology Corporation and its subsidiary companies (collectively "PTC") are

License Server

ProSystem fx Engagement

Inmagic Content Server Workgroup Version 9.00 Installation Notes for New and Upgrade Installations

ACE Operation Manual

Tekla Structures Installation. March Trimble Solutions Corporation

Product Release Notes for Avaya Proactive Contact Supervisor

Privileged Identity App Launcher and Session Recording

LepideAuditor for SQL Server: Installation Guide. Installation Guide. epideauditor for SQL Server. Lepide Software Private Limited

Metalogix ControlPoint 7.6. Advanced Iinstallation Guide

Tzunami Deployer LiveLink Exporter Guide

Agilent CytoGenomics 2.5

3M Molecular Detection System Software Upgrade/Installation Instructions

Agilent GeneSpring Software

Series 40 6th Edition SDK, Feature Pack 1 Installation Guide

Sage Fixed Assets Single User

Centrify Infrastructure Services

Installing and Setting Up the Snap-on EPC. Rev.1.6 (12 Apr 2012) PN EN

PrintShop Mail Web. Getting Started

Colligo Contributor Pro 4.4 SP2. User Guide

Sage Fixed Assets Lite Depreciation for Sage 50 - U.S. Edition

SoftPro Installation Guide

SDL AuthorAssistant. Installation Guide

Edexcel GCSE 2009 e-spec Introduction 2 Minimum requirements 2 Hardware 2 Software 2 How do I install the e-spec? 3 Installing e-spec on a network 3

Administrator s Guide

PRPC Personal Edition Installation Guide 6.3 SP1

Getting Started with Tally.Developer 9

Release Notes for Avaya Proactive Contact Supervisor

SmartList Builder for Microsoft Dynamics GP 10.0

DefendX Software Control-Audit for Hitachi Installation Guide

Infor Worktop 2.5. Installation Guide for ERP Enterprise (LN)

PRODUCT GUIDE. N u c l e u s D a t a R e c o v e r y. C o m P r i v a t e L i m i t e d

Upgrade Instructions for Version 8.3.3

III. Prior to installation: From MS Project 2010, choose the File menu, and then choose Options.

Setting File Creation Software for North America. Installation Instructions

Installation Guide. Version 2600

Top Producer for Palm Handhelds

Relativity Designer Installation Guide

Database Migration Guide

PRODUCT GUIDE. N u c l e u s D a t a R e c o v e r y. C o m P r i v a t e L i m i t e d

ControlPoint. Quick Start Guide. November 09,

Juris Suite Installation Guide

IntelliTrack DMS (Data Management System) v8.1 Quick Start Guide Preliminary Copy (July 2011) Copyright 2011 IntelliTrack, Inc.

Transcription:

Wwise 2015.1.9 Installation and Migration Guide

Wwise 2015.1.9 Wwise 2015.1.9: Installation and Migration Guide Wwise 2015.1.9 Revision 1910 Copyright 2016 Audiokinetic Inc. All rights reserved. Patents pending Wwise is a product of Audiokinetic Inc.. This document is supplied as a guide for the Wwise product. This guide and the software that it describes is furnished under license and may not be duplicated, reproduced, modified, stored or transmitted, in whole or in part, in any form or by any means, other than as expressly permitted by the terms of such license or with the prior written permission of Audiokinetic Inc.. The content of this guide is furnished for information purposes only, and its content and all features and specifications referred to therein are subject to change without notice. Reasonable care has been taken in preparing the information contained in this document, however, Audiokinetic Inc.. disclaims all representations, warranties and conditions, whether express, implied or arising out of usage of trade or course of dealing, concerning this guide and assumes no responsibility or liability for any losses or damages of any kind arising out of the use of this guide or of any error or inaccuracy it may contain, even if Audiokinetic Inc.. has been advised of the possibility of such loss or damage. This guide is protected by Canadian copyright law and in other jurisdictions by virtue of international copyright treaties. Wwise is a registered trade-mark of Audiokinetic Inc.. Actor-mixer, Master-Mixer, SoundFrame, Soundcaster, Randomizer are all trademarks of Audiokinetic Inc.. All other trademarks, trade names or company names referenced herein are the property of their respective owners.

Table of Contents 1. Welcome to Wwise... 1 Introducing Wwise... 2 The Wwise Learning Roadmap... 2 2. Upgrading Your Wwise Game Projects... 4 About Upgrading and Migrating Wwise Game Projects... 5 Before You Begin... 6 Testing... 13 Upgrading Wwise on all Workstations... 13 3. Installing the Components of Wwise... 17 About Installing Wwise... 18 System Requirements... 19 Installing or Upgrading Wwise and its Components... 21 Adding Platform Components to the Current Installation... 24 Uninstalling Wwise... 25 4. Troubleshooting Wwise Installations... 27 Installation Issues... 28 iii

Chapter 1. Welcome to Wwise Introducing Wwise... 2 The Wwise Learning Roadmap... 2 1

Welcome to Wwise Introducing Wwise Welcome to Wwise, the middleware solution from Audiokinetic that gives you the power to create great audio and motion for video games. Through the tight integration of an advanced authoring application and a robust sound engine, Wwise can increase your productivity and enhance your creative output. Built to address the specific needs of the game development pipeline, Wwise is a unique solution for designers, composers, scriptwriters, and programmers. By allowing you to develop game audio, music, dialogue, and motion concurrently with game visuals, Wwise facilitates the design and authoring of sophisticated audio and motion during every phase of game development. About This Guide This guide is designed for audio and motion designers, integrators, composers, scriptwriters, and programmers working in the game development industry who are responsible for installing and upgrading the Wwise authoring application, the Wwise SDK, and the Game Simulator. It assumes that you are familiar with application upgrades and accompanying code modifications. Some basic concepts are explained, but only in relation to the Wwise software. This guide gives you specific information and step-by-step instructions to install and upgrade the following Wwise components: Wwise authoring application Wwise SDK Wwise Game Simulator The Wwise Learning Roadmap Audiokinetic has provided you with a comprehensive set of materials and resources, shown here in the learning roadmap, to help you along the way as you integrate Wwise into your production pipeline. 2

Welcome to Wwise 3

Chapter 2. Upgrading Your Wwise Game Projects About Upgrading and Migrating Wwise Game Projects... 5 Before You Begin... 6 Testing... 13 Upgrading Wwise on all Workstations... 13 4

Upgrading Your Wwise Game Projects About Upgrading and Migrating Wwise Game Projects When you are ready to upgrade to a newer version of Wwise, you need to follow a coordinated protocol to ensure that your projects created in the previous version are migrated smoothly to the newer version. The goal is to avoid putting any aspects of your game at risk, so you need to examine the changes in the new version and selectively and systematically implement any modifications to your game code. Depending on the types of changes made to Wwise from one version to another, your projects may not need to be migrated when upgrading to a new version. The protocol for upgrade and migration may vary depending on the number and configuration of users working with Wwise and the following conditions: Projects under source control the project will need to be checked in at key points. Multiple users the upgrade and the project migration need to be completed for the project and the SDK before multiple users can all upgrade on their workstations. Integrated game project the game code needs to be modified for the changes in the upgrade. The migration team, composed of one or two designated individuals, should first upgrade and migrate to a local system for the authoring application, and simultaneously upgrade and migrate to a local system for the SDK and the game code as needed. After the team has carried out their respective tasks, all other users can safely upgrade their Wwise installations and access the migrated projects. For an overview of the upgrade and migration workflow for a project under source control, consult the following chart: 5

Upgrading Your Wwise Game Projects Upgrading and Migrating Projects to the Current Version Before You Begin Before you upgrade to a new version of Wwise, you need to prepare your projects for the upgrade, particularly if your Wwise project has been integrated into a game. Repeat the procedures in the following sections for all projects that you want to migrate. The migration team should carry out the following tasks to prepare projects to be migrated to the latest version. 6

Upgrading Your Wwise Game Projects Commit all projects: 1. For projects under source control, ask the other members of your team to commit all their changes. This will avoid merge problems later. Get the latest version of all projects to be migrated: 1. For projects under source control, import all the projects locally to your system. 2. Ensure that all project files have read and write permissions. For projects under source control, you may need to check out the project file (.wproj) and all work unit files (.wwu) from the various sub folders. Validate projects to be migrated: 1. Open each Wwise project that you plan to migrate in the current version of Wwise, and save. 2. If the Project Load Log dialog box displays messages and suggested fixes, accept these fixes, save the changes, and close the project. Repeat this procedure until there are no such messages. Your goal is to remove any project errors to simplify the upgrade. 7

Upgrading Your Wwise Game Projects Tag projects to be migrated: 1. For projects under source control, commit and tag or label this as the last version of the project prior to the upgrade. Committing the project at this point will record all the changes up to the migration process. Any other changes will be directly associated with the migration in the source control history. Upgrading Wwise The project migration process has been designed to ensure that your migrated project very closely approximates the sound of your previous project despite the significant changes made to the feature set. For more information about these changes, refer to the current version of the Wwise release notes. The migration team should migrate the Wwise project to the new Wwise version on a local system first. All other users should not alter the project until the migrated project has been tested, and then committed by the migration team. Depending on the types of changes made to Wwise from one version to another, your projects may not need to be migrated when upgrading to a new version. Upgrade Wwise 1. On your local system, upgrade Wwise. For information about how to install Wwise on your system, refer to Installing or Upgrading Wwise and its Components. 8

Upgrading Your Wwise Game Projects Migrate a project to the new version: 1. Verify that all files in the current Wwise project have read and write status. 2. Perform a backup of the project and store the backed up project in another folder on your system or network. The project will be backed up automatically by Wwise, but it is a good practice to do your own backup as well. 3. Open the Wwise project that you plan to migrate to the new version. A message is displayed prompting you to migrate this project to the latest version installed on your system. The Migration dialog box is only displayed when significant changes have been made to the project file between versions. If your project does not require migrating, Wwise will skip to the next step in the migration process. 4. Click Yes. Wwise begins to migrate the project. After the project is migrated, Wwise checks to see if the existing project cache folder is compatible with the current version of Wwise. If not, Wwise deletes the project 9

Upgrading Your Wwise Game Projects cache folder. When the project cache is deleted, the following message box is displayed. 5. Click OK. The Project Load Log dialog box will open if there is migration information and messages to display. The migration information includes the creation of any new files that are required for the new version of Wwise. This information is stored in the file named projectname.wproj_migration.log in the project folder. If needed, you can also click Copy to Clipboard to save this information for reference. 6. If you are using source control, add any new files that were created during the migration process to your source control system. 7. Close the Project Load Log dialog box. Generate SoundBanks: 1. Generate SoundBanks for migrated projects that will be used for testing. 10

Upgrading Your Wwise Game Projects Caution If you are upgrading from 2008.4 or a previous version, and are generating SoundBanks from the command line, you must update your scripts to use the new WwiseCLI.exe instead of Wwise.exe. WwiseCLI.exe uses the exact same parameters as Wwise.exe, so no other changes are required, but if you don t update your scripts, they will fail in the current version. Upgrading the Wwise SDK Just as you need to prepare to upgrade the Wwise authoring application, you also need to carry out the following tasks to upgrade the Wwise SDK. To migrate the game code, you will need to port the existing functionalities of a C++ project to the latest version of the Wwise SDK from the previous version. This task may include modifying or refactoring code in different modules. Ideally, the migration team will work concurrently on updating the game code and migrating the Wwise project to the new version. While the Wwise projects are being upgraded and migrated, changes to the following modules may need to be addressed to update the game code: SoundFrame Sound Engine Memory Manager Stream Manager Communications Module To ensure that your game is not adversely affected by some of the new features in this version, it is always a good idea to first 11

Upgrading Your Wwise Game Projects upgrade the components that you need for your game. After you are satisfied that your game is stable, you can integrate the new features, if needed. Upgrade the Wwise SDK: 1. Consult the Wwise SDK documentation to verify that your current system matches that described in the SDK System Requirements section. 2. Optionally, uninstall the previous version of the Wwise SDK. It is a good practice to also manually remove any temporary files created by the sample C++ projects. 3. Install the current version of the Wwise SDK. For more information about installing and uninstalling the Wwise SDK, refer to the release notes. 4. Verify that the WWISESDK environment variable points to the installation folder for this current version. Update the game code for the newer version of the Wwise SDK: 1. Refer to the changes listed in the Wwise SDK documentation to familiarize yourself with the modifications you will be making. 2. Modify the code as required. It is a good practice to rebuild the C++ project often when you are modifying the code. Build your game 1. Rebuild your game. 12

Upgrading Your Wwise Game Projects Testing Before you can complete the upgrade, you need to test the migrated game. The tests are carried out both in the Wwise authoring application and in the game by the migration team. Most likely you have created a testing protocol at your workplace. To augment what you are already using, we have included a simple procedure that you can consider when you are testing the upgrade. Test the migrated game project: 1. In the game, verify the sound and audio behavior. This can include verifying the following: Basic audio playback. Behaviors affected by changes you have made to the code. Platform behaviors. Communication with the Wwise authoring application. Any in-house tools for SoundFrame that might be affected by this upgrade. Commit your migrated project: 1. Commit your migrated Wwise project and the changes to the code to source control. After the testing is complete and you are satisfied with the results, you are ready to instruct other users to upgrade to the latest version of Wwise. Upgrading Wwise on all Workstations After the Wwise project has successfully been upgraded and migrated on a local system, the SDK and other code changes have been made, and the testing completed, you are ready to advise other users to upgrade Wwise on their workstations. 13

Upgrading Your Wwise Game Projects This upgrade must be carried out on all the workstations where Wwise is being used including the following: Build machines Sound Designers Developers Any other Wwise user workstations Ensure that you have identified all the workstations that run Wwise so that you can upgrade them all. Upgrading User Workstations After the development and migration tasks are completed, all Wwise users can upgrade to the current version of Wwise. Upgrade Wwise on all workstations: 1. Optionally, uninstall all Wwise components. This may include: Wwise authoring application Wwise SDK Wwise Game Simulator Wwise Sample Sound Engine Integration (Cube) Wwise Sample Project For more information about uninstalling, refer to the following section: Uninstalling Wwise 14

Upgrading Your Wwise Game Projects It is not necessary to uninstall Wwise. If required, you can maintain several builds and versions of Wwise on the same workstation. 2. Install the current version of Wwise. This may include: Wwise authoring application Wwise SDK Wwise Game Simulator For more information about installing, refer to the following sections: Installing or Upgrading Wwise and its Components All users access the migrated Wwise project: 1. After you have installed the latest version of Wwise, retrieve the migrated Wwise project. 2. Open Wwise. The End-User License Agreement is displayed. 3. Read the agreement and if you accept, click Accept. The Project Launcher window opens. 4. Open the migrated project. If some users have work units in the Wwise project that have been saved locally and are not under source control, a message appears prompting them to accept that these work units will be migrated when the project opens in the new version of Wwise. Before the project can be loaded, Wwise checks to make sure that the project cache folder is compatible with the current version. If not, Wwise deletes the project cache folder. When the project cache is deleted, the following message box is displayed. 15

Upgrading Your Wwise Game Projects 5. Click OK. After the cache is deleted, the project is loaded into Wwise. 16

Chapter 3. Installing the Components of Wwise About Installing Wwise... 18 System Requirements... 19 Installing or Upgrading Wwise and its Components... 21 Adding Platform Components to the Current Installation... 24 Uninstalling Wwise... 25 17

Installing the Components of Wwise About Installing Wwise After you have downloaded the Wwise installation package from the Audiokinetic website, and this is your first installation of Wwise, you can go ahead and run the setup program. The setup program will install the Wwise authoring application, SDK, and Game Simulator. Before you begin, however, make sure that you have unzipped the installation package to a local drive and that you have sufficient privileges to install Wwise on your system. If you have a previous version of Wwise, be sure to consult Chapter 2, Upgrading Your Wwise Game Projects to safely install the new version and migrate your existing projects. You can upgrade to the latest version of Wwise, yet still maintain previous versions of Wwise on your workstation. This can be very convenient in the following situations: You have been working on a project in a previous version, and you want to download the latest version to test out the new features without migrating your project. You are working on several projects that use different versions of Wwise; for example, you are: a content provider whose clients are using different versions of Wwise. an audio designer working on a new project that is using the latest version and wrapping up an older project that is using an older version of Wwise. To help you keep track of the various versions of Wwise, they are categorized by version number when you access them from the Start menu. The build number is also clearly displayed in the title of the Wwise shortcut. Remember to open older projects in their corresponding version of Wwise to avoid being prompted to migrate them to the latest version. It is a good idea to review the Release s for the current version of Wwise prior to installation so that you are aware of any features, issues, and workarounds that might affect the projects you are currently working on. The installation package includes all the necessary components, including the Microsoft.Net Framework v3.5 SP1, needed for the application to work properly. Keep in mind that your installation package will only include the platforms for which you are authorized. If you obtain authorization to develop on more platforms, contact support to change your profile and then you can download and add the new platform files. For more information about adding platforms to your installation, refer to Adding Platform Components to the Current Installation. 18

Installing the Components of Wwise The installation process includes the following steps: System Requirements. Installing or Upgrading Wwise and its Components. You can uninstall Wwise at any time, if needed. For more information on uninstalling Wwise, refer to Uninstalling Wwise. System Requirements Before you install Wwise, you should verify the minimum system requirements. This section describes the hardware and software requirements to install and run the Wwise authoring application. System Component Processor Operating System Requirement The following processors are required to run Wwise: Pentium 4 Processor 3.0 Ghz or better with Hyper-Threading technology AMD Athlon 3.0 GHz or better The following operating systems are supported: Windows XP with Service Pack 3 or more recent Windows Vista with Service Pack 1 or more recent Windows 7 Memory The Wwise authoring application is available in both 32 and 64 bit. 1 GB of RAM Large projects will require larger amounts of RAM. To allow the Wwise authoring application to use more than 3GB or RAM, use the 64-bit version. 19

Installing the Components of Wwise System Component Resolution Microsoft.Net Framework Requirement The factory layouts have been optimized for monitors with a resolution of 1280 x 1024, but they can be adapted for other resolutions. Microsoft.Net Framework v3.5 SP1. The installation program will automatically detect if this external component is on your system, and if not, will install it before installing Wwise. If, however, you deploy Wwise without using the installer (via Perforce or some other revision control system), you will need to install.net Framework manually. You can use either of the following installation programs that are available from the Microsoft website: Microsoft.Net 3.5 SP1 - Light installer Windows Installer Microsoft DirectX Microsoft.Net 3.5 SP1 - Full installer Windows Installer 3.1 or more recent must be installed prior to launching the Wwise installation. Please refer to http://support.microsoft.com/ kb/893803 for download and installation instructions. DirectX February 2010 runtime. The installation program will automatically detect if this external component is on your system, and if not, will install it before installing Wwise. If, however, you deploy Wwise without using the installer (via Perforce or some other revision control system), you will need to update the DirectX runtime manually. You can do that by visiting the DirectX web site: http://www.microsoft.com/directx If you do not have the appropriate version of DirectX on your computer, Wwise will run normally, but the Game Object 3D Viewer will not be available 20

Installing the Components of Wwise System Component XMLLite PDF Reader QuickTime Requirement and you may not be able to test Motion in Wwise. XMLLite is automatically installed with Windows XP Service Pack 3, Windows Vista and Windows 7. While we do not officially support Wwise on Windows XP without Service Pack 3, XMLLite for Windows XP Service Pack 2 (KB915865) may still be available at the Microsoft web site. A reasonably recent version of Adobe Reader or other PDF reader is required to open the PDF files that are distributed with Wwise. QuickTime 7.6.5 or later is required for AAC conversion in Wwise for the Mac and ios platforms. http://www.apple.com/quicktime/download Installing or Upgrading Wwise and its Components The Wwise Setup Wizard will guide you through the installation process for the following Wwise components: Wwise authoring application Wwise SDK Wwise Game Simulator To help you keep track of multiple versions of each Wwise component, the build and version number are prominently displayed. The version and build numbers displayed in the following procedure are for illustrative purposes only. The installation package includes all the necessary components for the application to work properly. Keep in mind that your installation package will only include the platforms for which you are authorized. If you obtain authorization to develop on more platforms, contact support to change your profile and then you can download and install the new platform files. For more information about adding platforms to your installation, refer 21

Installing the Components of Wwise to A platform is missing (You cannot generate SoundBanks for a platform, platform-specific SDK files are missing...). 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 manually set the environment variable based on the version that you want to use. You could do this in one of the following ways: 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.9 build????\). It can be used, for example, by tools or scripts that look for WwiseCLI.exe to build SoundBanks. To install Wwise: 1. Unzip the installation package to a local directory, go to the Installers subfolder, and then double-click Wwise_v2015.1.9_Setup.exe. Windows User Account Control may prompt for confirmation of the request to run the Wwise Installer with higher privileges. The Audiokinetic Wwise Setup window opens with the Install Prerequisites button available. 22

Installing the Components of Wwise Click Install Prerequisites. Click Continue. Some component-specific License Agreements may be displayed. Accept them to continue the installation process. 2. Once prerequisites have been installed, the Install Wwise button is enabled in the Audiokinetic Wwise Setup window. Click Install Wwise. 3. The Welcome to the Wwise v2015.1.9 Setup Wizard opens. Take a moment to verify that the setup is installing the platform components for which you are authorized. If the correct platform components are not being installed, it is most likely because you are running the setup directly from the zip file. To install all authorized platform components correctly, cancel the setup program, unzip the files to a local directory, and then run the setup again. 4. Click Next. The Wwise End-User License Agreement window opens. 5. Read the End-User License Agreement and click I accept the terms in the License Agreement to continue with the installation. 6. Click Next. The McDSP Effects End-User License Agreement window opens. 7. Read the End-User License Agreement and click I accept the terms in the License Agreement to continue with the installation. 8. Click Next. The Component Selection window opens. 23

Installing the Components of Wwise In this window you can view the different components of the setup program: Wwise Authoring Application the Wwise authoring tool, both 32 and 64 bit versions, and documentation. Wwise SDK the sound engine application programming interface (API), samples and documentation. Wwise Game Simulator a LUA script interpreter that allows you to reproduce how sounds will behave in the game. 9. Select a component to view the disk space requirements for each component. 10.To remove a component from the installation, click the down arrow beside the component and select the Entire feature will be unavailable option. 11.To change the location where you want to install Wwise, click Browse. The Change current destination folder window opens. 12.Navigate to the destination folder where you want to install the Wwise components, and click OK. The Wwise components will be installed in the location you have specified, and you are returned to the Component Selection window. 13.Click Next. The Ready to Install window opens. 14.Click Next. The Installing Wwise window opens with a progress bar displaying the status of the installation. If you are registered for several platforms, the installation program will configure Wwise for each platform separately. When all the registered platforms have been configured correctly and the installation is complete, the final window of the wizard opens. 15.Click Finish to exit the Setup wizard. The selected Wwise components have been successfully installed on your system. Icons for each Wwise component will also be placed on your desktop. Adding Platform Components to the Current Installation If you become an authorized developer for a new game platform after installing Wwise, you can easily add the platform components to the 24

Installing the Components of Wwise current installation of Wwise by running the separate platform installation program. This program is much faster than the main installation program as it only installs the necessary components for the particular platform. The version and build numbers displayed in the following procedure are for illustrative purposes only. Uninstalling Wwise To add platform components to the current installation of Wwise: 1. Unzip the separate platform installation package to a local directory. 2. Double-click Wwise_v2015.1.9_Platform.msi. The Welcome to the Wwise Setup Wizard opens for the particular platform. The name of the platform is displayed in the window title bar. 3. Click Next. The Component Selection window opens. This window displays the components that will be installed for the particular platform. Take a moment to verify that the correct components are being installed and that they are being installed in the correct location. 4. If all is correct, click Next. The Ready to Install window opens. 5. Click Next. The Installing window opens. When the platform components have been installed correctly the final window of the wizard opens. 6. Click Finish to exit the platform Setup wizard. The platform components have been successfully added to the current installation of Wwise. You can uninstall Wwise whenever you want. While it is not necessary to uninstall Wwise before you update to a newer version, you might want 25

Installing the Components of Wwise to uninstall the previous version if you have no reason to keep it. You can uninstall a version of Wwise from the Add or Remove Programs (Windows XP), Programs (Windows Vista) or Programs and Features (Windows 7) option in the Control Panel. You will notice that each platform component is listed separately in the Programs window. This gives you the option to uninstall each platform component independently, for example, you might want to uninstall just the Wii component. However, uninstalling the main setup will automatically uninstall all platforms. You may notice that after uninstalling Wwise, the platform components remain in the list of currently installed programs. This is a limitation of Windows because the components have actually been uninstalled. To remove the other Wwise components from the list of currently installed programs, you simply need to refresh the window. You may notice that some temporary files created in the Wwise and Wwise SDK installation folders still remain after uninstalling Wwise. You can delete these files manually as required. 26

Chapter 4. Troubleshooting Wwise Installations Installation Issues... 28 27

Troubleshooting Wwise Installations Installation Issues While most installations go smoothly, you may encounter some difficulties related to the installation that might be solved by consulting the following solutions. You cannot run the installation program Possible cause: Insufficient privileges on your system. Solution: Check your user account. You must be an administrator on your computer and a member of the Administrators group on your system to install Wwise. You get an error while installing prerequisites On a Windows 7 system, you may get the following error while installing Wwise prerequisites: An Error Occured During the installation of assembly component {8731EA9C-B0D8-8F16-A01F-C8B3B9A1E18E}. HRESULT: 0x80070BC9. To resolve this issue: 1. Open the Programs and Features option in the Control Panel. 2. Click Turn Windows features on or off (on the left side of the window). 3. Locate the Microsoft.NET Framework 3.5.1 item and check it. 4. Click OK. 5. Try running the Wwise setup again. A platform is missing (You cannot generate SoundBanks for a platform, platform-specific SDK files are missing...) Possible cause: You did not have the.msi file for that platform when you installed Wwise. Solution: Verify the Wwise installation zip file. If the Installers subfolder does contain the.msi for the desired platform, please refer to Adding Platform Components to the Current Installation. If it doesn't, please contact support. 28

Troubleshooting Wwise Installations Multiple versions: your project opens in the wrong version of Wwise Possible cause: You are trying to open the project by double-clicking the.wproj file in Windows Explorer. The.wproj file always points to the most recently installed version of Wwise and not necessarily the version you want to use. If the version of the project does not match up with the most recently installed version of Wwise, either the project won t open or you will be prompted to migrate that project to this newer version of Wwise. Solution: To open a project in a specific version of Wwise, you should open the desired version of Wwise, and select the project that you want to open from the project list in the Project Launcher dialog box. To change the version of Wwise that is used to open.wproj files in Windows Explorer, right-click on a.wproj file, choose Open With..., and browse to select the desired version of Wwise.exe. Multiple SDK versions: your game is building with the wrong SDK version Possible cause: The Wwise installer creates an environment variable named WWISESDK that points to the SDK location. Each time you install a subsequent version of the Wwise SDK, this variable is overwritten. This means that it will always point to the most recently installed version on your computer. If your game projects are using the WWISESDK environment variable, they may be using the wrong SDK if you have multiple SDKs installed. Solution: To avoid inadvertently using the wrong SDK, manually set the environment variable by doing one of the following: Use the build script to set the environment variable to the appropriate path before building the game. Set the variable in a command prompt before launching the build script/ tool. This way, you can have different game builds using different versions of the Wwise SDK on the same computer. The WWISEROOT environment variable can also be used to manage multiple versions as it points to the main installer folder (for example c:\program Files\Audiokinetic\Wwise 29

Troubleshooting Wwise Installations v2015.1.9 build????\). It can be used, for example, by tools or scripts that look for WwiseCLI.exe to build soundbanks. 30