Wwise Help

All Wwise project files, including the individual Work Units, are XML, making them well suited to source control. We recommend that certain, but not all, files be added to source control.

All of the files that appear in the File Manager can be added to source control. Wwise uses these files to generate any other files needed by your project. We recommend adding the following to source control:

In general, files generated by Wwise can be excluded from source control. Not only is adding them to source control unnecessary, but in a multi-user environment sharing certain files can cause synchronization problems. We recommend excluding:

Note that .gitignore and .p4ignore files are included when creating a new project. Here is a sample .gitignore file:

# Wwise
.backup*
.cache*
*.akd
*.prof
*.validationcache
*.wsettings
IncrementalSoundBankData.xml

SoundBanks can always be generated from the project. However, if you have team members who do not use Wwise they will need these generated files to hear sounds while playing the game in development. Source control could be a way to provide them access. If more than one Wwise user is adding SoundBanks to source control, the files can become desynchronized. To avoid this, add all .bnk and .wem files in the soundbanks/ path. Depending on how Wwise is integrated with your game engine you may also need to add .txt, .xml, and .json files.

Large files in your project may also require special handling to save time, for example using Git LFS. The Git LFS exclusion file could include large binary files such as .wav, .aif, .png, and .jpg.

Throughout the development of your game, you can view the status of your project file (.wproj), Work Unit files (.wwu), and audio files in the File Manager. If you are using the Perforce, Subversion, or another source control plug-in, you can perform source control functions directly in Wwise. For more information about using a source control plug-in in Wwise, refer to Managing project files with a source control plug-in.

By default Wwise saves Work Unit files, SoundBank files and some project files with LF line endings. Wwise can save them with CRLF endings. See Line Ending in the General Tab of the Project Settings.

When you are working as part of a team and are using a source control system to manage the files in your project, you should always be aware that others are working on the same project and that there may be merge conflicts that need to be resolved. This is why it is important to sync and merge your work often and to communicate frequently with your team members about the work you are doing. For a complete list of best practices, refer to Source control tips and best practices.