After your plug-in is built for all target platforms and configurations, you may want to package it for installation through the Audiokinetic Launcher. 以下の2つの手順を行います:
- それぞれのターゲットプラットフォームをパッケージングし、特別な Common プラットフォームもパッケージングします。パッケージングスクリプトで、必要なファイルをすべてWwiseインストールから自動的に取得できます。
- bundle.jsonファイルを生成します。このバンドル生成スクリプトで、以前にパッケージングしたアーカイブをあなたのプラグインディレクトリから自動的に取得できます。
例えば、以下をコマンドラインで実行すると、Common、Documentation、Windows_vc160、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_vc160 --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
version
引数は、Wwiseのバージョン番号フォーマットを使いますが、それは year.major.minor.build
です。
| 注釈: プラグインのDocumentation部分は、必須ではありません。 |
自分のプラグインに追加ファイルをパッケージングする
どのプラットフォームでも、 –additional-artifacts フラグ、または –additional-artifacts-file フラグを使い、追加のファイルをパッケージングできます。
–additional-artifacts-file フラグを使うには、パッケージする追加ファイルのパス一覧をJSONファイルで準備する必要があります。ターゲットパスは、実装されたWwiseのルートに対するものとし、ソースパスはプラグインディレクトリのルートに対するものとします。
例えば、以下は前セクションのコマンドラインですが、Windows_vc160とAuthoringのプラットフォームの追加DLLファイルをパッケージするために更新されました:
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_vc160 --version=XXXX.X.X.X --additional-artifacts-file=additional_artifacts.json
python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" package Authoring --version=XXXX.X.X.X --additional-artifacts-file=additional_artifacts.json
python "%WWISEROOT%/Scripts/Build/Plugins/wp.py" generate-bundle --version=XXXX.X.X.X
前の例で使われた additional_artifacts.json ファイルはプラグインディレクトリのルートにあり、以下のような内容です(プラグインディレクトリに lib/Debug/library.dll
と lib/Release/library.dll
が存在することが前提):
{
"Authoring": [
{
"Authoring/x64/Release/bin/Plugins": ["lib/Release/library.dll"]
}
],
"Windows_vc160": [
{
"SDK/Win32_vc160/Debug/bin": ["/lib/Debug/library.dll"],
"SDK/Win32_vc160/Release/bin": ["/lib/Release/library.dll"],
"SDK/x64_vc160/Debug/bin": ["lib/Debug/library.dll"],
"SDK/x64_vc160/Release/bin": ["lib/Release/library.dll"]
}
],
}
–additional-artifacts フラグの動作も似ていますが、一度に受け付けるパスは1つだけです(2つ以上の追加ファイルをパッケージするには、このフラグを複数回指定します)。
最後に、同じ additional_artifacts.json ファイルで、プロジェクトディレクトリにあるほかのファイルをパッケージします。パスの代わりに、destination -> sources の項目を設定します。前述の通り、DestinationのパスはあなたのWwiseインストールのルートに対するものとし、Sourceのパスはプラグインディレクトリのルートに対するものとします。以下は前のAuthoringプラットフォーム例を変えたもので、 Factory Assets や Help のファイルをパッケージできるように広げました:
{
"Authoring": [
{
"Authoring/x64/Release/bin/Plugins": ["lib/Release/library.dll"]
"Authoring/Help/<PluginName>": ["Help/*.pdf"],
"Authoring/Data/Factory Assets/<PluginName>": [
"FactoryAssets/*.wproj",
"FactoryAssets/*.xml"
]
}
],
"Windows_vc160": [
{
"SDK/Win32_vc160/Debug/bin": ["/lib/Debug/library.dll"],
"SDK/Win32_vc160/Release/bin": ["/lib/Release/library.dll"],
"SDK/x64_vc160/Debug/bin": ["lib/Debug/library.dll"],
"SDK/x64_vc160/Release/bin": ["lib/Release/library.dll"]
}
],
}
さらに、上記の追加アーティファクトファイルは、プロジェクトのルートから、あなたのWwiseインストールのルートまで、ファイルをコピーしやすくするために使えます。destination -> sources の設定は –copy-artifacts フラグを使ってコピーできます。これはパッケージ処理を完全に省略し、単純にファイルをコピーする方法です。
次のセクション: Creating Factory Assets for Your Plug-in