mirror of
https://github.com/ynput/ayon-core.git
synced 2025-12-24 12:54:40 +01:00
added admin tvpaint host documentation with families
This commit is contained in:
parent
d0cfbb03bd
commit
434b108173
2 changed files with 43 additions and 1 deletions
41
website/docs/admin_hosts_tvpaint.md
Normal file
41
website/docs/admin_hosts_tvpaint.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
---
|
||||
id: admin_hosts_tvpaint
|
||||
title: TVPaint
|
||||
sidebar_label: TVPaint
|
||||
---
|
||||
|
||||
import Tabs from '@theme/Tabs';
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
## Families
|
||||
Families that can be published form TVPaint using OpenPype integration.
|
||||
|
||||
### renderLayer
|
||||
Render layer is represented by TVPaint group and all layers under the group. Output of `renderLayer` family are all visible layers rendered together into png sequence.
|
||||
|
||||
Render layer has additional keys for subset 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).
|
||||
|
||||
### renderPass
|
||||
Render pass is represented by one or more TVPaint layers. Is dependent on created `renderLayer`. All layers must be in same group of `renderLayer`.
|
||||
|
||||
Render pass has additional keys for subset 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).
|
||||
|
||||
:::note Subset name template
|
||||
It is recommended to use same subset name template for both **renderLayer** and **renderPass** families.
|
||||
- Example template: `"{family}{Task}_{Render_layer}_{Render_pass}"`
|
||||
:::
|
||||
|
||||
### review
|
||||
Review of whole scene. Exports all visible layers into sequence which is then processed in ExtractReview plugin. It is possible to deactivate publishing of review after collection.
|
||||
|
||||
### workfile
|
||||
Publish workfile and create it's backup outside of workfiles directory. It is possible to deactivate publishing of workfile after collection.
|
||||
|
||||
:::note Dynamic families
|
||||
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 subset name template. Recommented subset name template is `"{family}{Task}"`.
|
||||
:::
|
||||
|
|
@ -90,7 +90,8 @@ module.exports = {
|
|||
"admin_hosts_maya",
|
||||
"admin_hosts_resolve",
|
||||
"admin_hosts_harmony",
|
||||
"admin_hosts_aftereffects"
|
||||
"admin_hosts_aftereffects",
|
||||
"admin_hosts_tvpaint"
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue