forked from shotgunsoftware/tk-multi-launchapp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinfo.yml
90 lines (78 loc) · 3.62 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
# 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:
menu_name:
type: str
description: Name to appear on the Shotgun menu.
icon:
type: config_path
description: The icon to appear for the application
default_value: ""
# Path information for multiple platforms
windows_path:
type: str
description: The path to the application executable on Windows.
windows_args:
type: str
description: The arguments to be passed to application on Windows, as a string.
default_value: ""
linux_path:
type: str
description: The path to the application executable on Linux.
linux_args:
type: str
description: The arguments to be passed to application on Linux, as a string.
default_value: ""
mac_path:
type: str
description: The path to the application executable on Mac OS X.
mac_args:
type: str
description: The arguments to be passed to application on Mac OS X, as a string.
default_value: ""
engine:
type: str
description: "The name of the Shotgun engine to start. This is typically the application
name prefixed with tk, e.g. tk-maya, tk-nuke, tk-photoshop etc. If you set
this to an empty string, no toolkit engine will be started, meaning that
you can launch applications that do not have toolkit engines set up."
extra:
type: dict
description: "Shotgun engine specific extra values. These are defined per Shotgun engine.
Please look in the app documentation for more details."
hook_app_launch:
type: hook
default_value: app_launch
description: "Called to launch the application. This hook contains the code that does
the actual execution of the launch command and parameters. If you have
a custom launcher system in your studio, it can be handy to override
Tank's default launch behaviour."
hook_before_app_launch:
type: hook
default_value: before_app_launch
description: "This hook is called just before the hook_app_launch is used and can be
useful if you don't want to modify the way applications are being launched
(which is advanced usage and can be done by overriding the app_launch hook),
but merely want to modify the environment before app launch. You may want
to add additional pipeline paths, APIs or other things to the setup, or
specify additional scripts etc to run."
# the Shotgun fields that this app needs in order to operate correctly
requires_shotgun_fields:
# More verbose description of this item
display_name: "Launch Application"
description: "Launch Applications and initialize the Shotgun Pipeline Toolkit."
# Required minimum versions for this item to run
requires_shotgun_version:
requires_core_version: "v0.14.0"
requires_engine_version:
# the engines that this app can operate in:
supported_engines: