|
Wwise SDK 2024.1.0
|
After your plug-in is built for all target platforms and configurations, you may want to package it for installation through the Audiokinetic Launcher. This is a two-step process:
- Package each of your target platforms, as well as the special Common platform. The packaging script will automatically retrieve all of the required files from your Wwise installation.
- Generate the bundle.json file. The bundle generation script will automatically retrieve the previously packaged archives from your plug-in directory.
For example, run the following in the command-line to package the Common, Documentation, Windows_vc160, and Authoring platforms:
The version argument uses the Wwise version number format, which is year.major.minor.build.
 | Note: Also, you may want to edit the bundle_template.json file before bundle generation. Refer to Plug-in Packaging Format for the Audiokinetic Launcher for more information on the plug-in packaging format and how it relates to the Audiokinetic Launcher. |
| Note: The Documentation part of the plug-in is optional. |
Packaging Additional Files With Your Plug-in
Additional files can be packaged with any platform using either the –additional-artifacts flag or the –additional-artifacts-file flag.
When using the –additional-artifacts-file flag, a JSON file listing the paths of additional files to package must be provided. The target paths must be relative to the root of your Wwise installation and the source paths must be relative to the root of the plug-in directory.
For example, this is the command-line from the previous section: it is updated to package an additional DLL file with the Windows_vc160 and Authoring platforms:
The additional_artifacts.json file used in the previous example is located at the root of the plug-in directory and has the following content (assuming that lib/Debug/library.dll and lib/Release/library.dll exist in the plug-in directory):
The –additional-artifacts flag behaves similarly, but only accepts a single path at a time (the flag must be specified multiple times to package more than one additional file).
Finally, the same additional_artifacts.json file can be used to package other files that are located in the project directory. Specify a destination -> sources entry, instead of a path. As stated previously, the destination path must be relative to the root of your Wwise installation and source paths must be relative to the root of the plug-in directory. Here is a new version of the previous Authoring platform example, which now extends to package Factory Assets and Help files:
The additional artifacts file presented above can further be used to facilitate the copy of files from the project root to the root of your Wwise installation. The destination -> sources entries can be copied using the –copy-artifacts flag. This option will skip packaging altogether and simply copy the files.
Next section: Creating Factory Assets for Your Plug-in
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