Flame

Shotgun Engine for Flame

Flame への Shotgun の統合


作成: Shotgun Software
最新バージョン: v1.10.0 (製品)
バージョン番号は、セマンティック バージョニング基準に従っています。
システム名:: tk-flame

概要

このドキュメントは、Toolkit の設定を管理するユーザのみが使用可能な機能について説明します。 詳細については、『Shotgun 統合管理者ガイド』を参照してください。 Shotgun Engine for Flame は Flame 2015 Extension 2 で利用できるさまざまな統合フック間の橋渡しを行い、Toolkit Flame アプリケーションを実行するためのホストとして動作します。

サポート対象のアプリケーション バージョン

この項目はテスト済みです。アプリケーション バージョン 2016+ で動作することが分かっています。 最新のリリースでの動作は十分可能ですが、正式なテストはまだ完了していません。

ドキュメント

詳細な技術的ウォークスルー

Flame 統合をインストールおよび開始するのに最適な方法は、まず「技術的ウォークスルー」のビデオを参照することです。 以下のプレイリストにはいくつかのビデオが含まれており、Shotgun Desktop のインストール方法、プロジェクトのセットアップ方法、Flame 統合の実行方法について順を追って説明しています。

最後のセクションでは、設定およびフックの技術的な詳細について説明します。 すべてのビデオを視聴すると、Flame 統合の仕組みおよび残りのパイプラインに接続する方法を適切に理解できるはずです。

インストール

Shotgun Engine for Flame は、Flame 2015 Extension 2 に追加されている新しい統合フックを使用します。 エンジンを機能させるためには、このバージョンの Flame を使用する必要があります。 Flame 2015 Extension 2 (取得方法を含む)の詳細については、「Flame サポート」を参照してください。

Shotgun Engine for Flame を開始するには、パイプライン設定例を使用して新しいテスト プロジェクトをセットアップするのが最も簡単な方法です。 このためには、Shotgun Desktop を起動して、新しいプロジェクトのプロジェクト セットアップを実行し、(既定の設定セクションで)既定の Flame 統合を選択します。

Flame プロジェクトのセットアップ

Shotgun Engine for Flame は Shotgun プロジェクトと Flame プロジェクトを関連付け、必要に応じて作成します。 Flame データが Shotgun の適切なデータと関連付けられるため、これが統合の鍵となります。 追加機能として、エンジンには Flame プロジェクトの命名規則およびプロジェクトの他のさまざまな設定を管理するための機能が用意されています。

Flame を Shotgun から初めて起動すると、Flame プロジェクト作成 UI が表示されるため、アーティストは標準的な Flame プロジェクト作成画面から通常の設定を編集できます。

ただし、Shotgun 統合を使用すると、設定にはパイプラインに最適な値があらかじめ入力されるため、アーティストは設定のことを考えなくてもすぐに使用することができます。 既定値は project_setup_hook を介してカスタマイズできます。次のオプションをサポートしています。

use_project_settings_ui: True に設定すると、プロジェクト作成 UI が表示されます。 False の場合、Flame プロジェクトはフック内の他の既定値に基づいて自動的に作成されます。

get_server_hostname: 既定では「localhost」に設定されますが、必要に応じて上書きできます。

get_project_name: 既定では Shotgun プロジェクトと同じ値に設定されますが、必要に応じて上書きできます。

get_volume: 既定では最初に利用可能なストレージに設定されますが、必要に応じて上書きできます。

get_workspace: 既定では、Flame は標準的なワークスペース作成ロジックに従って既定のワークスペースを作成しますが、必要に応じて上書きできます。

get_user: Flame マシンにログインしたユーザと Shotgun のユーザの関連付けを試行します。

get_project_settings: Flame のメイン設定を指定し、フックで Flame プロジェクト XML ストリームを構築する場所です。 次のパラメータを指定する必要があります。

  • FrameWidth (例: 1280)
  • FrameHeight (例: 1080)
  • FrameDepth (16-bit fp12-bit12-bit u10-bit8-bit)
  • FieldDominance (PROGRESSIVEFIELD_1FIELD_2)
  • AspectRatio (4:316:9、または文字列として浮動小数点値)

プロキシ設定を指定することもできます。 詳細については、Autodesk Wiretap SDK のマニュアルを参照してください。

project_setup フックのコードベース全体を確認するには、該当のエンジン向けの Github リポジトリを参照してください。

インストールと更新

Shotgun Pipeline Toolkit にこのエンジンを追加する

Project XYZ にこのエンジンを追加するには、asset という名前の環境で次のコマンドを実行します。

> tank Project XYZ install_engine asset tk-flame

最新バージョンに更新する

この項目が既にプロジェクトにインストールされている場合に最新バージョンを取得するには、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-flame からアクセスできます。

特殊な要件

  • 上記の操作を行うには、Shotgun Pipeline Toolkit Core API バージョン v0.14.76 以降が必要です。

環境設定

以下に、使用するすべての環境設定の概要を示します。 これらの設定は、このアプリケーションまたはエンジンを有効にするための環境設定ファイルで定義する必要があります。

run_at_startup

タイプ: list

説明: 起動時に実行するアプリケーションを制御します。 これはリストで、各要素は「app_instance」と「name」という 2 つのキーを持つディクショナリになります。 app_instance 値は、環境設定ファイルで定義された特定のアプリケーション インスタンスにこのエントリを接続します。 name は Flame の起動時に実行するコマンドのメニュー名です。 name が「"」の場合は、特定のアプリケーション インスタンスのすべてのコマンドが開始されます。

context_menu

タイプ: list

説明: Flame のコンテキスト メニューに表示されるコマンドを制御します。 これはリストで、各要素は「app_instance」、「name」、「display_name」という 3 つのキーを持つディクショナリになります。 app_instance 値は、環境設定ファイルで定義された特定のアプリケーション インスタンスにこのエントリを接続します。 name 値はエンジンに登録されたコマンド名です。 display_name 値は、Flame がメニューで表示する名前です。 name が「"」の場合は、特定のアプリケーション インスタンスのすべてのコマンドが開始されます。 display_name が指定されていない場合は、代わりに name が使用されます。

backburner_servers

タイプ: str

説明: Backburner ジョブの送信時に使用するサーバのカンマ区切りリストです (グループを使用している場合は無視)。

flame_batch_publish_type

タイプ: tank_type

既定値: Flame Batch File

説明: パブリッシュ タイプは Flame バッチ スクリプトに関連付けられています。 このパラメータを使用すると、Flame 起動プロセスが起動時に Shotgun からバッチ スクリプトを自動的にロードします。

backburner_server_group

タイプ: str

説明: Backburner ジョブの送信時に使用するサーバのグループ名です。

backburner_shared_tmp

タイプ: str

既定値: /tmp

説明: Flame エンジンが一時ファイルを格納するフォルダです。 このフォルダはすべての Backburner ノードからアクセスできる必要があるため、大規模な Backburner セットアップを実行している場合は、このパスに何らかの共有ネットワークの場所を指定する必要があります。

project_startup_hook

タイプ: hook

既定値: {self}/project_startup.py

説明: Flame プロジェクトの起動時に使用するワークスペースおよびユーザを決定および作成するロジックが含まれています。

debug_logging

タイプ: bool

説明: デバッグ メッセージをロガーに送信するかどうかを制御します。

use_builtin_plugin

タイプ: bool

説明: Flame の起動を準備して組み込みの Toolkit プラグインを使用するかどうかを選択します。 false の場合、Flame が起動されると従来の Toolkit の統合が初期化されます。

backburner_manager

タイプ: str

説明: Backburner マネージャが配置されているホストです。 Flame エンジンで生成されたすべての Backburner ジョブはこのサーバにディスパッチされます。 この設定は Flame 2016.1 以降のみでサポートされています。 この値が指定されていない場合は、システムの既定値が使用されます。

project_switching

タイプ: bool

説明: プロジェクト切り替えの可能性に関するヒントです。

フォローする

0 コメント

ログインしてコメントを残してください。