Publish Shotgun にファイルをパブリッシュするための UI と機能を提供します。 最新バージョン: v0.10.10 (製品) バージョン番号は、セマンティック バージョニング基準に従っています。 システム名: tk-multi-publish

ドキュメント

このドキュメントは、Toolkit の設定を管理するユーザのみが使用可能な機能について説明します。詳細については、『Shotgun 統合ユーザ ガイド』を参照してください。

メイン インタフェースは 3 つの主なセクションに分かれています。

• 一次出力:パブリッシュする項目は出力タイプごとに分類されます。一次出力は目立つように UI の最上部に表示されます。一次出力でパブリッシュする項目は必ず 1 つのみで、通常はシーン ファイル本体です。

• 二次出力:二次出力はオプションで、必要に応じていくつでも追加できます。必要に応じて、シーンの項目(Maya のメッシュなど)を複数の二次出力と関連付けることもできます(たとえば、OBJ 書き出しと Alembic キャッシュ書き出し)。

• パブリッシュの詳細:パブリッシュする項目の選択とは別に、インタフェースを使用して、アーティストは Shotgun タスクを選択し(現在の作業領域でこれをまだ指定していない場合)、サムネイルを取得して、コメントを追加することもできます。

アプリを使用すると、アーティストのワークフローは一般的に次のようになります。

1. アプリを起動し、パブリッシュする項目を選択して、Shotgun タスクを選択します。サムネイルを設定し、コメントを入力したら「Publish」をクリックします。
2. アプリは、選択した項目でパブリッシュ前検証を実行します。
   
3. 問題がある場合は、続行するかどうかが確認されます。続行しない場合は、停止して問題が表示されるため、続行前に問題を修正できます。
4. 問題がない場合、または問題を無視するよう指示した場合は、選択したすべての項目が一次項目から順にパブリッシュされます。
5. 一次項目が正常にパブリッシュされる限り、アプリはパブリッシュ後の手順を実行して終了します。通常、これは現在のシーンのバージョンアップとクリーンアップのために使用されます。
6. 最後に、パブリッシュ プロセスで報告された問題と一緒に成功または失敗が表示されます。

Multi Publish をカスタマイズする

Multi Publish は幅広く設定できるように設計されており、すべてのキー ステップが一連のフックとして実装されています。アプリからエンジン固有のすべての呼び出しを分離するだけでなく、新しいエンジン用に簡単に設定できるようにすることで、このフックでパブリッシュ プロセスを完全に制御します。

次に、パブリッシュ ワークフローを一緒に構成するメイン フックを示します。

• hook_scan_scene は、パブリッシュする項目の現在のシーンをスキャンします。一次項目といくつかの二次項目の組み合わせが返されます。
• hook_primary_pre_publish では、一般的に一次項目をパブリッシュできることを検証します。パブリッシュを停止するほどではない、致命的でない問題のリストを返すことが可能です。
• hook_secondary_pre_publish では、すべての二次項目を検証します。続行前に修正できる問題のリストを返すことが可能です。
• hook_primary_publish は一次出力の一次項目をパブリッシュします。通常、これは現在のシーン ファイルをパブリッシュ領域にコピーし、Shotgun に登録します。フル パスをパブリッシュされたファイルに返し、そのパスは続いて依存関係として二次パブリッシュ フックに渡されます。このフック内で例外が発生すると、パブリッシュが停止し、ユーザに通知されます。
• hook_secondary_publish は二次出力の二次項目をパブリッシュします。通常、これはパブリッシュ ファイルを書き出しまたはコピーし、Shotgun に登録します。
• hook_post_publish はパブリッシュ ワークフローの最終フックであるため、パブリッシュの最後でクリーンアップを実行できます。既定のフックでは、ここでシーンがバージョンアップされます。このフックは、一次パブリッシュが例外なく成功した場合にのみ実行されます。

次の追加フックを使用すると、アプリの動作をカスタマイズできます。

• hook_thumbnail を使用すると、スクリーン キャプチャが意味のない場合にパブリッシュのサムネイルを提供できます。ファイル パスがサムネイルに返されると、スクリーン キャプチャ機能が無効になります。
• hook_copy_file を使用すると、アプリでファイルをディスクベースでコピーできます。既定のフックは、このフックを呼び出すアプリのユーティリティ メソッドを使用します。このためには、フック内から self.parent.copy_file(...) を呼び出します。

出力と項目

設定で定義した出力とシーン間のフックによって返される項目との関係を理解することは重要です。

各出力には、設定で定義された任意の文字列である scene_item_type プロパティがあります。

primary_scene_item_type は一意である必要があります。scene_item_type は、複数の二次出力で同じものを共有することができます。たとえば、「OBJ」と「Alembic キャッシュ」の 2 つの二次出力に同じ scene_item_type geometry が指定されている場合は、このシーンのすべてのジオメトリ項目で OBJ と Alembic キャッシュ ファイルの両方をパブリッシュする必要があることを示します。

シーン間のフックによって返される各項目には、設定で定義したいずれかの出力の scene_item_type に一致する必要のある type が指定されています。

アプリは、出力の scene_item_type と項目の type 間のマッピングを使用し、出力のリストと項目のリストを組み合わせて最終リストを表示するため、ユーザはパブリッシュする各出力の項目を選択できます。

関連するアプリとドキュメント

Scene Snapshot Shotgun Snapshot は簡単な差分バックアップ機能であるため、他のユーザと共有しなくても、作業の差分をバージョン付けしたり、管理することができます。スナップショットの作成、説明やサムネイルの追加、後でいつでも復帰できるポイントの作成、および復元が可能です。これは、大きな変更を行う際に以前のバージョンのシーンをバックアップしておく必要がある場合に役立ちます。

Shotgun Workfiles このアプリケーションは、Shotgun Pipeline Toolkit でファイルを管理する場合の基礎部分を構成します。これにより、さまざまな Shotgun エンティティ間をすばやく移動し、作業をすばやく開始することが可能になります。アプリケーションがシーンの裏でパスを管理するため、パスを指定する必要はありません。このアプリケーションを使用すると、作業領域内の作業ファイルを管理し、他のユーザと作業を簡単に共有できます。

Write Node このアプリにはユーザからファイル システム パスを抽出する Nuke 用の書き込みノードのカスタム ギズモが含まれているため、特定の出力の命名に集中できます。残りの作業は Shotgun にお任せください。通常、このアプリは Publish アプリと組み合わせて使用します。Nuke 用のパブリッシュ アプリをインストールする場合は、これもインストールすることが多いでしょう。

Maya から Alembic をパブリッシュする このチュートリアルでは、Maya からジオメトリのグループをパブリッシュする場合に Alembic ファイルを書き出せるように Multi Publish を設定する方法について説明します。

Toolkit Pipeline のチュートリアル このドキュメントには、高度な方法で Toolkit を使用してシンプルなエンドツーエンドのパイプラインをセットアップする、テクニカル ディレクタ(TD)向けの段階的なチュートリアルを用意しています。このチュートリアルを終了した新しい Toolkit ユーザは、プラットフォームの基本的な要素と貴社固有のニーズに基づいたカスタマイズの方法を習得できます。また、すぐに使用できる Toolkit アプリと、アーティストのワークフローに合わせた利用方法についても紹介します。 このドキュメントは、Toolkit の設定を管理するユーザのみが使用可能な機能について説明します。詳細については、『Shotgun 統合ユーザ ガイド』を参照してください。

インストールと更新

Shotgun Pipeline Toolkit にこのアプリを追加する

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

> tank Project XYZ install_app asset tk-maya tk-multi-publish

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

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

特殊な要件

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

環境設定

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

hook_primary_publish

タイプ: hook

既定値: primary_publish

説明: 一次タスクを実際にパブリッシュするフックを指定します。このフックはパブリッシュする必要のある一次タスクに渡されます。このフックはパブリッシュ プロセス全体を管理し、Shotgun へのパブリッシュの登録を確定します。

hook_post_publish

タイプ: hook

既定値: post_publish

説明: パブリッシュ後の作業に使用するフックを指定します。通常、このフックはシーンを最新バージョンにバージョンアップします。

display_name

タイプ: str

既定値: Publish

説明: メニューおよびメイン パブリッシュ ダイアログで使用する名前を指定します。

primary_display_name

タイプ: str

既定値: Current Work File

説明: UI で一次出力に指定される名前です。

secondary_outputs

タイプ: list

説明: 説明がありません。

primary_scene_item_type

タイプ: str

既定値: work_file

説明: 一次出力でスキャン シーン フックから返される項目との一致に使用されるタイプです。

allow_taskless_publishes

タイプ: bool

既定値: True

説明: 何もタスクを指定していない場合にパブリッシュを許可します。パブリッシュは現在の作業領域のエンティティにリンクされるだけです。

hook_copy_file

タイプ: hook

既定値: copy_file

説明: 「source_path」から「target_path」にファイルをコピーするフックを指定します。このフックは「copy_file」ユーティリティ機能で使用され、フック内から self.parent.copy_file (source_path、target_path、タスク)を呼び出すことで他のフックからアクセスできます。

primary_publish_template

タイプ: template

説明: ファイル システム内でパブリッシュされた一次ファイルを特定するために使用されるテンプレートです。何も設定しない場合は、パブリッシュ フック内で定義する必要があります。

primary_tank_type

タイプ: tank_type

説明: パブリッシュされた一次ファイルを Shotgun に登録する場合に使用されるタイプです。何も設定しない場合は、パブリッシュ フック内で定義する必要があります。

template_work

タイプ: template

説明: ディスク上の作業ファイルを特定するテンプレートのリファレンスです。

hook_primary_pre_publish

タイプ: hook

既定値: primary_pre_publish

説明: 一次パブリッシュの前に実行されるフックを指定します。このフックを使用すると、パブリッシュ準備完了の確認のために渡される一次タスクの検証を実行できます。

hook_scan_scene

タイプ: hook

既定値: scan_scene_{engine_name}

説明: パブリッシュする項目をスキャンするフックを指定します。このフックはパブリッシュする項目を表すリスト ディクショナリを返します。

primary_icon

タイプ: config_path

説明: UI で一次出力に使用されるアイコンです。

expand_single_items

タイプ: bool

説明: 項目が 1 つしかない場合に含まれる項目を表示できるように出力を展開するかどうかを定義します。

hook_thumbnail

タイプ: hook

既定値: thumbnail

説明: パブリッシュ用のサムネイルを事前に生成するフックを指定します。

hook_secondary_publish

タイプ: hook

既定値: secondary_publish_{engine_name}

説明: パブリッシュの実行に使用されるフックを指定します。このフックはパブリッシュする二次タスクのリストに渡されます。このフックはパブリッシュ プロセス全体を管理し、Shotgun へのパブリッシュ ファイルの登録を確定します。

hook_secondary_pre_publish

タイプ: hook

既定値: secondary_pre_publish_{engine_name}

説明: パブリッシュの前に実行されるフックを指定します。このフックを使用すると、パブリッシュ準備完了の確認のために渡される二次タスクの検証を実行できます。

primary_description

タイプ: str

既定値: Publish and version up the current work file

説明: UI で使用される一次出力の説明です。