Skip to content

Commit

Permalink
update changelog and wwise docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dromer committed Nov 27, 2023
1 parent 71c0b3f commit 1a2aa26
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 3 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Next Release
* Daisy: adding midirealtimein, polytouchin/out, midiin (midiout WIP)
* DPF: enum for UI parameter IDs
* DPF bugfixes: correct input PortGroup names; correct UI slider updates; midiout reimplementation
* Wwise: complete rewrite/refactor - now uses SDK build tools - thanks to @eu-ch !!
* Cleanup: remove deprecated build.json
* Deprecate py37, enable py312

Expand Down
36 changes: 33 additions & 3 deletions docs/03.gen.wwise.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Wwise

## Version Support

`hvcc` will generate a Wwise plugin project that can be built with Audiokinetic's build system, see [Using the Development Tools](https://www.audiokinetic.com/en/library/edge/?source=SDK&id=effectplugin_tools.html). This system can generate project files for all supported platforms, as well as package the plugin for distribution with Wwise Launcher. Please refer to the official documentation for more details.

The minimum required SDK version is `2021.1.x` or higher.

## Feature Overview

Heavy currently supports the following Wwise features:
Expand All @@ -24,7 +24,7 @@ The type of plugin that **heavy** generates is dynamically determined depending

The Wwise target supports both [input and output parameters](02.getting_started.md#exposing-parameters).

![](img/docs_wwise_params.png)
![Send param](img/docs_wwise_params.png)

### Input Parameters

Expand Down Expand Up @@ -128,3 +128,33 @@ copy /y *.tar.xz Bundle
```

The *Bundle* directory now contains a packaged plugin you can install through Wwise Launcher, see Wwise Version -> Manage Plug-ins -> Install from directory / Install from archive.

## Example: Building Your Plugin on Linux

Building Linux plugin binaries is relatively easy. It requires python3 to be installed.
Also make sure the Linux SDK is in a path without spaces or special characters.

Then make sure the `premake5` binary in the SDK has the executable flag set:

```bash
<SDK_PATH>$ chmod +x Tools/Linux/bin/premake5
```

Now run the premake and build commands from your hvcc output directory:

```bash
$ cd <out_dir>/wwise/
<out_dir>/wwise$ python3 <SDK_PATH>/Scripts/Build/Plugins/wp.py premake Linux
<out_dir>/wwise$ python3 <SDK_PATH>/Scripts/Build/Plugins/wp.py build -c Release -x x64 Linux
```

This will put a plugin build into your `<SDK_PATH>/SDK/Linux_x64/Release/bin/` directory.

To create a package and bundle subsequently do the following:

```bash
<out_dir>/wwise$ python3 <SDK_PATH>/Scripts/Build/Plugins/wp.py package -v <VERSION> Linux
<out_dir>/wwise$ python3 <SDK_PATH>/Scripts/Build/Plugins/wp.py generate-bundle -v <VERSION>
<out_dir>/wwise$ mkdir Bundle
<out_dir>/wwise$ cp bundle.json *.tar.xz Bundle/
```

0 comments on commit 1a2aa26

Please sign in to comment.