forked from shotgunsoftware/tk-nuke
-
Notifications
You must be signed in to change notification settings - Fork 0
/
info.yml
165 lines (148 loc) · 7.43 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
# Copyright (c) 2015 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 engine
# expected fields in the configuration file for this engine
configuration:
automatic_context_switch:
type: bool
description: "Controls whether Toolkit should attempt to automatically adjust its
context every time the currently loaded file changes. Defaults to True."
default_value: True
launch_builtin_plugins:
type: list
description: Comma-separated list of tk-maya plugins to load when launching Maya. Use
of this feature disables the classic mechanism for bootstrapping Toolkit
when Maya is launched.
allows_empty: True
default_value: []
values:
type: str
bin_context_menu:
type: list
default_value: []
allows_empty: true
values:
type: dict
items:
name: { type: str }
app_instance: { type: str }
keep_in_menu: { type: bool }
requires_selection: { type: bool }
description: "Controls which apps are added to the context menu for the bin view.
This is a list and each item is a dictionary with keys app_instance,
keep_in_menu, requires_select, and name. The app_instance parameter
connects this entry to a particular app instance defined in the
environment configuration file. The name is a menu name to add to
the context menu. keep_in_menu is true if this item should be
added to the main menu or not. requires_selection will disable the
menu item when there are no items selected in the view."
timeline_context_menu:
type: list
default_value: []
allows_empty: true
values:
type: dict
items:
name: { type: str }
app_instance: { type: str }
keep_in_menu: { type: bool }
requires_selection: { type: bool }
description: "Controls which apps are added to the context menu for the timeilne view.
This is a list and each item is a dictionary with keys app_instance,
keep_in_menu, requires_select, and name. The app_instance parameter
connects this entry to a particular app instance defined in the environment
configuration file. The name is a menu name to add to the context menu.
keep_in_menu is true if this item should be added to the main menu
or not. requires_selection will disable the menu item when there are no
items selected in the view."
spreadsheet_context_menu:
type: list
default_value: []
allows_empty: true
values:
type: dict
items:
name: { type: str }
app_instance: { type: str }
keep_in_menu: { type: bool }
requires_selection: { type: bool }
description: "Controls which apps are added to the context menu for the spreadsheet
view. This is a list and each item is a dictionary with keys app_instance,
keep_in_menu, requires_select, and name. The app_instance parameter connects
this entry to a particular app instance defined in the environment configuration
file. The name is a menu name to add to the context menu. keep_in_menu is true if
this item should be added to the main menu or not. requires_selection will disable
the menu item when there are no items selected in the view."
favourite_directories:
type: list
description: Adds entries to the favourites section in the file chooser.
values:
type: dict
items:
display_name:
type: str
description: Name of shortcut in favourites section of the file chooser.
template_directory:
type: template
fields: context
description: Template path for the shortcut in favourites section.
icon:
type: config_path
description: "Path to icon for the favourite relative to the project config
directory. You can use the default icon by specifying an
empty string with two double quotes."
default_value: []
allows_empty: true
project_favourite_name:
type: str
description: "Allows customizing the name of the favourite directory representing
the current project root in the file chooser. eg. 'Shotgun Current Project'.
In multi-root configs, there will be an entry for each root eg. 'Shotgun
Current Project (secondary)'. Specifying an empty string will disable this
menu from being added to the favourites automatically."
default_value: "Shotgun Current Project"
debug_logging:
type: bool
description: Controls whether debug messages should be emitted to the logger
default_value: false
menu_favourites:
type: list
default_value: []
description: "Controls the favourites section on the main menu. This is a list
and each menu item is a dictionary with keys app_instance and name.
The app_instance parameter connects this entry to a particular
app instance defined in the environment configuration file. The name
is a menu name to make a favourite. An optional hotkey parameter can
be included for triggering the menu action (Nuke only)."
allows_empty: True
values:
type: dict
items:
name: { type: str }
app_instance: { type: str }
use_sgtk_as_menu_name:
type: bool
description: Optionally choose to use 'Sgtk' as the primary menu name instead of 'Shotgun'
default_value: false
compatibility_dialog_min_version:
type: int
description: "Specify the minimum Application major version that will prompt a warning if
it isn't yet fully supported and tested with Toolkit. To disable the warning
dialog for the version you are testing, it is recomended that you set this
value to the current major version + 1."
default_value: 10
# the Shotgun fields that this engine needs in order to operate correctly
requires_shotgun_fields:
# More verbose description of this item
display_name: "Shotgun Engine for Nuke"
description: "Shotgun Integration in Nuke"
# Required minimum versions for this item to run
requires_shotgun_version:
requires_core_version: "v0.19.5"