Wwise Help

1. 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.

2. 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 might need to check out the project file (WPROJ) and all Work Unit files (WWU) from the various subfolders.

3. Validate projects to be migrated:

   1. In the current version of Wwise, open each project that you plan to migrate and save.

   2. If the Project Load Log dialog 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.

4. 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 records all changes made prior to the migration process. Any other changes will be directly associated with the migration in the source control history.

1. Upgrade Wwise:

   1. Upgrade Wwise on your local system as described in Installing Wwise and Component Packages.

2. 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 good practice to create your own backup as well.

   3. Open the new version of Wwise. In the Project Launcher dialog that opens, select the project you plan to migrate.

      The Project Migration dialog opens prompting you to migrate the project to the later version of Wwise.

      	Note
      	The Migration dialog 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 Migrate.

      Wwise migrates 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 cache folder. When the project cache is deleted, the following message is displayed.

      

   5. Click OK.

   6. From the Wwise menu bar, click Views > Utilities > Logs. The Logs view opens.

   7. In the Logs view, select the Project Load tab. The Project Load log displays messages related to the migration and indicates if any files were created for the new version of Wwise.

      

      	Note
      	This information is stored in the file named projectname.wproj_migration.log in the project folder. If needed, you can click Copy to clipboard to save this information for later reference.

   8. If you are using source control, add any new files that were created during the migration process to your source control system.

   9. Close the Logs view.

3. Generate SoundBanks:

   1. Generate SoundBanks for migrated projects that will be used for testing.

1. Upgrade the Wwise SDK:

   1. Confirm that your system meets the Wwise SDK Platform Requirements.

   2. Optionally, uninstall the earlier version of the Wwise SDK.

      It's good practice to also manually remove any temporary files created by the sample C++ projects.

   3. Install the later version of the Wwise SDK. Refer to Install Wwise through the Launcher and select SDK (C++) under Packages.

   4. Verify that the WWISESDK environment variable points to the installation folder of the later version. (See Working with Multiple Versions of the Wwise SDK for more information on setting the environment variable.)

2. Update the game code for the later version of the Wwise SDK:

   1. Refer to the migration notes in the Wwise SDK documentation to familiarize yourself with the modifications you will be making.

   2. To migrate the game code, you must port the existing functionalities of the C++ project from the earlier version of the Wwise SDK to the later version. This task might include modifying or refactoring code in different modules. Changes to the following modules might need to be addressed to update the game code:

      • Sound Engine

      • Memory Manager

      • Stream Manager

      • Communications Module

      	Note
      	To ensure that your game is not adversely affected by some of the new features in the later version, we recommend you first 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.

   3. Modify the code as required.

      	Tip
      	It's good practice to rebuild the C++ project often when you are modifying the code.

3. Build your game.

Test the migrated game project, then commit:

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.

2. Commit your migrated Wwise project and the code changes to source control.

Upgrade Wwise on all workstations:

1. Optionally, uninstall all Wwise components. This might include:

   • Wwise authoring application

   • Wwise SDK

   For more information on uninstalling, refer to Uninstalling Wwise.

   	Note
   	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 later version of Wwise. This might include:

   • Wwise authoring application

   • Wwise SDK

   • Wwise Game Simulator

   For more information about installing, refer to Installing Wwise and Component Packages.

Access the migrated Wwise project on all workstations:

1. After you have installed the later 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.

   	Note
   	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.

   

5. Click OK.

   After the cache is deleted, the project is loaded into Wwise.