使用Wwise バージョン
arrow_right 目次
Wwise SDK 2018.1.11
開発ツールを使う

初回の設定

開発ツールを使う前に、Python 2または3をインストールしてください。

Property Helpのドキュメンテーションをビルドするには、以下の2つのPythonの依存性(dependency)をインストールする必要があります:

pip install markdown
pip install jinja2

また、ターゲットプラットフォームに必要なすべてのビルドツールをインストールして、PATHに入れておく必要があります。どのビルドツールをインストールする必要があるかについては、 プラットフォーム要件 を参照してください。

Caution: Wwise LauncherでWwise SDKをインストールするときに、必ず、ターゲットとなるプラットフォームをすべて選択してください。

ツールの概要

Wwise SDKの特定バージョンにおいては、プラグインの開発ツールが"%WWISEROOT%/Scripts/Build/Plugins"下にあります。

このディレクトリにあるファイルを見れば、あなたが使える以下のPythonスクリプトのリストが確認できるはずです。:

  • new.py は、新規プラグインを作成するのに使います。
  • premake.py は、Premakeをコールし、特定ターゲットプラットフォーム用のソリューションを生成します。
  • build.py は、特定ターゲットプラットフォームと設定用のビルドツールをコールします。
  • package.py は、あなたのバイナリや、ほかのファイル(helpやfactory assetsなど)を、tar.xzアーカイブにパッケージングします。
  • generate_bundle.py は、Wwise Launcherで使うJSONメタデータファイルを生成します。
  • wp.py は、ほかのすべてのスクリプトを、サブコマンドとしてアクセスできるようにします。
Caution: これらのスクリプトは一般的に、カレントワーキングディレクトリをあなたのプラグインのルートとみなすので、コールする前に必ず、現在のディレクトリが正しいことを確認してください。
Note: これらのスクリプトの使い方の詳細は、 -h または –help のコマンドラインフラグで確認できます。

プラグインの作成

新しいプラグインを作成するには、以下のコマンドラインを実行するだけです:

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

これで、カレントワーキングディレクトリに、あなたのプラグインの名前を付けたディレクトリが作成されます。早速、プラグインを書き始めてください!オーディオプラグインの書き方に関しては、 オーディオプラグイン を参照してください。

Note: 同じ設定を複数のプラグインの作成でよく使う場合や、そのタスクを自動化したい場合は、コマンドライン引数としてパスすれば、プロンプトに自動入力できます。

ターゲットプラットフォームの追加

あなたのプラグインの開発中に、いつでもターゲットプラグインを追加できます。追加するには、そのプラットフォームをプリメイクしてビルドします。

例えば、以下のコマンドラインを実行すれば、Windows_vc140とAuthoringの2つのプラットフォームをプリメイクし、ビルドできます。

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経由のインストールができるように、そのプラグインをパッケージングすることができます。手順は2段階に分かれています:

  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部分は、必須ではありません。