wp-enhanced 0.5.8

Wrapper of `wp.py`. Easy to premake, build, and deploy wwise plugins.

wp-enhanced

Wrapper of wp.py. Easy to premake, build, deploy and distribute wwise plugins.

Installation

1. Install wpe from pip

   pip install wp-enhanced
   

2. Set wwise environment variables

   • Windows:

     • Set from Wwise Launcher

     

   • MacOS:

     • Set WWISEROOT and WWISESDK manually

3. Check installation

   wpe -h
   

Create new plugin project

Run wpe -n to create new project like original wp.py, but with some additional features.

Parameters code generation

You can define parameters in $PROJECT_ROOT/.wpe/wpe_parameters.toml and generate code for them by running wpe -gp.

Be careful the followed files will be overwritten by template if [wp-enhanced template] is not found in file:

• ProjectNameFXParams.cpp
• ProjectNameFXParams.h
• ProjectName.xml
• ProjectNamePlugin.cpp
• ProjectNamePlugin.h

New plugin project will be created with default parameters: wpe_parameters.toml

Hooks

All hooks should be placed in $PROJECT_ROOT/.wpe/hooks folder.

pre/post_premake/generate_parameters/build/pack are supported.

A default post_build.py is created when creating new project, which will copy debug authoring plugin to Release folder for loading in Wwise Authoring.

For more information about hooks, please refer to description of -H, --with-hooks in wpe -h

Add wpe to existing project

Run wpe -i under project root.