This repository is a collection of tools to be used inside Audiokinetic Wwise. The tools use WAAPI (Wwise Authoring API) and Python to perform several automated tasks.
Refer to General Setup Instructions below, then find the specific instructions README.md in the sub-folders.
- Python 3.6+
- Running instance of Wwise.exe with the Wwise Authoring API enabled (Project > User Preferences... > Enable Wwise Authoring API)
- waapi-client python project installed
We recommend to use the Python Launcher for Windows which is installed with Python 3 from python.org.
- Install Python 3.6 or greater from: https://www.python.org/downloads/
- Windows:
py -3 -m pip install waapi-client scipy - Other platforms:
python3 -m pip install waapi-client scipy
Additional instructions can be found at: https://pypi.org/project/waapi-client/
- Ensure the folder
%APPDATA%\Audiokinetic\Wwise\Add-onsis present. CreateAdd-onsif not present. - Download this whole repository zip file from GitHub.
- Unzip the content from
waapi-python-toolsfolder insideAdd-ons. - Restart Wwise or use the command Reload Commands
At the end, the following file structure should be present:
%APPDATA%\Audiokinetic\Wwise\Add-ons\Commands\waapi-python-tools.json
- Download this whole repository zip file from GitHub.
- Unzip the content of zip file on your computer.
- In Wwise, open Project > User Preferences.
- Add
<tool-name>.cmdin the External Editors list.
- Windows:
py -3 <tool-name> - Other platforms:
python3 <tool-name>
Replace <tool-name> by the name of the folder you want to use.
To learn more about WAAPI: https://www.audiokinetic.com/library/edge/?source=SDK&id=waapi.html
To learn more about using Python with WAAPI: https://www.audiokinetic.com/library/edge/?source=SDK&id=waapi_client_python_rpc.html
To learn more about Command Add-ons: https://www.audiokinetic.com/library/edge/?source=SDK&id=defining_custom_commands.html