|
Wwise SDK 2022.1.17
|
This page is intended for plug-in authors. It seeks to inform them of the requirements related to publishing a Wwise plug-in that is compatible with both the Audiokinetic Launcher and the Wwise plug-ins Store. For more details on plug-in creation itself, please consult Developing Community Plug-ins.
The following sections take you through the necessary steps to publishing a fully compatible Wwise plug-in:
Plug-in packaging
In order to be compatible with the Audiokinetic Launcher and benefit from its plug-in management workflows, plug-in authors need to package their plug-ins in a very specific way. The Audiokinetic Launcher works in terms of bundles, as in a self-contained folder or archive containing all the files and metadata required to proceed with the installation of the plug-in.
Definitions
Before delving into how plug-ins can be packaged, we need to define some of the terms that will be used. The following table defines the possible values for these terms, meaning that wherever you see one of them enclosed in angled brackets (<Term>), it can be expanded to the corresponding values.
| |
| Android OpenHarmony iOS tvOS visionOS Mac Linux Windows_vc150 Windows_vc160 Windows_vc170 XboxOne XboxSeriesX UWP_vc150 PS4 PS5 NX | android-9_armeabi-v7a android-9_x86 android-21_arm64-v8a android-21_x86_64 OpenHarmony_arm64-v8a iOS Linux_x64 Mac NX64 PS4 PS5 tvOS visionOS UWP_vc150 UWP_vc160 UWP_vc170 Win32_vc150 Win32_vc160 Win32_vc170 x64_vc150 x64_vc160 x64_vc170 XboxOne_vc150 XboxOne_vc160 XboxOne_vc170 XboxSeriesX_vc150 XboxSeriesX_vc160 XboxSeriesX_vc170 |
Bundle directory structure
A plug-in bundle is a flat directory or archive that can contain any combination of the following files (no files are mandatory except for bundle.json).
Plug-in bundle description file. | |
Package containing all authoring files, including binary, data, and legal notice files. This package can actually be separated in several files if required. Ex: You could split the Data, Binary, and Documentation. However, all packages will always be installed. | |
Package containing all non-platform specific SDK files, including the plug-in header files. | |
Wwise SDK plug-in files specific to a deployment platform. |
 | Note: Archive format The archive files present inside of a bundle must be provided in the TAR.XZ or ZIP formats and will be extracted by the Audiokinetic Launcher using the metadata specified inside of the bundle.json file. Note that the bundle itself can also be given to the Audiokinetic Launcher as a .tar.xz archive (instead of a folder). |
The folder structure inside of these archives must respect the following format. Please note that we only support 64-bit plug-ins in Wwise Authoring. We removed 32-bit support with Wwise 2017.2.
| Note: Legal Notice Plug-in programmers should copy any Legal Notice related to their plug-in code here: \Authoring\x64\Release\bin\plugins\PluginName.txt |
Example
Here is an example of a plug-in bundle supporting the Wwise Authoring as well as the Linux_x32 and Linux_x64 Wwise SDK platforms.
Bundle metadata
The bundle.json file contained in the bundle should be structured as follows (all fields are mandatory unless specified).
| Note: Unique Plug-in Identifier To avoid conflicts with other plug-ins, it is mandatory to encode the following information in the plug-in unique identifier:
|
Bundle groups
Each file specified in the bundle.json must be linked to one or multiple groups. This information will be used by the Audiokinetic Launcher to determine if a given file has to be installed according to the context.
| |
| Packages | Authoring |
| DeploymentPlatforms | (Please refer to the DeploymentPlatforms column in Definitions.) |
Example
Continuing from our previous example, here is the corresponding bundle.json for a plug-in bundle supporting the Wwise Authoring as well as the Linux_x32 and Linux_x64 Wwise SDK platforms; it comes with English documentation:
Version Management
Each Plug-in Bundle targets a specific version of Wwise. However, each version of Wwise can support plug-ins targeting previous versions of Wwise.
Compatibility between Wwise minor versions will always be retained. For example, 2017.1.1 and 2017.1.2 are compatible. It is also possible that major releases retain compatibility; but, you should be prepared to update your plug-ins with Wwise major versions. Consult the Release Notes to know which plug-in versions are compatible with the current version of Wwise.
Each time we break compatibility, the plug-in vendor needs to release a new version of the bundle. Installing an incompatible version of a plug-in through the Launcher will be prevented. Plug-in bundles registered and hosted on audiokinetic.com will automatically appear as options during Wwise Installation, if they are compatible.
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