Managing a Wwise Project of any size is challenging. Whether you are a single contributor, or a team of dozens, it can be difficult to keep up with all the changes going into the project with the frenzy of production schedules. Mistakes are easy to make, but can be hard to catch. Often the difference between content working perfectly and an egregious bug is a single checkbox.
The Wwise Offline Tests tool allows you to define and enforce rules about how content should be setup within a Wwise Project. These rules can range from nice to have (eg naming conventions) to critical (eg a sound that should attenuate but doesn't). Once these tests are defined, it's quick and easy to check for issues frequently, either manually or as part of an automated process.
Fundamentally, a Wwise Offline Test is a single Wwise Query which should expect to find no results. Test queries are written in such a way that they only find incorrect Wwise data. For example: if you consider it to be problematic for content to be routed directly to the Master Audio Bus, then a Wwise Test could search for any content that is routed to the Master Audio Bus. When a test finds any results, that test has “Failed” and issues will be listed out so they can be addressed.
The tool is currently in an early Beta. You can download the latest release here
https://github.com/ourjeigh/wwise_offline_tests_release
<aside>
</aside>
<aside>
</aside>
The tests can be setup in one of two places: either in the Wwise Project directory or the Wwise Authoring App install directory. Adding to the Wwise Project is recommended since it allows anyone using that Wwise Project to utilize the tests, and makes it easier to create project-specific tests, but both locations will work.
To add Wwise Offline Tests to the Wwise Project, copy the provided wwise_offline_tests_commands.json and entire wwise_offline_tests directory to [WwiseProjectRoot]\Add-ons\Commands directory. You may need to create the Add-ons and Commands folders first if this is your first time working with custom commands. The correct setup should look like this:
Once the files are added to the Commands directory, you can either close and reopen the project or reload the commands if Wwise is already open.
To instead setup in the Wwise Authoring App directory, copy the provide wwise_offline_tests_commands.json and entire wwise_offline_tests directory to [WwiseInstallRoot]\Authoring\Data\Add-ons\Commands directory. You may need to create the Add-ons and Commands folders first if this is your first time working with custom commands. The correct setup should look like this:
Next you will need to open the wwise_offline_tests_commands.json file in a text browser and replace the instances of WwiseProjectAddons with WwiseInstallAddons . This tells Wwise to find the wwise_offline_tests.exe in the install commands folder instead of the default project folder. The result should look like this:
Once the files are added to the Commands directory, you can either close and reopen the project or reload the commands if Wwise is already open.
Before creating and running any tests, you’ll need to create a config file for the app to use. This allows you to define input and output directories needed to run the tests, and contains other settings you can customize for your needs.
From the top drop-down menu, select Wwise Offline Tests > Open Wwise Offline Tests Config
This will create a new file in the wwise_offline_tests app directory named wwise_offline_tests.config and will open it in your default text editor. If you run this command again it will not create a new config file, but will open the existing one for quick access to edit.
The following default properties will be set, see below for a description of each. The two properties that must be set before proceeding are TestDefinitionsDirectory and ReportOutputDirectory.
{
"GenerateHtml": true,
"GenerateJson": false,
"OpenResults": true,
"EnableLogging": false,
"TestDefinitionsDirectory": "",
"ReportOutputDirectory": "",
"WampPort": "8080",
"UseWwiseConsole": false,
"WwiseConsoleWampPort": "8081",
"WwiseConsoleHttpPort": "8091",
"WwiseExeDirectory": "[Path to your installed Wwise Authoring App bin directory]",
"WwiseProjectFile": "[Path to your Wwise Project file]",
"WwiseProjectCommandsDirectory": "[Path to your Wwise Project Commands directory]"
}
<aside>
⚠ Important: Both TestDefinitionsDirectory and ReportOutputDirectoryPath need to be set before creating and running tests.
</aside>
GenerateHtml
Default True.
When enabled, running the tests will generate an html results file to view the results of the test. This is the default result output and should be enabled if you wish to view the test results after running.