如何向配置中添加新发布器 (tk-multi-publish2)?

摘要

我们最近发布了新一代的发布器,该发布器已在配置中使用,Shotgun 现在无需对自身进行任何显式配置,即可针对任何项目运行此配置。本文将指导您如何将新发布器包含在现有配置中。

更新环境

第一步是更新要在其中使用新发布器的环境文件,以加入新应用。确保新发布器的配置易于在各环境间重用的一种简单方法是,引入可在所需位置包含的新文件。

此文件可以与 includes/tk-multi-publish2.yml 类似,如下所示:

# A mapping of SG publish types to file extensions. The basic file publisher
# will use the publish type matching the extension if it exists in this list,
# otherwise, the publish type will simply be the extension + " File". To
# associate other extensions with existing publish types or to add new Publish
# types, simply update the list below. The format is:
# - [Publish Type, ext1, ext2, ext3, ...]
publish_type_to_extensions: &file_types
  - [Alembic Cache, abc]
  - [3dsmax Scene, max]
  - [NukeStudio Project, hrox]
  - [Houdini Scene, hip, hipnc]
  - [Maya Scene, ma, mb]
  - [Nuke Script, nk]
  - [Photoshop Image, psd, psb]
  - [Rendered Image, dpx, exr]
  - [Texture, tiff, tx, tga, dds]
  - [Image, jpeg, jpg, png]
  - [Movie, mov, mp4]

common.settings.tk-multi-publish2.publish_file:
  name: Publish to Shotgun
  hook: "{config}/tk-multi-publish2/basic/publish_file.py"
  settings:
    File Types: *file_types

common.settings.tk-multi-publish2.upload_version:
  name: Upload for review
  hook: "{config}/tk-multi-publish2/basic/upload_version.py"
  settings: {}

您随时可以在基本配置的实际实施中看到此示例。

遇到确实需要向环境中添加新发布器的情况时,您便会想要找到此示例。您可以通过向相应的 YAML 文件中添加 tk-multi-publish2 实例来实现此目的。例如,在 project.yml 中,可添加如下内容:

# include the multi-publish2 settings
- ./includes/tk-multi-publish2.yml 
# standalone publishing
 tk-multi-publish2:
   collector: "{config}/tk-multi-publish2/basic/collector.py"
   publish_plugins:
     - '@common.settings.tk-multi-publish2.publish_file'
     - '@common.settings.tk-multi-publish2.upload_version'
   help_url: "https://support.shotgunsoftware.com/hc/en-us/articles/115000067473#Publisher"
   location:
     type: app_store
     version: v1.1.6
     name: tk-multi-publish2

在基本配置的项目设置中,您可以看到实际应用的示例。对于使用更多基本挂钩的更复杂设置,可以在基本配置的 Maya 设置中查看对此的应用方式。

您可以将与上面类似的代码段添加到所有相应环境的所有相应插件的应用配置中。

复制新发布挂钩和所需图标

为了让新应用加载独立的 publish2 挂钩,需要将这些挂钩复制到配置的 hooks 文件夹中。如果要使用无专用配置时运行的那些挂钩,可从基本配置的 hooks 目录中进行复制。如果从该 hooks 目录内复制整个 tk-multi-publish2 文件夹,上面的设置将生效,而且您复制的还包括配置所需的全部图标。

更新核心、应用和框架

另外需要的唯一一个步骤是确保您安装了更新版本的核心、最新的发布器应用和 shotgunutils/qtwidgets 框架。可在命令行上更新应用和框架,如下所示:

tank updates project tk-desktop

但请将 project 替换为要更新的环境,将 tk-desktop 替换为要更新的插件。

系统提示您更新 tk-multi-publish2 或框架时,请键入 y 并按 Enter 键。

建议您更新到最新核心,以便收到最新的错误修复。为此,请运行以下命令:

tank core

要更新到特定版本,可使用 -v 标志显式指定。运行新发布器所需的最低版本为 v0.18.83

重要说明

新发布器不向后兼容早期版本的发布器。编写新发布插件的挂钩时考虑了使用基本 Shotgun 集成,未考虑模板。如果您有兴趣了解更多有关如何执行新发布挂钩的信息,请参考基本配置中的挂钩或发送电子邮件至 support@shotgunsoftware.com

关注

0 评论

登录写评论。