Shotgun の統合

Shotgun Engine

Shotgun への Tank の統合


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

概要

このドキュメントは、Toolkit の設定を管理するユーザのみが使用可能な機能について説明します。 詳細については、『Shotgun 統合ユーザ ガイド』を参照してください。 Shotgun Engine により、Shotgun Pipeline Toolkit アプリケーションを Shotgun の内部に組み込めます。 組み込まれると Shotgun 内のアクション メニューに表示され、プロジェクト中心のエンティティにアタッチすることができます。 たとえば、タスクからアプリケーションを直接起動するアプリケーションや、レビュー バージョン、概要、ショットやノートのレポートの配信を処理するアプリケーションを作成できます。

ドキュメント

Shotgun Engine は Shotgun 内から起動できるアプリケーションを管理します。 この Toolkit アプリケーションをアクションとして参照することもあります。 通常、Shotgun 内のメニューの項目として表示されます。

Shotgun Pipeline Toolkit アクションを使用する

アクションは Shotgun の Home ページに表示されます。

Tank のアクション

また、標準的な Shotgun のコンテキスト メニューにも表示されます。オブジェクトまたは選択項目を右クリックすると表示できます。

Tank のアクション

アクションをクリックすると、処理がすぐに開始されます。 アプリケーションの処理が完了すると、通常はいくつかのステータス情報を含むメッセージが表示されます。動作しなかった場合にはエラー メッセージが表示されます。

Shotgun 用のアプリケーションを開発する

Shotgun 内で実行されるアプリケーションの開発は簡単です。 通常のアプリケーション開発の仕組みが分からない場合は、プラットフォームのマニュアルを見つけて、概要部分を確認してください。 このセクションでは、アプリケーション開発プロセスの Shotgun 固有の側面について説明します。

Core v0.13 以降は、Shotgun Engine ですべてのマルチ アプリケーションを使用できます。 技術的には、Shotgun Engine と他のエンジンの違いはほとんどありません。 ただし、微妙な違いがあります。

  • Shotgun Engine で QT ベースのアプリケーションを実行する場合は、標準的な Python 環境に PySide または PyQt を手動でインストールする必要があります。

  • Shotgun Engine では、ユーザが属する権限グループに応じてアクションをユーザに表示することができます。 これは、Shotgun アクション メニューにコマンドを追加して、このコマンドを管理者に対してのみ表示する場合などに便利です。

hello-world スタイルの Shotgun アプリケーションを管理者のみに表示する場合、次のようになります。

from tank.platform import Application

class LaunchPublish(Application):

    def init_app(self):
        """
        Register menu items with Shotgun
        """        
        params = {
            "title": "Hello, World!",
            "deny_permissions": ["Artist"],
        }

        self.engine.register_command("hello_world_cmd", self.do_stuff, params)

    def do_stuff(self, entity_type, entity_ids):
        # this message will be displayed to the user
        self.engine.log_info("Hello, World!")

インストールと更新

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

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

> tank Project XYZ install_engine asset tk-shotgun

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

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

特殊な要件

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

環境設定

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

debug_logging

タイプ: bool

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

フォローする

0 コメント

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