Flame

Shotgun Flame 插件

在 Flame 中集成 Shotgun
最新版本:v1.12.3 (Prod)
我们的版本号遵循语义化版本标准。
系统名称:tk-flame

请注意:本文档介绍仅当控制 Toolkit 配置时可用的功能。有关更多详细信息,请参见 Shotgun 集成用户手册
概述
文档
            深入的技术漫谈
            安装
            Flame 项目设置
安装、更新和开发
配置选项

Shotgun Flame 插件在截至 Flame 2015 Extension 2 可用的各种集成挂钩之间创建桥接,并作为用于执行 Toolkit Flame 应用的主机。

支持的应用程序版本

此插件已经过测试,已知可支持以下应用程序版本:2016+。请注意,此插件也许(甚至非常有可能)支持更新的发布版本,但是尚未正式在这些版本中进行测试。

文档

深入的技术漫谈

如果您想安装并开始使用 Flame 集成,最好的入手点当属我们的技术漫谈视频。下面的播放列表中有几段视频,分步骤介绍了如何安装 Shotgun Desktop,设置项目,然后运行 Flame 集成。

最后一部分包含有关配置和挂钩的一些技术性更强的信息。看完所有视频后,您应该能够很好地了解 Flame 集成能做些什么,以及如何将它与工作流其余环节相连。

安装

Shotgun Flame 插件依赖于 Flame 2015 Extension 2 中新增的几个集成挂钩。为了保证插件正常工作,必须使用这一版本的 Flame。有关 Flame 2015 Extension 2 的详细信息(包括获取途径),请联系 Flame 技术支持

要想快速开始学习 Shotgun Flame 插件,最简单的方法是使用我们的示例工作流配置设置一个新的测试项目。您只要启动 Shotgun Desktop,运行项目设置向导设置一个新项目,然后选择默认的 Flame 配置(在默认配置部分)即可。

Flame 项目设置

Shotgun Flame 插件还能帮您将 Shotgun 项目与 Flame 项目关联起来,需要时还可创建 Flame 项目。这是集成的关键所在,因为这可以确保 Flame 的数据与 Shotgun 中的正确数据相关联。作为一项附加特性,插件还提供管理 Flame 项目命名约定以及项目其他各种设置的功能。

首次通过 Shotgun 启动 Flame 时,会显示一个创建 Flame 项目的用户界面,让美工人员可在标准 Flame 项目创建屏幕中编辑常用设置:

但是,利用 Shotgun 集成,我们可以为这些设置预先填充适合工作流的值,帮助美工人员不假思索地快速获取需要的内容。默认值可通过 project_setup_hook 进行自定义,此设置支持以下选项:

use_project_settings_ui - 如果设置为 True,将显示项目创建用户界面。如果设置为 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 中存储和管理的所有应用、插件和框架的源代码。欢迎根据实际需要演进和完善这些内容,以它们为基础做进一步的独立开发,修改它们(以及向我们提交 Pull 请求!),或者只是随手玩一玩,简单了解它们的构建方式和 Toolkit 的工作原理。您可以通过以下网址访问此代码库:https://github.com/shotgunsoftware/tk-flame

特殊要求

  • 需要安装 Shotgun Pipeline Toolkit 核心 API 版本 v0.14.76 或更高版本才能使用此功能。

配置

下面是使用的所有配置设置的摘要。您需要在要启用此应用或插件的环境文件中定义这些设置。

run_at_startup

类型:list

说明:控制哪些应用将在启动时运行。这是一个列表,其中每个列表项都是一个具有“app_instance”和“name”键的词典。“app_instance”值将此条目连接至环境配置文件中定义的一个特定应用实例。“name”是 Flame 启动时要运行的命令的菜单名称。如果“name”值为 '',则会启动给定应用实例的所有命令。

context_menu

类型:list

说明:控制 Flame 上下文菜单中显示的命令。这是一个列表,其中每个列表项都是一个词典,并具有三个键:“app_instance”、“name”和“display_name”。“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_hooks

类型:hook

默认值:{self}/backburner_hooks.py

说明:包含 Backburner 后台作业逻辑

backburner_manager

类型:str

说明:Backburner 管理器所在的主机。Flame 插件生成的所有 Backburner 作业都将派发到此服务器。只有 Flame 2016.1 及更高版本支持此设置。如果不指定此值,将使用系统默认值。

project_switching

类型:bool

说明:关于能否切换项目的提示。

关注

0 评论

登录写评论。