目录

Wwise SDK 2018.1.11
使用开发工具

首次设置

在使用开发工具之前,必须安装 Python 2 或 3。

若要构建属性帮助文档,必须安装以下两个 Python 依赖项:

pip install markdown
pip install jinja2

另外,还要将目标平台所需构建工具安装到相应路径下。如需进一步了解所需安装的构建工具,请参阅 平台要求

Caution: 在通过 Wwise Launcher 安装 Wwise SDK 时,请确保选中所有目标平台。

工具概述

对于给定版本的 Wwise SDK,插件开发工具存放在 WWISEROOT%/Scripts/Build/Plugins 下。

快速查看一下此目录中的文件,便会发现有以下 Python 脚本可供使用:

  • new.py 辅助创建新的插件。
  • premake.py 调用 Premake 以便为给定目标平台生成解决方案。
  • build.py 调用针对给定目标平台和配置提供的构建工具。
  • package.py 将二进制及其他文件(帮助、出厂素材等)打包到 tar.xz 存档中。
  • generate_bundle.py 生成 JSON 元数据文件以便用于 Wwise Launcher。
  • wp.py 方便以子命令形式访问所有其他脚本。
Caution: 这些脚本通常假定当前工作目录即为插件的根目录,因此请在调用前确认所在目录是否正确。
Note: 您可以通过 -h-help 命令行标记来查看有关如何使用这些脚本的详细信息。

创建插件

若要创建新的插件,请在命令行中直接运行以下代码:

python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" new
(answer prompts)
cd <PluginName>

这样可在当前工作目录下创建以插件名称命名的目录。您现在就可以开始编写插件了!如需了解如何编写音频插件,请参阅 音频插件

Note: 若经常使用相同的设置生成插件或想要自动完成这项任务,则可通过将前述提问作为命令行参数传递来实施预填充。

添加目标平台

在开发插件的过程中,随时都可以添加目标平台。为此,可使用 premake 和 build 来添加所需平台。

比如,通过在命令行中运行以下代码,来同时添加 Windows_vc140 和 Authoring 平台:

python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" premake Windows_vc140
python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" premake Authoring
python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" build Windows_vc140 -c Debug
python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" build Authoring -c Debug
python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" build Documentation

二进制文件会直接输出到 Wwise 安装目录中以供稍后测试:

  • 对于插件的 SoundEngine 部分,会存放到 WWISEROOT%/SDK/<Platform>/<Config>/{bin,lib} 下。
  • 对于插件的 Authoring 部分,会存放到 WWISEROOT%/Authoring/x64/<Config>/bin/plugins 下。
  • 对于插件的 Documentation 部分,会存放到 WWISEROOT%/Authoring/Data/Plugins/<PluginName>/Html 下。

将插件打包以便用在 Wwise Launcher 中

在针对所有目标平台和配置构建插件后,需要将其打包以便通过 Wwise Launcher 安装。为此,请执行以下两个步骤:

  1. 打包各个目标平台以及专用的 Common 平台。打包脚本会从 Wwise 安装目录自动检索全部所需文件。
  2. 生成 bundle.json 文件。捆绑包生成脚本会从插件目录自动检索之前打包的存档。

比如,通过在命令行中运行以下代码,来打包 Common、Documentation、Windows_vc140 和 Authoring 平台:

python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" package Common --version=XXXX.X.X.X
python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" package Documentation --version=XXXX.X.X.X
python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" package Windows_vc140 --version=XXXX.X.X.X
python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" package Authoring --version=XXXX.X.X.X
python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" generate-bundle --version=XXXX.X.X.X
Note: 在继续生成捆绑包之前,可能要先编辑 bundle_template.json 文件。如需进一步了解插件打包格式及其与 Wwise Launcher 的关系,请参阅 为 Wwise Launcher 打包插件
Note: 您可以通过 –additional-artifacts 标记为所需平台打包其他文件。
Note: 插件的 Documentation 部分为可选部分。