forked from shotgunsoftware/tk-multi-reviewsubmission
-
Notifications
You must be signed in to change notification settings - Fork 3
/
info.yml
172 lines (146 loc) · 6.38 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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# 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:
upload_to_shotgun:
type: bool
default_value: true
description: Should the movie being created be uploaded to Shotgun
as a version or just kept on disk? Disabling this as well
as the store_on_disk option effectively disables the whole
tool.
store_on_disk:
type: bool
default_value: true
description: Should the movie being created be kept on disk? Disabling
this as well as the upload_to_shotgun option will
effectively disable the whole tool.
movie_path_template:
type: template
required_fields: []
optional_fields: "*"
description: Template defining the output location of the movie file
on the the file system. For this template you can use all
the fields defined in the template passed to the
render_and_submit fields. In addition to these you can use
the special fields width and height, which contain the
resolution of the movie. If the store_on_disk setting is
false, this setting will still be required but will be used
as a temporary location for processing before the file is
uploaded to Shotgun.
extra_write_nodes_path_info:
type: dict
description: Dictionary containing a mapping of Write node names
to their corresponding output paths in the form of templates.
allows_empty: True
values:
type: template
fields: context, version, [output], [name], *
description: Output path of the Write nodes
allows_empty: False
movie_width:
type: int
default_value: 1024
description: The width of the rendered movie file
movie_height:
type: int
default_value: 540
description: The height of the rendered movie file
new_version_status:
type: str
default_value: rev
description: The value to use for a new Version's status.
version_number_padding:
type: int
default_value: 3
description: This value will be used to pad the version number in the
slate and various movie burnins. This will not affect version
number padding in the movie filename. See movie_path_template.
Use 1 for no padding.
sg_version_name_template:
type: template
fields: context, version, [output], [name], *
description: "Template used to populate the version name in Shotgun. You can use any field
from the current context (such as for example Shot and Sequence) and the template
must include current version. Additionally, output and name fields will be used
if they are defined."
slate_logo:
type: template
fields: context
description: This is the template for a path to an image to use on the slate such as a
company logo. The supplied image will be reformated into a
400 pixel box and the lower left corner of the logo will be
aligned 100 pixels to the right and 100 pixels above the
lower left corner of the slate. You can use an image with
an alpha channel if you want to add transparency. Currently
any image format supported by Nuke is adequate. If this
setting is an empty string, no logo will be applied.
codec_settings_hook:
type: hook
description: Hook for customizing codec settings used when generating items
for review.
default_value: '{self}/codec_settings.py'
preprocess_nuke_hook:
type: hook
description: Hook for doing any preprocessing to the burnin nuke script
and return the processed script path.
default_value: '{self}/preprocess_nuke.py'
nuke_linux_path:
type: str
description: The path to the application executable on Linux.
default_value: ""
nuke_windows_path:
type: str
description: The path to the application executable on Windows.
default_value: ""
nuke_mac_path:
type: str
description: The path to the application executable on Mac OS X.
default_value: ""
burnin_path:
type: template
fields: context
description: Template for burnin nuke file path.
allows_empty: True
render_script:
type: template
fields: context
description: Template for python script executed by nuke subprocess.
allows_empty: True
mov_has_slate:
type: bool
default_value: true
description: Set the "Movie has slate" property on the version entity.
entity_burnin_sg_fields:
type: list
values: {type: str}
allows_empty: True
default_value: []
description: SG fields on entity to be added as burnins on slate
task_burnin_sg_fields:
type: list
values: {type: str}
allows_empty: True
default_value: []
description: SG fields on task to be added as burnins on slate
# the Shotgun fields that this app needs in order to operate correctly
requires_shotgun_fields:
# More verbose description of this item
display_name: "Review Submission"
description: "Provides functionality to submit image sequences to Shotgun for review."
# Required minimum versions for this item to run
requires_shotgun_version:
requires_core_version: "v0.14.0"
requires_engine_version:
# For now this app is only compatible with Nuke.
supported_engines:
# the frameworks required to run this app
frameworks: