The Stream Deck Plugin Template is a template to let you get started quickly when writing a JavaScript plugin for Stream Deck. Stream Deck Plugin Template requires Stream Deck 6.0 or later.
Stream Deck Plugin Template is a complete plugin that shows you how to
- load and save settings using Stream Deck's persistent store
- setup and communicate with the Property Inspector
- pass messages directly from Property Inspector to the plugin (and vice versa)
- localize your Property Inspector's UI to another language
- code written in Javascript
- cross-platform (macOS, Windows)
- localization support
- styled Property Inspector included
- Property Inspector contains all required boilerplate code to let you instantly work on your plugin's code.
A short guide to help you get started quickly.
git clone https://github.com/elgatosf/streamdeck-plugin-template
Rename the folder as well as any references.
com.elgato.template with com.jbokman.intellij
Be sure .gitmodules has been updated to match your new folder name my.domain.plugin-name and then pull the latest libraries.
git submodule init && git submodule update
You can get started in app.js!
const myAction = new Action('com.jbokman.intellij.action');
/**
* The first event fired when Stream Deck starts
*/
$SD.onConnected(({ actionInfo, appInfo, connection, messageType, port, uuid }) => {
console.log('Stream Deck connected!');
});
myAction.onKeyUp(({ action, context, device, event, payload }) => {
console.log('Your key code goes here!');
});
myAction.onDialRotate(({ action, context, device, event, payload }) => {
console.log('Your dial code goes here!');
});