|
Wwise SDK 2023.1.8
|
このページは、プラグイン作成者を対象としています。Audiokinetic LauncherとWwiseプラグインストアの両方に対応したWwiseプラグインのパブリッシュ関連の要件を、作成者に説明することが目的です。プラグイン作成そのものに関しては、 Developing Community Plug-ins を参照してください。
完全に互換性のあるWwiseプラグインをパブリッシュするための必要な手順を、以下のセクションで説明します:
プラグインのパッケージング
Audiokinetic Launcherと互換性を保ち、そのプラグイン管理ワークフローを活用するには、プラグイン作成者はプラグインを非常に特殊な方法でパッケージングする必要があります。Audiokinetic Launcherはバンドルを作業単位として、バンドルは例えばプラグインのインストールを進める上で必要なファイルやメタデータを全て含む、自己完結フォルダまたはアーカイブのことです。
定義
プラグインのパッケージング方法に入る前に、ここで使う用語の定義を最初に行います。用語に対して可能な設定値を下表で定義しますが、もし以下の1つがカギ括弧（<Term>）で囲われていれば、該当する数値に拡張できます。
| |
| Android OpenHarmony iOS tvOS visionOS Mac Linux Windows_vc160 Windows_vc170 XboxOne XboxSeriesX PS4 PS5 NX | android-9_armeabi-v7a android-9_x86 android-21_arm64-v8a android-21_x86_64 OpenHarmony_arm64-v8a iOS Linux_x64 Mac NX64 PS4 PS5 tvOS visionOS Win32_vc160 Win32_vc170 x64_vc160 x64_vc170 XboxOneGC_vc160 XboxOneGC_vc170 XboxSeriesX_vc160 XboxSeriesX_vc170 |
バンドルのディレクトリ構造
プラグインバンドルとは、平面のディレクトリつまりアーカイブに以下のファイルを複数組み合わせたものです（bundle.js以外の必須ファイルはありません）。
プラグインの、バンドルディスクリプションファイル。 | |
すべてのオーサリングファイルの入ったパッケージで、バイナリ、データ、リーガルノーティスなどのファイルが含まれます。このパッケージは、実際には必要に応じて複数のファイルに分けることができます。例: Data、Binary、Documentationと分割できます。ただし、全てのパッケージが必ずインストールされます。 | |
プラットフォーム固有でないSDKファイルが全て入ったパッケージで、プラグインヘッダファイルも含む。 | |
あるデプロイメントプラットフォーム専用の、Wwise SDKプラグインファイル。 |
 | 注釈: アーカイブフォーマット バンドル内にあるアーカイブファイルは必ずTAR.XZ、またはZIP形式として、Audiokinetic Launcherは、bundle.jsonファイルの中に指定されたメタデータを使って、これを抽出します。なお、バンドル自体もAudiokinetic Launcherに対して.tar.xzアーカイブとして（フォルダの代わりに）渡すことができます。 |
これらのアーカイブ内のフォルダ構成は、必ず以下のフォーマットに従うものとします。Wwiseオーサリングは、64-bitプラグインだけをサポートしているので、ご注意ください。Wwise 2017.2で、32-bitサポートを削除しました。
| 注釈: Legal Notice プラグインプログラマーは、自分のプラグインコードに関連するすべての法的通知を、必ずここにコピーしてください: \Authoring\x64\Release\bin\plugins\PluginName.txt |
例
以下は、Wwiseオーサリングと、Linux_x32やLinux_x64のWwise SDKプラットフォームをサポートするプラグインバンドルの例です。
バンドルのメタデータ
バンドル内にあるbundle.jsonファイルは、以下のように構成します（別途記載ない限り、全フィールドが必須です）。
| 注釈: 固有プラグインID ほかのプラグインとのコンフリクトを回避するために、以下の情報をプラグインの固有IDにエンコードすることが、必須です:
|
バンドルグループ
bundle.jsonで指定した全てのファイルが、1つ以上のグループにリンクしている必要があります。Audiokinetic Launcherはこの情報を使って、特定のファイルをインストールする必要があるのかを状況に応じて判断します。
| |
| Packages | Authoring |
| DeploymentPlatforms | (定義のDeploymentPlatforms列を参照。) |
例
前述の例に続き、以下は、Wwiseオーサリングと、Linux_x32やLinux_x64のWwise SDKプラットフォームをサポートするプラグインバンドルに対応するbundle.jsonであり、英語ドキュメンテーションが付随します:
バージョン管理
各プラグインバンドルは、Wwiseの特定バージョンを対象としています。ただし、Wwiseの各バージョンは、それ以前のバージョンを対象としたプラグインに対応しています。
Wwiseのマイナーバージョン同士の互換性は、常に維持されます。例えば、2017.1.1と2017.1.2は、互いに互換性があります。また、メジャーリリース同士も互換性を保つ可能性がありますが、Wwiseのメジャーバージョンに合わせてプラグインもアップデートするつもりでいてください。Wwiseの現行バージョンと互換性のあるプラグインバージョンを確認するには、Release Notesを参照してください。
互換性が終了する度に、プラグインベンダーはバンドルの新バージョンをリリースする必要があります。Launcherは、互換性のないバージョンのプラグインをインストールすることを防ぎます。プラグインバンドルをaudiokinetic.comに登録してホストされると、互換性があればWwiseインストールの際に自動的にオプションとして表示されます。