バージョン
各Work Unitを含め、WwiseプロジェクトファイルはすべてXMLファイルのため、ソース管理に適しています。一部のファイルは、ソース管理に追加することが推奨されます。
File Managerに表示されるファイルは、すべてソース管理への追加が可能です。Wwiseはこれらのファイルを使用し、プロジェクトで必要なほかのあらゆるファイルを生成します。以下はソース管理に追加することが推奨されます:
.wproj - Wwiseのプロジェクトファイル。プロジェクトフォルダのルートにあります。
.wwu - Wwise Work Unit。これらのファイルはメインプロジェクトフォルダのサブディレクトリ内のさまざまな場所にあります。
Originalsフォルダ - オリジナルのメディアファイル。これらのファイルは、プロジェクトの最終的なオーディオアセットを作成するために使用されます。
一般的にWwiseが生成したファイルはソース管理から除外できます。ソース管理への追加は不要な上、複数のユーザがいる環境では、一部のファイルは共有すると同期関連の問題を引き起こす可能性があります。以下は除外することが推奨されます:
.backupフォルダ - プロジェクトをWwiseの新しいメジャーバージョンで開くと、プロジェクトがアップグレードされ、.backupフォルダが生成されます。必要に応じて、.backupフォルダを使用してプロジェクトのアップグレードを元に戻すことができます。プロジェクトがソース管理にある場合はそこから元に戻せるため、.backupはソース管理から除外できます。
.cacheフォルダ - プロジェクトディレクトリにある.cacheフォルダは、Wwiseの作業用ローカルフォルダです。.cacheフォルダの中身をソース管理システムに追加すると、Wwiseが予期せぬ動作を起こすことがあるため避けてください。
.prof - キャプチャーごとに生成されるファイルで、プロジェクトデータではありません。
.validationcache - .wwuファイルから生成され、除外できます。
.wsettings - ローカルのユーザとコンピュータに固有のファイルです。
IncrementalSoundBankData.xml - このファイルはWwiseプロジェクトのローカルコンテンツと、ローカルのSoundBank生成履歴に基づき、SoundBankの状態を追跡します。
新しいプロジェクトを作成すると.gitignoreファイルと.p4ignoreファイルが含まれます。以下にサンプルの.gitignoreファイルを示します:
# Wwise .backup* .cache* *.akd *.prof *.validationcache *.wsettings IncrementalSoundBankData.xml
SoundBankはいつでもプロジェクトから生成できます。しかし、Wwiseを利用していないチームメンバーが開発中にゲームをプレイしながらサウンドを聞くには、生成済みのファイルを提供する必要があります。1つの方法として、ソース管理を使うとチームメンバーがアクセスできるようになります。2人以上のWwiseユーザがソース管理にSoundBankを追加する場合は、ファイルの同期がうまく行われなくなる可能性があります。これを回避するため、すべての.bnkファイルと.wemファイルをsoundbanks/パスに追加します。Wwiseがどのようにゲームエンジンと統合されているかによって、.txtファイル、.xmlファイル、.jsonファイルの追加が必要な場合もあります。
またプロジェクトの大容量ファイルもGit LFSを使うなど、時間を節約するために特別な対応が必要かもしれません。Git LFSの除外ファイルに、.wav、.aif、.png、.jpgなどのサイズの大きいバイナリファイルを入れることができます。
ゲーム開発中にいつでもプロジェクトファイル(.wproj)、Work Unitファイル(.wwu)、オーディオファイルのステータスをFile Managerで確認できます。またPerforceやSubversionなどのソース管理プラグインを使用する場合、ソース管理関数をWwiseから直接実行できます。Wwiseでのソース管理プラグインの使い方については「Managing project files with a source control plug-in」をご参照ください。
WwiseはデフォルトでWork Unitファイル、SoundBankファイル、一部のプロジェクトファイルをLF改行コードで保存します。Wwiseでは、それらをCRLF改行コードで保存することもできます。Project Settingsの「Generalタブ」にあるLine Endingをご参照ください。
複数のチームメンバーとの作業でソース管理システムを使用してプロジェクトファイルを管理する場合、他の人も同じプロジェクトで作業をしているため、マージコンフリクトの解消が必要になることがあります。頻繁に作業結果を同期してマージすることが重要で、常にチームメンバー同士がお互いの作業内容を共有できるようにしてください。ベストプラクティスのリストが 「Source control tips and best practices」にあります。