forked from shotgunsoftware/tk-nuke-writenode
-
Notifications
You must be signed in to change notification settings - Fork 1
/
info.yml
130 lines (119 loc) · 6.36 KB
/
info.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# Copyright (c) 2013 Shotgun Software Inc.
#
# CONFIDENTIAL AND PROPRIETARY
#
# This work is provided "AS IS" and subject to the Shotgun Pipeline Toolkit
# Source Code License included in this distribution package. See LICENSE.
# By accessing, using, copying or modifying this work you indicate your
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
# not expressly granted therein are reserved by Shotgun Software Inc.
# Metadata defining the behaviour and requirements for this app
# expected fields in the configuration file for this app
configuration:
# tank write nodes paths
write_nodes:
type: list
description: "A list of dictionaries in which you define the Shotgun Write nodes that
are supported in this configuration. Each dictionary entry needs to have
the following keys: 'name' - a descriptive name for this node. 'file_type' -
the file type to use for the renders (exr, cin, dpx etc). This will be
passed to the Nuke write node when rendering. 'file_extension' - optional
key to specify file extension if it is different from file_type (e.g. jpg
as opposed to jpeg or tif as opposed to tiff). 'settings' - configuration
settings for the given file type, as a dictionary. This too will be
passed to the write node when rendering. Next, you need two entries
named 'render_template' and 'publish_template'
- these control the locations where data is written to at various stages
of the workflow. These templates need to include the 'version' field
and can optionally include the fields 'name', 'width', 'height'
(which reflect the image resolution of the render) and 'output' (which
differentiates different write nodes). If you are doing stereo
rendering and want to use Nuke's %V flag, include an 'eye' field.
This will be replaced by %V in the paths when the Shotgun Write node
computes them. Finally, you need the templates 'proxy_render_template'
and 'proxy_publish_template' these have the same requirements as the regular
render and publish templates but are used when rendering in proxy mode. If
these are missing (set to null) then the regular templates will be used
instead."
allows_empty: True
values:
type: dict
items:
name:
type: str
file_type:
type: str
file_extension:
type: str
default_value: ''
node_class:
type: str
default_value: Write
description: Class of nuke node to be created.
settings:
type: dict
tank_type:
type: tank_type
tank_channel:
type: str
use_node_name:
type: bool
default_value: False
render_template:
type: template
fields: context, version, SEQ, [channel], [output], [name], [width], [height], [eye], [YYYY], [MM], [DD], *
publish_template:
type: template
fields: context, version, SEQ, [channel], [output], [name], [width], [height], [eye], [TankType], *
proxy_render_template:
type: template
fields: context, version, SEQ, [channel], [output], [name], [width], [height], [eye], *
allows_empty: True
default_value: null
proxy_publish_template:
type: template
fields: context, version, SEQ, [channel], [output], [name], [width], [height], [eye], [TankType], *
allows_empty: True
default_value: null
tile_color:
type: list
values:
type: int
description: "Specify a list of 3 values in the range 0-255 that represent the RGB values to be
set for the node background/tile_color in the node graph when this profile is used.
Specify an empty list to use the default colour."
allows_empty: True
default_value: []
promote_write_knobs:
type: list
values:
type: str
description: "Specify a list of knob names that should be promoted from the internal write node
up to the user interface of the gizmo."
allows_empty: True
default_value: []
# Note that if you have presets which promote write knobs, the convert menu items will not be shown, regardless
# of the value applied to this setting, as at present the convert back method doesn't support promoted knobs.
show_convert_actions:
type: bool
description: "Setting this to True will add actions for converting to and from Shotgun write nodes.
The actions will be displayed as options in the Shotgun -> Context menu"
default_value: False
template_script_work:
type: template
description: "A reference to a template which locates a nuke script work file on disk. This
is used to drive the version and optionally the name of renders."
fields: context, version, [name], *
# the Shotgun fields that this app needs in order to operate correctly
requires_shotgun_fields:
# More verbose description of this item
display_name: "Write Node"
description: "Support for the Shotgun Write Node in Nuke."
# Required minimum versions for this item to run
requires_shotgun_version:
requires_core_version: "v0.14.37"
requires_engine_version: "v0.2.3"
# the engines that this app can operate in:
supported_engines: [tk-nuke]
# the frameworks required to run this app
frameworks: