-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathstreamdeck.schema.json
328 lines (328 loc) · 12.2 KB
/
streamdeck.schema.json
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
{
"$schema": "http://json-schema.org/draft-04/schema#",
"$id": "https://github.com/lafe/Streamdeck-Homematic/streamdeck.schema.json",
"title": "Schema for Streamdeck Manifest file",
"description": "This schema is based on the official documentation by Elgato available at https://developer.elgato.com/documentation/stream-deck/sdk/manifest/",
"type": "object",
"definitions": {
"action": {
"description": "Defines a single action",
"type": "object",
"properties": {
"Icon": {
"description": "The relative path to a PNG image (without .png extension)",
"type": "string"
},
"Name": {
"description": "The display name of the Action that is displayed to the end user",
"type": "string"
},
"PropertyInspectorPath": {
"description": "An alternative path to an entry point for the Property Inspector. If set, this will override the PropertyInspectorPath value of the plugin itself.",
"type": "string"
},
"States": {
"description": "Defines the states the action can have",
"type": "array",
"items": {
"$ref": "#/definitions/state"
},
"minItems": 1,
"maxItems": 2
},
"SupportedInMultiActions": {
"description": "Defines if the action can be used in multi-actions. Default value is true.",
"type": "boolean",
"default": true
},
"Tooltip": {
"description": "The tooltip that is displayed for the action in the actions list",
"type": "string"
},
"UUID": {
"description": "The unique identifier of the plugin. It must be a \"uniform type identifier\" that contains only lowercase alphanumeric characters, hyphen and period. The string must be in reverse-DNS format.",
"type": "string"
},
"VisibleInActionsList": {
"description": "Defines if the action is visible in the actions list. Default value is true.",
"type": "boolean",
"default": true
}
},
"required": [
"Icon",
"Name",
"States",
"UUID"
]
},
"state": {
"type": "object",
"properties": {
"Image": {
"description": "Contains the default image for this state",
"type": "string"
},
"MultiActionImage": {
"description": "Alternate image for the action if it is part of a multi-action",
"type": "string"
},
"Name": {
"description": "The name of the state",
"type": "string"
},
"Title": {
"description": "The default title of the state",
"type": "string"
},
"ShowTitle": {
"description": "Determines if the title should be visible. Default value is true.",
"type": "boolean",
"default": true
},
"TitleColor": {
"description": "The default color of the title",
"type": "string"
},
"TitleAlignment": {
"description": "The default vertical alignment of the title.",
"enum": [
"top",
"middle",
"bottom"
],
"type": "string"
},
"FontFamily": {
"description": "The default font family used for the title",
"enum": [
"Arial",
"Arial Black",
"Comic Sans MS",
"Courier",
"Courier New",
"Georgia",
"Impact",
"Microsoft Sans Serif",
"Symbol",
"Tahoma",
"Times New Roman",
"Trebuchet MS",
"Verdana",
"Webdings",
"Wingdings"
],
"type": "string"
},
"FontStyle": {
"description": "The default style the title can be rendered in",
"enum": [
"Regular",
"Bold",
"Italic",
"Bold Italic"
],
"type": "string"
},
"FontSize": {
"description": "The default size of the title",
"type": "string"
},
"FontUnderline": {
"description": "Determines if the title is underlined. Default value is false",
"type": "boolean",
"default": false
}
},
"required": [
"Image"
]
},
"profile": {
"type": "object",
"properties": {
"Name": {
"description": "The filename of the profile",
"type": "string"
},
"DeviceType": {
"description": "Defines the type of the device",
"enum": [
"kESDSDKDeviceType_StreamDeck",
"kESDSDKDeviceType_StreamDeckMini",
"kESDSDKDeviceType_StreamDeckXL",
"kESDSDKDeviceType_StreamDeckMobile",
"kESDSDKDeviceType_CorsairGKeys"
],
"type": "string"
},
"ReadOnly": {
"description": "Allows to flag the profile as read-only. Default value is false",
"type": "boolean",
"default": false
},
"DontAutoSwitchWhenInstalled": {
"description": "Prevents Stream Deck to automatically switch to this profile when it is installed. Default value is false",
"type": "boolean",
"default": false
}
},
"required": [
"Name",
"DeviceType"
]
},
"operatingSystem": {
"type": "object",
"properties": {
"Platform": {
"description": "The identifier of the platform",
"enum": [
"mac",
"windows"
],
"type": "string"
},
"MinimumVersion": {
"description": "The minimum version of the specified platform that is supported. For Windows, you can use 10 to identify Windows 10.",
"type": "string"
}
},
"required": [
"Platform",
"MinimumVersion"
]
},
"streamDeckDetails": {
"type": "object",
"properties": {
"MinimumVersion": {
"description": "The minimum version of Stream Deck that is supported by this plugin. The oldest version possible is 4.1.",
"type": "string",
"default": "4.1"
}
}
},
"applicationToMonitor": {
"type": "object",
"properties": {
"mac": {
"description": "Mac application bundles the plugin should notified about.",
"type": "array",
"items": {
"type": "string"
}
},
"windows": {
"description": "Windows applications the plugin should notified about.",
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"properties": {
"Actions": {
"description": "Defines the actions of the plugin",
"type": "array",
"items": {
"$ref": "#/definitions/action"
}
},
"Author": {
"description": "The author of the plugin",
"type": "string"
},
"Category": {
"description": "The name of the category under which the actions are listed",
"type": "string"
},
"CategoryIcon": {
"description": "The relative path to the icon (in PNG format) but without the .png extension",
"type": "string"
},
"CodePath": {
"description": "The relative path to the HTML/binary file that is the main entry point of this plugin",
"type": "string"
},
"CodePathWin": {
"description": "A custom path that overrides the CodePath on Windows based machines",
"type": "string"
},
"CodePathMac": {
"description": "A custom path that overrides the CodePath on macOS based machines",
"type": "string"
},
"Description": {
"description": "A general description of the purpose of this plugin",
"type": "string"
},
"Icon": {
"description": "The relative path to a PNG file (without .png extension) that is displayed in the store",
"type": "string"
},
"Name": {
"description": "The displayed name of the plugin in the store",
"type": "string"
},
"Profiles": {
"description": "An array of profiles that are proposed to the end user during installation",
"type": "array",
"items": {
"$ref": "#/definitions/profile"
}
},
"PropertyInspectorPath": {
"description": "The relative path to the HTML file of the Propery Inspector. If it is empty, the plugin will have an empty property inspector",
"type": "string"
},
"DefaultWindowSize": {
"description": "Defines the default window size of a new window opened by the property inspector. Default value is [500, 650].",
"type": "string"
},
"URL": {
"description": "A URL to a page with more details about the plugin",
"type": "string"
},
"Version": {
"description": "The version of the plugin. The value can only contain digits and periods.",
"type": "string"
},
"SDKVersion": {
"description": "The value of the used SDK. This value should be 2",
"type": "number",
"default": 2
},
"OS": {
"description": "The operating systems and versions supported by this plugin",
"type": "array",
"items": {
"$ref": "#/definitions/operatingSystem"
}
},
"Software": {
"$ref": "#/definitions/streamDeckDetails"
},
"ApplicationsToMonitor": {
"description": "An array of all applications that should be monitored",
"type": "array",
"items": {
"$ref": "#/definitions/applicationToMonitor"
}
}
},
"required": [
"Actions",
"Author",
"CodePath",
"Description",
"Icon",
"Name",
"Version",
"SDKVersion",
"OS",
"Software"
]
}