WwiseのオープンアーキテクチャではSource Controlプラグインを使用または作成し、ユーザのソース管理ソフトウェアを簡単に統合することができます。ソースコントロールプラグインによりWwiseとユーザのソースコントロールソフトウェアの間のリンクが作成され、ファイルを管理してWwise上でチェックインやチェックアウトなどのソースコントロール機能を直接実行できるようになります。
ソースコントロールシステムの仕組みはそれぞれ異なるため、使用するシステムによって利用できる機能や採用するワークフローが変わります。
はじめやすいように、ソフトウェア構成管理システムであるPerforce®とSubversionのための実際に機能する2種類のソースコントロールプラグインがWwiseに同梱されています。PerforceとSubversionは、コピー・編集・マージ方式を採用し、ロック・編集・アンロック方式と異なります。このモデルでは、各チームメンバーがレポジトリまたはディポを読み込み、クライアントワークスペース、つまりファイルやプロジェクトの自分専用の作業用コピーを入れたディレクトリを、自分のワークステーション上に作成します。チームメンバーは各自の個人的コピーを編集するので、全員が同時に作業できます。準備ができた時点で、各メンバーが個人的コピーをマージさせ、新しいファイナルバージョンができます。コンフリクトが発生した場合はバージョンコントロールシステムがマージを支援しますが、最終的に問題を正しく解決するのはユーザの責任となります。
これ以外のソースコントロール管理システムを使用している場合は、Wwise用のソースコントロールプラグインをユーザが作成することができます。独自ソースコントロールプラグインの作成と統合の詳細は、SDKドキュメントの Source Controlプラグインの作成 を参照してください。
Project SettingsダイアログでSource Controlプラグインを選択して設定することができます。詳しくは「Configuring source control plug-ins」を参照してください。
ソースコントロールプラグインを使うと、複数のソースコントロール機能をWwiseから直接、利用できます。例えば、プラグインPerforceを使うと、以下のソースコントロール操作をWwiseから実行できます。
Get latest versionデポから最新バージョンを入手して、自分の作業コピーを更新。
Submit changesペンディング中のファイルを、処理するために、Perforceサーバに送信。
Check outデポファイルの作業用コピーをクライアントワークスペースに作成。
Lock他ののクライアントがサーバ上に、ファイルの作業用コピーをサブミットできないように、そのファイルをロック。
Unlock他のクライアントがサーバ上に、ファイルの作業用コピーをサブミットできるように、そのファイルをアンロック。
Mark for addファイルをデポに追加するために、ファイルをadd（追加）とマークする。ファイルがチェンジリストに追加されるので、デポにサブミットする必要がある。
Mark for deleteで、ファイルをデポから削除する。ファイルがチェンジリストに追加されるので、削除するためにデポにサブミットする必要がある。
MoveディレクトリOriginalsにあるフォルダ間でソースファイルを移動する。
Renameデポにあるファイル名の変更。
Revert changesクライアントワークスペースで行ったファイルへの変更を、取り消す。
Resolve1つのファイルの2つのバージョンの差分を調整。
Diffクライアントワークスペースにあるファイルを、デポにあるファイルと比較。
File Historyファイルの変更履歴を表示。
![[注釈]](/images/2023.1.4_8496/?source=Help&id=note.png) | 注釈 |
|---|---|
Subversionのプラグインにも、類似のソースコントロール機能があります。 |
複数のソースコントロールコマンドをWwiseからアクセスできるほか、Project Explorerに表示される特別なアイコンオーバーレイで、Work Unitファイルのステータスが簡単に確認できます。例として下表に、Perforce Source Controlプラグインで使用するアイコンオーバーレイを示します。
|
Overlay Icon |
Name |
内容 | ||
|---|---|---|---|---|
|
Normal (not checked out) |
ファイルは最新版であり、チェックアウトされていません。 | ||
|
Marked for add Moved |
ファイルがPerforceデポに追加されるようにマークされている、またはmove/addステータスで移動されました。 | ||
|
Checked out (Open for Edit) |
ファイルがPerforceのデポからチェックアウトされています。 | ||
|
Checked out by another user |
ファイルがチームの別のユーザによってチェックアウトされています。 | ||
|
Concurrently checked out |
ファイルが自分とチームの別のユーザによってチェックアウトされています。 | ||
|
Outdated (not latest revision of file) |
より新しいリビジョンがサーバ上に存在します。ファイルの最新版を取得することができます。 |
| 注釈 |
|---|---|
“Checked out by another user”、“Concurrently Checked out”、および“Outdated”のアイコンを提供しているのは、Perforce Source Controlプラグインのみです。 |
どちらのSource Controlプラグインを採用する場合でも、使用するPerforceまたはSubversionのバージョンがSource Controlプラグインと互換性があることを、以下の情報で確認してください。
Perforce: The Perforce Source Control plug-in was built using the Perforce SDK version 2022.1, but should work with most versions of the Perforce servers. ソースコントロールプラグインと互換性のないバージョンのPerforceを使用している場合はWwise SDKにあるソースを利用し、使用中のバージョンでプラグインをリビルドすることができます。Perforceプラグインについては、Wwise SDKドキュメンテーションを参照してください。
Subversion (deprecated): The Subversion Source Control plug-in has been deprecated since Wwise 2023.1 and will no longer be updated.
Subversion Source ControlプラグインはSubversionバージョン1.8.5を使用して構築されています。ソースコントロールプラグインと互換性のないバージョンのSubversionを使用している場合はWwise SDKにあるソースを利用し、使用中のバージョンでプラグインをリビルドすることができます。For more information about rebuilding the Subversion plug-in, see the Wwise SDK documentation.
Subversionのbinフォルダは、デフォルトでC:\Program Files\Subversion\binにあり、システムのPATH環境変数の中にある必要があります。通常はSubversionインストーラが、PATHに追加しますが、例えばSubversionを上記ZIPファイルからマニュアルインストールした場合は、binフォルダをマニュアルでPATHに追加する必要があります。
以下のセクションでソースコントロールプラグインを使用したアセット管理方法を説明します。主にPerforce Source Controlプラグインを対象としていますが、Subversionを使用する場合のワークフローもこれに似ています。
![[ヒント]](/images/2023.1.4_8496/?source=Help&id=tip.png) | ヒント |
|---|---|
Perforce、Subversion、その他のPlatform SDKアップデートは、弊社SDK Documentationのリリースノートに記載されます。 |
Perforce Source Controlプラグインを使いはじめる前に、あなたまたはシステム管理者が以下を行う必要があります。
ソース管理マネジメントソフトウェアのクライアントバージョンを各チームメンバーのワークステーションにインストールしてセットアップします。
クライアントワークスペースを各チームメンバーのワークステーションに設定します。
プロジェクトファイルの最新バージョンをデポから入手し、あなたのクライアントワークスペースに保存します。
Wwiseであなたのソースコントロールプラグインを選択して設定します。
Perforceのインストールや設定については、システム管理者に問い合わせるか、Perforceドキュメンテーションを参照してください。
Project SettingsダイアログでSource Controlプラグインを選択して設定することができます。詳しくは「Configuring source control plug-ins」を参照してください。
プロジェクトで作業を始める前に、プロジェクトのファイルやオーディオソースを、デポまたはレポジトリに追加します。Perforceにファイルを追加するには、以下の2つの手順を行います。
| 注釈 |
|---|---|
新しいWork Unitを作成したり、プロジェクトに新しいオーディオファイルをインポートしたりした場合は、これらの新ファイルをPerforceに追加するためにマークするよう、プロンプトが表示されます。 |
チェンジリストにファイルを追加するには:
メニューバーで、Project > File Managerをクリックする。
File Managerが開く。
以下のタブのいずれかに切り替える。
Work Unitsタブは、PerforceにWork Unitを追加する場合。
Sourcesタブは、Perforceにオーディオファイルを追加する場合。
Perforceに追加するファイル（単数または複数）を選択する。
選択したファイルを右クリックして、メニューで、Mark for addを選択する。
The Process Log dialog opens showing that the selected file has been added to the changelist or “opened for add” and is ready to be submitted to the depot.
OKをクリックして、Process Logを閉じる。
ファイルのステータスが“add”になる。
Closeをクリックして、File Managerを閉じる。
Project Explorerで、プロジェクトファイルに、オーバーレイアイコンMarked for add（追加用にマーク）が付く。
この時点ではまだ、チェンジリストにファイルを追加しただけである。デポに新しいファイルをチェックインするには、チェンジリストをサブミットする必要がある。ファイルのデポへのサブミットについては「Submitting your changes to the Perforce depot」を参照してください。
プロジェクトを保存する。
プロジェクトのファイルを編集する前に、ファイルをチェックアウトしてファイルの最新バージョンを確実に自分のクライアントワークスペースに入れます。Perforceでファイルをチェックアウトすると、そのファイルは書き込み可能となります。つまり、ファイルへの変更を保存できます。
Perforceのデフォルトのチェックアウトは排他的チェックアウトでないため、同じファイルを使ってチームの他のメンバーが同時に作業をしているかもしれません。マージコンフリクトが起きると解消に時間と労力を要する場合があるので、まめに連絡を取り合い、問題発生を避けてください。
ファイルをチェックアウトして編集するには:
メニューバーで、Project > File Managerをクリックする。
File Managerが開く。
以下のタブのいずれかに切り替える。
Work Unitsタブは、PerforceにWork Unitを追加する場合。
Sourcesタブは、Perforceにオーディオファイルを追加する場合。
開いて編集するファイル（単数または複数）を選択する。
選択したファイルの1つを右クリックして、メニューで、Check outを選択する。
The Process Log dialog opens showing that the file has been checked out or “opened for edit.”
OKをクリックして、Process Logを閉じる。
ファイルのステータスが“edit”になる。
Closeをクリックして、File Managerを閉じる。
Project Explorerで、プロジェクトファイルに、オーバーレイアイコンChecked out（チェックアウト中）が付く。
| 注釈 |
|---|---|
プロジェクト設定の Prompt for checkout on edit を有効にすると、チェックアウトしていないファイルを変更したときに、Pending Source Control Operationsダイアログが開きます。変更されたファイルをチェックアウトするには、 Check out modified files オプションを選択し、 OK をクリックします。Cancel を選択すると、ダイアログをトリガーさせた変更が、取り消されます。Check out modified files オプションの選択を外して OK をクリックすると、変更したまま続けることができますが、あとでプロジェクトを保存しようとするときにもう一度、ファイルのチェックアウトを促す表示が出ます。詳細は「Generalタブ」を参照。 |
ファイルで作業が終了した場合や、変更点をチームの他のメンバーがアクセスできるようにするには、そのファイルをデポにサブミットします。自分が加えた変更の詳細情報を一緒に提出し、自他ともにファイル変更の範囲を完全に理解することが非常に重要です。このコメント提出は、コンフリクトに対応する際にも役立ちます。
ファイルをサブミットしてPerforceのデポに戻すと、変更点がデポにあるファイルにマージされます。コンフリクトがある場合は、それを解消するまでそのファイルをデポにサブミットできません。
変更をデポにサブミットするには
メニューバーで、Project > File Managerをクリックする。
File Managerが開く。
Submit Changesボタンをクリックしてから、以下のいずれかのオプションをクリックする。
Work Units - Work Unitだけをチェックインするためにサーバに送る場合。
Sources - ソースファイルだけをチェックインするためにサーバに送る場合。
All - ペンディング中の全ファイル（Work Unitやソースファイル）を、チェックインするためにサーバに送る場合。
The Submit Changes dialog opens.
サーバにチェックインしたくないファイルがある場合は、それらのファイルを選択から外し、OKをクリックする。
選択したファイルの1つを右クリックして、メニューで、Submit Changesを選択する。
The Description dialog opens.
ファイルに加えた変更の詳細を入力する。
注釈 変更をサブミットする時に、Descriptionに日本語や中国語などの全角文字を使う場合は、P4システムの環境変数である
P4CHARSETをutf8に設定する。変更をサブミットした直後に引き続きファイル編集をしたい場合は、 Check out file(s) after submit（サブミット後にファイルをチェックアウトする）オプションを選択する。
OK をクリックします。
The Process Log dialog opens showing that the files have been checked in or “submitted.”
OKをクリックして、Process Logを閉じる。
ファイルのステータスが“normal”になる。
Closeをクリックして、File Managerを閉じる。
Check out file(s) after submitオプションを選択していない限り、Project Explorerで、プロジェクトファイルに、オーバーレイアイコンChecked in（チェックイン中）が付く。
個別ファイルをデポにサブミットするには:
メニューバーで、Project > File Managerをクリックする。
File Managerが開く。
以下のタブのいずれかに切り替える。
Work Unitsタブは、PerforceにWork Unitを追加する場合。
Sourcesタブは、Perforceにオーディオファイルを追加する場合。
サブミットするファイル（単数または複数）を選択する。
選択したファイルの1つを右クリックして、メニューで、Submit Changesを選択する。
The Description dialog opens.
ファイルに加えた変更の詳細を入力する。
注釈 変更をサブミットする時に、Descriptionに日本語や中国語などの全角文字を使う場合は、P4システムの環境変数である
P4CHARSETをutf8に設定する。変更をサブミットした直後に引き続きファイル編集をしたい場合は、 Check out file(s) after submit（サブミット後にファイルをチェックアウトする）オプションを選択する。
OK をクリックします。
The Process Log dialog opens showing that the files have been checked in or “submitted.”
OKをクリックして、Process Logを閉じる。
ファイルのステータスが“normal”になる。
Closeをクリックして、File Managerを閉じる。
Check out file(s) after submitオプションを選択していない限り、Project Explorerで、プロジェクトファイルに、オーバーレイアイコンChecked in（チェックイン中）が付きます。
ヒント Project ExplorerでWork Unitを右クリックしてSource Control > Submit Changesを選択することでPerforceディポに変更をサブミットすることもできます。
クライアントワークスペースにあるファイルを、デポにあるファイルの最新バージョンと比較（Diff）して、両者の差分を確認できます。Diff操作でファイルを比較する前に自分のプロジェクトを保存して、差分確認にファイルの最新バージョンが使われるようにします。
ファイルを、Perforceのデポにあるファイルと比較するには:
メニューバーで、Project > File Managerをクリックする。
File Managerが開く。
比較するWork Unitのファイルを右クリックして、メニューで、Diff を選択する。
両ファイルの差分がPerforceのデフォルトDiffビューアに表示される。
両ファイルの差分を確認する。
差分の確認後、Perforceを閉じてWwiseに戻る。
プロジェクトの、Originalsフォルダに入っているソースファイルを移動できますが、その前に他のチームメンバーがそれらのファイルを使用していないことを確認してください。他人がファイルをチェックアウト中にファイルを移動してしまうと、その人がファイル変更をデポにサブミットする時に問題が発生します。
Perforceでファイルを移動する場合、まず削除するために現在のファイルが開かれ、移動先にファイルの正確なコピーが作成されます。これらのファイルはデポで自動的に更新されないので、移動を完了してから、チェンジリストをデポにサブミットする必要があります。ファイルを移動する前に、ファイルをデポにチェックインする必要があります。
| 注釈 |
|---|---|
Originalsフォルダにあるソースファイルを移動する前に、プロジェクトを保存する必要があります。 |
ディレクトリOriginalsのフォルダ間で、ファイルを移動するには:
現在のプロジェクトを保存する。
以下のいずれかを行う:
メニューバーで、Project > File Managerをクリックする。
[Shift]+[F1]を押す。
File Managerが開く。
Source Filesタブに切り替える。
移動するファイル（単数または複数）を選択する。
選択したファイルを右クリックして、メニューで、Moveを選択する。
The Browse For Folder dialog opens.
フォルダ層を移動して、ファイルの移動先となるフォルダを選択する。
注釈 新規フォルダを作成する場合は、親フォルダを選択して、Make New Folderボタンをクリックして、フォルダ名を指定します。
OKをクリックして、ファイルを新規フォルダに移動する。
The Process Log dialog opens showing that a new copy of the file has been added to the specified folder using the branch command and the original file has been opened for delete.
Click OK to close the Process Log dialog.
リストから、ブランチと削除の両エントリを選択する。
選択したエントリを右クリックして、メニューで、Submit Changesを選択する。
The Description dialog opens.
内容を分かりやすく入力して、OKをクリックする。
Process Logが開き、ペンディング中の両操作がデポにサブミットされたことが表示される。
OKをクリックして、Process Logを閉じる。
これで、ファイルは指定したフォルダに属す。
プロジェクトのファイル名を変更できますが、その前に他のチームメンバーがそのファイルを使用していないことを確認してください。他人がファイルをチェックアウト中にファイル名を変更してしまうと、その人がファイル変更をデポにサブミットする時に問題が発生します。
Perforceでファイル名を変更する場合、まず削除するために現在のファイルが開かれた後、ファイルの正確なコピーが作成され、新しいファイル名が付けられます。これらのファイルはデポで自動的に更新されないので、ファイル名変更を完了してから、チェンジリストをデポにサブミットする必要があります。ファイル名を変更する前に、ファイルをデポにチェックインする必要があります。
![[注意]](/images/2023.1.4_8496/?source=Help&id=caution.png) | 注意 |
|---|---|
Default Work Unitは重要なプロジェクトファイルなので、名前を変更してはいけません。 |
プロジェクトファイルの名前を変更するには:
メニューバーで、Project > File Managerをクリックする。
File Managerが開く。
変更するWork Unitファイル名を右クリックして、メニューで、Renameを選択する。
The Rename File dialog opens.
Nameフィールドに新しいファイル名を入力する。
OK をクリックします。
The Process Log dialog opens showing that a copy of the file was created with the new name using the branch command and the old file was opened for delete.
OKをクリックして、Process Logを閉じる。
旧ファイルのステータスが“delete”になり、ステータスが“branch”である新ファイルが作成される。
新旧の両ファイルを選択する。
右クリックして、メニューで、Submit Changesを選択する。
The Description dialog opens.
変更の内容を分かりやすく入力して、OKをクリックする。
Process Logが開き、元ファイルが削除され新ファイル名のファイルが追加されたことが表示される。
OKをクリックして、Process Logを閉じる。
Closeをクリックして、File Managerを閉じる。
The Project dialog opens prompting you to reload the latest version of the project because changes have been made externally to the project.
Yesをクリックする。
プロジェクトの最新バージョンがロードされ、ファイル名が変更されている。
プロジェクトで不要となったファイルは、削除できます。Perforceでファイルを削除する場合、まず削除するファイルを開き、次にチェンジリストをデポにサブミットします。ファイルを削除する前に必ずプロジェクトを保存して、前回の保存以降に加えた変更の紛失を防止してください。
| 注意 |
|---|---|
Default Work Unitは重要なプロジェクトファイルなので、削除をしてはいけません。 |
プロジェクトからファイルを削除するには:
メニューバーで、Project > File Managerをクリックする。
File Managerが開く。
削除するファイル（単数または複数）を選択する。
選択したプロジェクトファイルの1つを右クリックして、メニューで、Mark for Delete を選択する。
ファイル削除の確認メッセージが表示される。
Yesをクリックする。
The Process Log dialog opens showing that the file(s) has been opened for delete.
OKをクリックして、Process Logを閉じる。
ファイルのステータスが“delete”になる。
Closeをクリックして、File Managerを閉じる。
The Project dialog opens prompting you to reload the latest version of the project since changes have been made externally to the project.
Yesをクリックする。
プロジェクトの最新バージョンがロードされ、ファイルが削除されている。
この時点ではまだ、チェンジリストにファイルを追加して削除するためにマークしただけである。デポからファイルを削除するには、チェンジリストをサブミットする必要がある。
変更したファイルが全てチェックアウトされていれば、問題なくプロジェクトを保存できます。ところが、チェックアウトしていないファイルに変更を加えた場合は、プロジェクトを保存する前に、これらのファイルをチェックアウトするようにWwiseが促します。
プロジェクトを保存するには:
以下のいずれかを行う:
メニューバーで、Project > Saveをクリックする。
Ctrl+Sを押す。
Wwiseが、プロジェクトの全ファイルを保存しようとします。チェックアウトしていないファイルに変更を加えた場合は、Pending Source Control Operationsダイアログが開きます。
注釈 プロジェクト設定の Prompt for checkout on edit を有効にしてあれば、チェックアウトしていないファイルを変更するとすぐに、Pending Source Control Operationsダイアログも開きます。詳細は 「Generalタブ」 を参照してください。
Check out modified filesオプションを選択して、変更したファイルをチェックアウトして、Wwiseが保存できるようにする。
OK をクリックします。
必要なファイルをWwiseがチェックアウトして、プロジェクトを保存する。