Shotgun Engine

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

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

概要
ドキュメント
Shotgun Pipeline Toolkit アクションを使用する
Shotgun 用のアプリを開発する
インストール、更新、開発
設定オプション

Shotgun Engine により、Shotgun Pipeline Toolkit アプリを Shotgun の内部に組み込めます。組み込まれると Shotgun 内のアクションメニューに表示され、プロジェクト中心のエンティティにアタッチすることができます。たとえば、タスクからアプリケーションを直接起動したり、レビューバージョン、概要、ショットやノートのレポートの配信を処理するアプリを起動したりできます。

ドキュメント

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

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

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

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

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

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

コラボレーションと発展

Shotgun Pipeline Toolkit にアクセスできる場合は、すべてのアプリ、エンジン、およびフレームワークのソースコードにも Github からアクセスできます。これらは Github を使用して格納および管理しています。これらの項目は自由に発展させてください。さらなる独立した開発用の基盤として使用したり、変更を加えたり(その際はプルリクエストを送信してください)、いろいろと研究してビルドの方法やツールキットの動作を確認してください。このコードリポジトリには、https://github.com/shotgunsoftware/tk-shotgun からアクセスできます。

特殊な要件

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

環境設定

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

debug_logging

タイプ: bool

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

Shotgun の統合