forked from shotgunsoftware/tk-multi-publish
-
Notifications
You must be signed in to change notification settings - Fork 0
/
info.yml
202 lines (172 loc) · 8.5 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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# 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:
display_name:
type: str
default_value: Publish
description: Specify the name that should be used in menus and the main
publish dialog
template_work:
type: template
description: A reference to a template which locates a work file on disk.
fields: context, version, *
hook_thumbnail:
type: hook
parameters: []
default_value: thumbnail
description: Specify a hook to pre-generate a thumbnail for the publish.
hook_copy_file:
type: hook
parameters: [source_path, target_path, task]
default_value: copy_file
description: Specify a hook to copy the file 'source_path' to 'target_path'.
This hook is used in the 'copy_file' utility function and can
be accessed from other hooks by calling
self.parent.copy_file(source_path, target_path, task)
from within the hook.
hook_scan_scene:
type: hook
parameters: []
default_value: "scan_scene_{engine_name}"
description: Specify a hook to scan for items to publish.
The hook should return a list dictionaries that represent the items
to be published.
hook_primary_pre_publish:
type: hook
parameters: [task, work_template, progress_cb]
default_value: primary_pre_publish
description: Specify the hook that will run before the primary publish. This hook
can be used to perform any validaiton on the primary task that is
passed in to ensure that it is ready to be published.
hook_primary_publish:
type: hook
parameters: [task, work_template, comment, thumbnail_path, sg_task, progress_cb]
default_value: primary_publish
description: Specify the hook that will actually do the publish of the primary
task. This hook is passed the primary task that should be published.
The hook is responsible for the entire publish process and should
ensure to register the publish with Shotgun.
hook_secondary_pre_publish:
type: hook
parameters: [tasks, progress_cb]
default_value: "secondary_pre_publish_{engine_name}"
description: Specify the hook that will run before the publish. This hook can be
used to perform any validaiton on the secondary tasks that are passed
in to ensure that they are ready to be published.
hook_secondary_publish:
type: hook
parameters: [tasks, work_template, comment, thumbnail_path, sg_task, primary_publish_path, progress_cb]
default_value: "secondary_publish_{engine_name}"
description: Specify the hook that will be used to do the publish. This hook is
passed a list of secondary tasks that are to be published.
The hook is responsible for the entire publish process and should
ensure it registers the published files with Shotgun
hook_post_publish:
type: hook
parameters: [work_template, progress_cb]
default_value: post_publish
description: Specify the hook that will be used to do any post-publish work. Typically,
this hook will be responsible for versioning up the scene to the latest
version.
primary_scene_item_type:
type: str
description: This is the type used to match up items returned from the scan
scene hook with with the primary output
default_value: work_file
primary_display_name:
type: str
description: This is the name the primary output will be given in the UI
default_value: "Current Work File"
primary_description:
type: str
description: This is the description of the primary output used in the UI
default_value: "Publish and version up the current work file"
primary_icon:
type: config_path
description: This is the icon used for the primary output in the UI
default_value: ""
primary_tank_type:
type: tank_type
description: This is the type that will be used when registering the primary
published file with Shotgun.
If not set then this must be determined within the publish hook.
default_value: ""
primary_publish_template:
type: template
fields: context, version, *
description: Template used to locate the primary published file within the file
system. If None then this must be determined within the publish hook.
secondary_outputs:
type: list
values:
type: dict
items:
name:
type: str
description: Identifying name of this output. This is provided to the
pre-publish and publish hooks to allow them to determine
what they should publish for task.
scene_item_type:
type: str
description: Type used to match up items returned from the scan scene
hook with specific outputs
display_name:
type: str
description: The name this output will be given in the UI
display_group:
type: str
description: The group that this output should appear in within the UI
description:
type: str
description: Description of this output used in the UI
icon:
type: config_path
description: Icon used for this output in the UI
selected:
type: bool
description: Initial state for outputs of this type in the UI
required:
type: bool
description: Specify if this output is required for the publish or not.
If an output is required then it will not be deselectable in
the UI.
tank_type:
type: tank_type
description: The type that will be used when registering any published
files for this output with Shotgun.
If set to '' then this must be determined within the publish hook.
publish_template:
type: template
fields: context, version, *
allows_empty: True
description: Template used to locate published files within the file system.
If null then this must be determined within the publish hook.
decription: Specify all other outputs that are supported.
All non-primary items returned from the scan scene hook must match
up with one of these secondary types
allows_empty: True
default_value: []
# the Shotgun fields that this app needs in order to operate correctly
requires_shotgun_fields:
# More verbose description of this item
display_name: "Publish"
description: "Provides UI and functionality to publish files to Shotgun."
# Required minimum versions for this item to run
requires_shotgun_version:
requires_core_version: "v0.14.11"
requires_engine_version:
# this app works in all engines - it does not contain
# any host application specific commands
supported_engines:
# the frameworks required to run this app
frameworks:
- {"name": "tk-framework-widget", "version": "v0.1.16"}