サポート |
Perforce フレームワークさまざまなアプリやフックで使用される一般的な Perforce 機能 |
概要
このフレームワークは、Perforce に統合する他のアプリやフックで使用できる一般的な Perforce アクションとユーティリティ機能を提供します。また、ゲームの設定がこの統合に対して使用するアプリ フックの既定のセットも含まれています。
実験的なフレームワーク
このフレームワークの最新リリースは v0.1.15 で、インタフェースがまだ試験運用の段階であることを意味します。更新によって下位互換性が失われることがないように努めていますが、バージョン番号がゼロから始まる場合にはこの問題が発生する可能性があります。フレームワークのバージョンが 1.0 に達すると、メジャー バージョンの番号が変わってもバージョン間のインタフェースは保持されます。これらの規約の詳細については、セマンティック バージョニング基準のガイドラインを参照してください。
概要ビデオ
次のビデオでは、特長と機能の概要について説明します。
ドキュメント
現在このフレームワークのマニュアルを作成中ですが、Perforce を Shotgun Pipeline Toolkit に統合した方法についての概要については、こちらのページを参照してください。
 |
> Toolkit の Perforce 統合の概要 |
フレームワークに含まれているもの
単に Perforce API をラップするのではなく、Perforce フレームワークには P4Python が含まれ、ダイアログを介して接続を開く、最新バージョンをチェックするなどの一般的な機能を提供する一連のユーティリティ機能のセットが組み込まれています。Perforce コマンドへのより直接的なアクセスのために、接続された P4Python インスタンスをいつでも取得できます。
P4Python
Toolkit Perforce の統合では、Perforce によって提供される標準の P4Python モジュールが使用されます。このフレームワークには、Toolkit で使用するさまざまなオペレーティング システムとアプリケーションに対応した P4Python のバージョンが含まれています。ただし、必要なバージョンが含まれていない場合は、Python パスからロードしようとします。
リファレンス
(準備中)
インストールと更新
最新バージョンに更新する
この項目が既にプロジェクトにインストールされている場合に最新バージョンを取得するには、update コマンドを実行します。特定のプロジェクトに含まれている tank コマンドに移動し、そこでこのコマンドを実行します。
> cd /my_tank_configs/project_xyz > ./tank updates
または、tank コマンドを実行し、プロジェクトの名前を指定して、更新チェックを実行するプロジェクトを指定します。
> tank Project XYZ updates
コラボレーションと発展
 |
Shotgun Pipeline Toolkit にアクセスできる場合は、すべてのアプリ、エンジン、およびフレームワークのソース コードにも Github からアクセスできます。これらは Github を使用して格納および管理しています。これらの項目は自由に発展させてください。さらなる独立した開発用の基盤として使用したり、変更を加えたり(その際はプル リクエストを送信してください)、 いろいろと研究してビルドの方法やツールキットの動作を確認してください。このコード リポジトリには https://github.com/shotgunsoftware/tk-framework-perforce からアクセスできます。 |
特殊な要件
- 上記の操作を行うには、Shotgun Pipeline Toolkit Core API バージョン v0.14.61 以降が必要です。
環境設定
以下に、使用するすべての環境設定の概要を示します。これらの設定は、このアプリまたはエンジンを有効にするための環境設定ファイルで定義する必要があります。
hook_get_perforce_user
タイプ: hook
既定値: get_perforce_user
説明: 指定した Shotgun ユーザ名の Perforce ユーザ名を返すフックを指定します
hook_store_publish_data
タイプ: hook
既定値: store_publish_data
説明:
host
タイプ: str
説明: Perforce に接続するときに偽装するホスト コンピュータの名前。通常は空のままにします。
server
タイプ: str
説明: 接続先の Perforce サーバ。'protocol:server:port' という形式にする必要があります。例: 'tcp:perforce:1666'
hook_get_shotgun_user
タイプ: hook
既定値: get_shotgun_user
説明: 指定した Perforce ユーザ名の Shotgun ユーザ名を返すフックを指定します
hook_store_review_data
タイプ: hook
既定値: store_review_data
説明:
server_aliases
タイプ: list
説明: Perforce サーバのエイリアスのリスト - Perforce サーバが移動した場合、または新しいプロトコル、名前、またはポートが与えられた場合、このリストにオリジナルを追加すると、Toolkit は古いサーバ用に公開されたパブリッシュを引き続き使用できます。現在のサーバは常に 'server' 設定で指定する必要があります。
hook_load_publish_data
タイプ: hook
既定値: load_publish_data
説明:
hook_load_review_data
タイプ: hook
既定値: load_review_data
説明: