-
-
Notifications
You must be signed in to change notification settings - Fork 33
/
info.yml
102 lines (87 loc) · 4.11 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
# ----------------------------------------------------------------------------
# Copyright (c) 2020, Diego Garcia Huerta.
#
# Your use of this software as distributed in this GitHub repository, is
# governed by the Apache License 2.0
#
# Your use of the Shotgun Pipeline Toolkit is governed by the applicable
# license agreement between you and Autodesk / Shotgun.
#
# The full license is in the file LICENSE, distributed with this software.
# ----------------------------------------------------------------------------
# Metadata defining the behavior and requirements for this engine
# Author: Diego Garcia Huerta
# Contact: https://www.linkedin.com/in/diegogh/
# 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
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: 3
debug_logging:
type: bool
description: Controls whether debug messages should be emitted to the logger
default_value: false
menu_favourites:
type: list
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."
allows_empty: True
values:
type: dict
items:
name: { type: str }
app_instance: { type: str }
run_at_startup:
type: list
description: "Controls what apps will run on startup. This is a list where each element
is a dictionary with two keys: 'app_instance' and 'name'. The app_instance
value connects this entry to a particular app instance defined in the
environment configuration file. The name is the menu name of the command
to run when the engine starts up. If name is '' then all commands from the
given app instance are started."
allows_empty: True
default_value: []
values:
type: dict
items:
name: { type: str }
app_instance: { type: str }
template_project:
type: template
description: "Template to use to determine where to set the blender project location.
This should be a string specifying the template to use but can also be
empty if you do not wish the project to be automatically set."
allows_empty: True
use_sgtk_as_menu_name:
type: bool
description: Optionally choose to use 'Sgtk' as the primary menu name instead of 'Shotgun'
default_value: false
launch_builtin_plugins:
type: list
description: Comma-separated list of tk-blender plugins to load when launching Blender. Use
of this feature disables the classic mechanism for bootstrapping Toolkit
when Blender is launched.
allows_empty: True
default_value: []
values:
type: str
# 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 Blender"
description: "Shotgun Integration in Blender"
# Required minimum versions for this item to run
requires_shotgun_version:
requires_core_version: "v0.18.8"