Elgato Stream Deck

Elgato Stream Deck plugin manifest file

Type object
File match elgato-stream-deck-plugin.yml elgato-stream-deck-plugin.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/elgato-stream-deck/latest.json
Source https://www.schemastore.org/elgato-stream-deck-plugin.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Manifest files for plugins built for the Elgato Stream Deck SDK

Properties

CodePath string required

The relative path to the HTML/binary file containing the plugin code.

Description string required

Provides a general description of what the plugin does. This string is displayed to the user in the Stream Deck store.

Icon string required

The relative path to an image without the extension. This image is displayed in the Stream Deck marketplace. SVGs are preferred. If not, the PNG image should be 288 x 288 px, and you should provide @1x and @2x (288 x 288 px & 576 x 576 px respectively). The Stream Deck application takes care of loading the appropriate version of the image.

Name string required

The name of the plugin. This string is displayed to the user in the Stream Deck store.

Version string required

Plugin's semantic version (1.0.0).

SDKVersion number required

The current SDK version is 2.

min=1
OS object[] required

The list of operating systems & versions supported by the plugin.

minItems=1
Software object required

Indicates which version of the Stream Deck application is required to install the plugin.

1 nested properties
MinimumVersion string

The minimum version of the operating system that the plugin requires. For Windows 10, you can use “10”. For macOS 10.11, you can use “10.11”.

pattern=^\d+(\.\d+)*$
Actions object[] required

Specifies an array of actions. A plugin can indeed have one or multiple actions. For example, the “Game Capture” plugin has six actions: Scene, Record, Screenshot, Flashback Recording, Stream, Live Commentary.

Author string

The author of the plugin. This string is displayed to the user in the Stream Deck store.

Category string

The name of the custom category in which the actions should be listed. This string is visible to the user in the actions list. If you don't provide a category, the actions will appear inside a "Custom" category.

CategoryIcon string

The relative path to a PNG image without the .png extension. This image is used in the actions list. The PNG image should be a 28pt x 28pt image. You should provide @1x and @2x versions of the image. The Stream Deck application takes care of loading the appropriate version of the image.

CodePathMac string

Override CodePath for macOS.

CodePathWin string

Override CodePath for Windows.

Profiles object[]

Specifies an array of profiles. A plugin can have one or more profiles proposed to the user on installation. This lets you create full screen plugins.

PropertyInspectorPath string

The relative path to the Property Inspector HTML file if your plugin wants to display some custom settings in the Property Inspector. If missing, the plugin will have an empty Property Inspector.

DefaultWindowSize number[]

Specify the default window size when a Javascript plugin or Property Inspector opens a window using window.open(). The default value is [500, 650].

minItems=2maxItems=2
URL string

A site to provide more information about the plugin.

ApplicationsToMonitor object

List of application identifiers to monitor (applications launched or terminated). See the applicationDidLaunch and applicationDidTerminate events.

2 nested properties
mac string[]
windows string[]