Version
In your project development environment, you may already be using a source control system to effectively manage your assets and other types of project files. All Wwise project files, including the individual Work Units, are XML-based, which means you can use your source control system to easily manage these files as well.
The following files within your project can be managed by your source control system:
Wwise project file - The WPROJ file.
Wwise Work Units - The WWU files, including the Default Work Units.
Originals folder - The folder that contains the original sound files that were imported into Wwise.
Generated SoundBanks - The project's generated SoundBank files for each platform and language, except for the SoundbanksInfo.xml and PluginInfo.xml files. These XML files should not be added to your source control system, as they can cause unnecessary merge conflicts. Wwise will regenerate these files if they are not present when needed.
Caution | |
---|---|
The .cache folder located in your project directory is a local working folder for Wwise. The contents of the .cache folder should not be added to your source control system because it may cause unexpected behaviors in Wwise. |
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 Workgroup plug-in, you will be able to perform source control functions directly in Wwise. For more information about using a Workgroup plug-in in Wwise, refer to Managing Project Files Using a Workgroup 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 Workgroup 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 Workgroup Tips & Best Practices.
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageRegister your project and we'll help you get started with no strings attached!
Get started with Wwise