TVPaint Addon Settings

Last updated 19 days ago

Color Management (ImageIO)​

Setting Location: ayon+settings://tvpaint/imageio

This section allows you to configure and override the global color management settings. For more details, check Host specific overrides.

  • Enable Color Management: Turns on color management for Tray Publisher.

  • File Rules

    • Activate Host Rules: Enable this to override global color rules.

    • Rules

      • + : Add more rules

      • Each rule consists of:

        • Rule name

        • Regex pattern

        • Colorspace name

        • File extension

Stop Timer

Setting Location: ayon+settings://tvpaint/imageio

Create Plugins

Create Workfile

Setting Location: ayon+settings://tvpaint/create/create_workfile

Create Review

Setting Location: ayon+settings://tvpaint/create/create_review

Create Render Scene

Setting Location: ayon+settings://tvpaint/create/create_render_scene

Create Render Layer

Setting Location: ayon+settings://tvpaint/create/create_render_layer

Create Render Pass

Setting Location: ayon+settings://tvpaint/create/create_render_pass

Auto-Detect Create Render

Setting Location: ayon+settings://tvpaint/create/auto_detect_render

The creator tries to auto-detect Render Layers and Render Passes in scene.

For Render Layers is used group name as a variant and for Render Passes is used TVPaint layer name.

Group names can be renamed by their used order in scene. The renaming template where can be used '{group_index}' formatting key which is filled by "used position index of group".

  • Template: 'L{group_index}'

  • Group offset: '10'

  • Group padding: '3'

Would create group names "L010", "L020", ...

Publish Plugins

Collect Render Instances

Setting Location: ayon+settings://tvpaint/publish/CollectRenderInstances

Extract Sequence

Setting Location: ayon+settings://tvpaint/publish/ExtractSequence

Review BG color is used for whole scene review and for thumbnails.

Validate Project Settings

Setting Location: ayon+settings://tvpaint/publish/ValidateProjectSettings

Validate Mark In/Out

Setting Location: ayon+settings://tvpaint/publish/ValidateMarks

Validate Scene Start Frame

Setting Location: ayon+settings://tvpaint/publish/ValidateStartFrame

Validate Folder Name

Setting Location: ayon+settings://tvpaint/publish/ValidateAssetName

Extract Convert To EXR

Setting Location: ayon+settings://tvpaint/publish/ExtractConvertToEXR

This plugin does not work on MacOS (using OIIO tool).

Load Plugins

Load Image

Setting Location: ayon+settings://tvpaint/load/LoadImage

Import Image

Setting Location: ayon+settings://tvpaint/load/ImportImage

Workfile Builder

Setting Location: ayon+settings://tvpaint/workfile_builder

  • Create first workfile: Enable to create a workfile if there are no workfiles.

  • Custom Templates

    • Each Custom Template

      • Task Types

      • Path (per OS)

    • + : Add a template.

Product names Configuration​

Product names are defined in core addon settings in

  • ayon+settings://core/tools/creator/product_name_profiles

Definition of possible product name templates in TVPaint integration.

Render Layer​

Render layer has additional keys for product name template. It is possible to use render_layer and render_pass.

  • Key render_layer is alias for variant (user's input).

  • For key render_pass is used predefined value "Beauty" (ATM value can't be changed).

Render pass​

Render pass has additional keys for product name template. It is possible to use render_layer and render_pass.

  • Key render_layer is filled with value of render_pass from renderLayer group.

  • Key render_pass is alias for variant (user's input).

Render Layer/Pass Templates

It is recommended to use same product name template for both renderLayer and renderPass families.

  • Example template: "{family}{Task}_{Render_layer}_{Render_pass}"

Review and Workfile​

Families review and workfile are not manually created but are automatically generated during publishing. That's why it is recommended to not use variant key in their product name template.