|
Wwise SDK 2023.1.8
|
Building your Plug-in
The build command will use the solutions previously generated (refer to Configuring Your Project With Premake if there is no solution in the project folder) to compile the plug-in and copy the binary files to the Wwise installation. This command must be called from within the project folder and needs a few arguments in order to do its job properly. Here is a typical build command:
This will build the project in release mode (-c flag), targeting the architecture x64 (-x flag) and MSVC toolset vc160 (-t flag), for the platform Authoring on the current operating system. Consult the help of the build command for more details about the possible values of its arguments.
The binaries will output directly to your Wwise installation and will be ready for testing:
- For the SoundEngine plug-in part, go to
%WWISEROOT%/SDK/{Platform}/{Config}/{bin,lib}. - For the Authoring plug-in part on Windows, go to
%WWISEROOT%/Authoring/x64/{Config}/bin/Plugins. - For the Authoring plug-in part on macOS, go to
%WWISEROOT%/Authoring/macosx_gmake/{Config}/bin/Plugins. - For the Authoring plug-in part on Linux, go to
%WWISEROOT%/Authoring/linux_gmake/{Config}/bin/Plugins. - For the Documentation plug-in part, go to
%WWISEROOT%/Authoring/Data/Plugins/{PluginName}/Html.
 | Note: Some platforms build the plug-in for multiple toolchain versions during execution of the
If desired, it is also possible to override either of these when executing the build command in wp.py, by specifying The projects generated by wp.py also automatically adjust the build output folder for the toolchain version that the project is compiled against, based on the defined environment. For more information on how this is determined for each platform, refer to the corresponding Platform-Specific Information page, which describes this in further detail. |
Adding a Target Platform
Target platforms can be added at any point during the development of your plug-in. This is done by premaking and building a platform. You will at least want to build one platform and, if you build for Authoring, you'll probably also want to build the Documentation. This will install the documentation for the plug-in properties, which is shown in the Property Help panel when a property is selected.
For example, run the following in a command-line to premake and build the Windows_vc160 and Authoring platforms:
Executing Post-Build Actions Using Hooks
It is common to want to execute custom actions after building a specific target. This can be achieved by adding the –build-hooks-file flag to the build command and specifying a Python file. This file must be created by the User and is not part of the initial skeleton generated by the new command. For example, this illustrates the content of a post-build hook file:
This example calls a post-build hook for the Windows_vc160 and Authoring platforms:
The build_hooks.py file must be located at the root of the plug-in directory.
Another example copies a DLL file "library.dll" from the plug-in directory to the Wwise installation:
The last step to perform, when the development of the plug-in is finished, is to package the project in a format ready to install by the Audiokinetic Launcher. Refer to Packaging Your Plug-in for the Audiokinetic Launcher for more details.
Next section: Packaging Your Plug-in for the Audiokinetic Launcher
Was this page helpful?
Need Support?
Questions? Problems? Need more info? Contact us, and we can help!
Visit our Support pageTell us about your project. We're here to help.
Register your project and we'll help you get started with no strings attached!
Get started with Wwise