Version: 2020.1
言語: 日本語
Plastic SCM の統合
外部バージョン管理システムの使用

Plastic SCM plugin for Unity (ベータ版)

Plastic SCM は、チームが Unity プロジェクトで共同作業するためのバージョン管理機能を提供します。

Plastic SCM plugin for Unity (ベータ版) は、Unity エディター内でソース管理機能を提供します。Unity エディターの Plastic SCM ウィンドウには、ローカルプロジェクトの新規ファイルや変更されたファイルの一覧が表示されます。ここから、これらのファイルを Plastic SCM にチェックインすることができます。

Unity で更新したファイルは、自動的にチェックアウトされます。これにより、再びチェックインするまで、他のユーザーがファイルを更新することができなくなります。

Plastic SCM plugin for Unity (ベータ版) は、macOS と Windows の Unity 2018.4 LTS 以降に対応しています。ノート: このプラグインは、Windows の Unity 2020.1 以降には現在対応していません。Unity はプラグインの将来のバージョンでこれらのバージョンのサポートを追加する予定です。

Plastic SCM の使い始めにあたって

Plastic SCM plugin for Unity のインストール

Plastic SCM plugin for Unity プラグインは、Asset Store で提供されています。 Plastic SCMプラグインをインストールするには、以下の手順を行います。

  1. Assets > Import Package > Custom Package… を選択します。
  2. PlasticSCMForUnity パッケージを選択します。
  3. Import Unity Package ウィンドウで以下を行います。
    1. All を選択します。
    2. Import を選択します。

これで、プロジェクトで Plastic SCM プラグインが有効になりました。Unity エディターで Plastic SCM ウィンドウにアクセスするには、Window > Plastic SCM を選択します。

新しいワークスペースの作成

Unity プロジェクトで Plastic SCM プラグインを使用するには、Plastic SCM ウィンドウか Plastic SCM GUI でプロジェクト用のワークスペースを作成する必要があります。

Unity エディターでプロジェクトの新しいワークスペースを作成するには、以下を行います。 1. Window > Plastic SCM を選択します。 2. リポジトリ名、ワークスペース名、プロジェクトのパスを指定します。デフォルトでは、既存のプロジェクトのパスと名前が使用されます。 3. Plastic SCM を開発者として使うか (Plastic SCM の全機能)、アーティスト (簡略化されたワークフロー用) として使うかを選択します。

ワークスペースを作成すると、 **Plastic SCM ** ウィンドウにプロジェクトファイルが表示されます。さらに、Plastic SCM は、ワークスペース、つまりプロジェクトフォルダーに ignore ファイル を自動的に作成します。

プロジェクトファイルをソース制御へコミット

プロジェクトを Plastic SCM ワークスペースに接続すると、Plastic SCM ウィンドウの Pending Changes タブに、既存のプロジェクトファイルがすべて Added and private として表示されます。これらのファイルをワークスペースに加えるには、チェックイン する必要があります。

ファイルをチェックインすると、 Pending changes タブが更新され、チェックインしたファイルの一覧が表示されなくなります。さらに、Plastic SCM GUI が以下を表示します。

  • プロジェクトファイルをワークスペースエクスプローラーに表示
  • 最新のチェックインをチェンジセットビューで表示

Plastic SCM プラグインの使用

Plastic SCM プラグインにより、Unity エディターで Plastic SCM ウィンドウを使用できます。 Plastic SCM ウィンドウを使って、以下のようなファイルの変更を管理します。

  • プロジェクトをソース管理に接続
  • ファイルのチェックイン
  • 変更を元に戻す
  • ファイルリビジョンの比較

Plastic SCM ウインドウには、プロジェクト内の新規および変更されたファイルの一覧が表示されます。新しいファイルを加えたり、既存のファイルに変更を加えたりすると、影響を受けるファイルが Plastic SCM ウインドウに自動的に表示されます。

Plastic SCM ウィンドウを開くには、Window > Plastic SCM を選択します。

ファイルのチェックイン

ファイルをチェックインするには以下を行います。

  1. Window > Plastic SCM を選択します。
  2. Plastic SCM ウィンドウで、チェックインしたいファイルを選択します。
  3. テキストフィールドに、変更内容を説明するコメントを入力します。
  4. Checkin を選択します。

変更内容は、Plastic SCM GUI の Changesets ビューに表示されます。

ファイルを無視

Plastic SCM プラグインを使ってワークスペースを作成すると、ワークスペース内に ignore ファイルが自動的に作成されます。このファイルには、ソース管理から除外するファイルタイプとパスのデフォルトリストが含まれています。 共有リポジトリから除外したいファイルがプロジェクト内にある場合は、ignore ファイルに追加します。

  1. Plastic SCM ウィンドウで、無視したいファイルを右クリックします。
  2. Add to ignored list を選択します。
  3. ファイル名を選択します。

無視 (除外) することを選択したファイルは、Pending changes リストから削除されます。 特定のファイル名、フォルダー全体、特定の拡張子を持つすべてのファイルを除外することができます。

詳細は ignore files を参照してください。

ファイルの変更点の表示

更新されたファイルを以前のバージョンと比較するには、Plastic SCM ウィンドウでファイルを右クリックして、Diff を選択します。これにより、Differences ビューが開き、リポジトリのソースとローカルコピーが比較されます。これはテキストのみの表示です。

ファイルの変更を元に戻す

プロジェクトで行った変更を残しておきたくない場合、前のバージョン、つまり直近のチェックインのバージョンに戻すことができます。ファイルの変更を元に戻すには、Pending changes タブでファイルを選択し Undo changes を選択します。

Plastic SCM への移行

Plastic SCM には、Collaborate から Plastic SCM にプロジェクトを移行するための移行ウィザードが用意されています。プロジェクトを Plastic SCM に移行するには、以下を行います。

  1. 移行ウィザード に移動します。
  2. Unity ID のログイン情報を入力します。
    1. Log in を選択します。
  3. Plastic SCM の組織を作ります。
    1. 地域のドロップダウンで地域を選択します。
    2. Next を選択します。
  4. 移行するプロジェクトを選択します。
    1. Next を選択します。
  5. Plastic SCM に参加するチームメンバーを組織から選択します。
    1. Next を選択します。
  6. Confirm を選択します。

移行ウィザードの手順を完了すると、Plastic SCM は Collaborate から Plastic SCM にプロジェクトを移行します。また、Plastic SCM は、招待されたチームメンバーに Plastic SCM を開始するための招待メールを送信します。

Plastic SCM ウィンドウ

Unity エディターの Plastic SCM ウィンドウを使用して、プロジェクトのバージョン管理を行います。プロジェクトがまだ Plastic SCM に接続されていない場合、Plastic SCM ウィンドウに新しいワークスペースを作成するためのビューが表示されます。 以下の表で、このビューのフィールドについて説明します。

フィールド 説明
Repository name リポジトリの名前。デフォルトでは、プロジェクト名です。
Workspace name ワークスペースの名前。デフォルトでは、プロジェクト名です。
Path on disk プロジェクトのパスです。デフォルトでは、開いているプロジェクトの保存場所です。
Developer ラジオボタン このオプションを選択すると、ブランチのマージ、プッシュ、プルを含む Plastic SCM の全機能が利用できます。
Artist ラジオボタン このオプションを選択すると、マージや複数ブランチを使用せずにファイルのチェックインを行うシンプルなワークフローを行えます。
Create workspace ボタン 入力した内容で、プロジェクトのワークスペースを作成します。

以下の表は、Unity エディター の Plastic SCM ウィンドウについて説明します。

フィールド 説明
Branch 現在作業しているワークスペースのブランチを表示します。
Pending changes タブ プロジェクトで変更されたファイルの一覧を表示します。
Incoming changes タブ ローカルバージョンのプロジェクトにまだ含まれていない外部の変更点をワークスペースに表示します。
Launch branch explorer (Developer モードのみ) クリックすると、ブランチエクスプローラーが開きます。
Launch Plastic (Developer モードのみ) クリックすると Plastic SCM が開きます。
Configure Gluon (Artist モードのみ) クリックすると Plastic Gluon が設定モードで開きます。
Launch Gluon (Artist モードのみ) クリックすると Plastic Gluon が開きます。

Pending changes タブ

Pending changes タブには、プロジェクトのローカルバージョンにある新規および変更されたファイルが表示されます。このタブを使用して、ファイルを Plastic ワークスペースにチェックインしたり、バージョンコントロールからファイルを除外したり、変更されたファイルを以前チェックインしたバージョンと比較したりします。

フィールド 説明
Checkin changes 選択したファイルをワークスペースにコミットします。変更内容をチェックインする前に、テキストボックスにコメントを入力する必要があります。
Undo changes 選択したファイルに加えられたローカルの変更を元に戻します。
Keep items locked (Artist モードのみ) チェックイン操作の後、アイテムをロックしたままにします。この機能は、ファイルに複数の変更を加えても、個別の変更として別々にチェックインしたい場合などに便利です。アイテムのロックを解除するには、このボタンの選択を解除します。
Options クリックすると Options ウィンドウが開きます。
Item ファイルの名前とパスです。ファイルは、変更の種類によってグループ化されています。例えば以下の通りです。
Changed
Deleted
Added
Status ファイルの状態を表します。例えば以下の通りです。
Changed
Removed locally
Private
Size ファイルのサイズです。
Extension ファイルの拡張子です。
Type ファイルタイプです。
Date modified 変更した日時。
Repository 変更が行われたリポジトリを表します。つまり、ローカルリポジトリや、他のユーザーが変更を行った場合はリモートリポジトリなどです。

Pending changes ビューについて詳しくは、こちらを参照してください。

Incoming changes タブ

Incoming changes タブでは、ローカルバージョンのプロジェクトにまだ含まれていない外部の変更点をワークスペースに表示します。 このタブを使用して、リモートワークスペースから最新の変更を取得します。

フィールド 説明
Update workspace ワークスペースの外部の変更に合わせて、プロジェクトを更新します。
Path ファイルのパスと名前です。
Last edited by (Artist モードのみ) 変更をチェックインしたユーザー。
Size ファイルのサイズです。
Date modified (Artist モードのみ) ファイルの直近のチェックインの日付。
Author (Developer モードのみ) 変更をチェックインしたユーザー。
Details (Developer モードのみ) 更新操作が、関連する変更をどのように行うかを説明します。
Resolution method (Developer モードのみ) ディレクトリ競合を解決する際に、ユーザーが選択した解決方法を表示します。

Incoming Changes 機能について詳しくは、こちらを参照してください。

Options ウィンドウ

Options ウィンドウを使用して、Plastic SCM ウィンドウの動作を制御します。 以下の表では、Plastic SCM ウィンドウのオプションについて説明します。

フィールド 説明
What to find タブ
Show checkouts 以下のファイルが表示されます:
Plastic で明示的にチェックアウトしたもの
移動したもの
マージが進行中のもの
Find changed files in the workspace ワークスペースのディレクトリ構造をチェックして、変更されたファイルをタイムスタンプを利用して特定します。
Check the content to determine files as changed, not just timestamp 更新されたタイムスタンプによってファイルのハッシュを計算し、ファイルの内容が実際に変更されたことを確認します。
What to show タブ
Auto-refresh Plastic は必要に応じて Pending Changes (保留中の変更) リストを自動的に更新するため、手動で更新する必要がありません。
Show private files 新規ファイルやツールで生成されたコンテンツなど、ソース管理にコミットされていないファイルを表示します。
Show ignored files ignore リストに加えたファイルを表示します。
Show hidden files hidden リストに加えたファイルを表示します。
Show deleted files and directories Plastic 管理外のワークスペースで手動で削除したファイルを表示します。
Move detection タブ
Find moved and renamed files and directories ファイル名の変更や移動の可能性があるかどうかをワークスペースで検索します。例えば、あるファイルが削除され、別のファイルが加えられた、など。
Match binary files only when they have the same extension バイナリファイルのファイル照合を、同じ拡張子のファイルに限定します。
Match text files only when they have the same extension テキストファイルのファイル照合を、同じ拡張子のファイルに限定します。
Similarity percentage ファイルの移動や名前変更と見なすために、ファイルがどの程度類似する必要があるかを定義します。
テキストファイルの場合、このパーセンテージはコンテンツに関係します。
バイナリファイルの場合、このパーセンテージはファイルサイズに関係します。
ディレクトリ構造の場合、これはディレクトリエントリーの合計数に対する子のパーセンテージに関係します。

Options ウィンドウについて詳しくはこちらを参照してください。

Plastic SCM の統合
外部バージョン管理システムの使用