Stream Deck SDK: Plugin Template
THIS PLUGIN TEMPLATE IS OUTDATED!!
PLEASE USE THE CURRENT ONE HERE:
https://github.com/elgatosf/streamdeck-plugin-template
The Stream Deck Plugin Template
is a boilerplate template to let you get started quickly when writing a Javascript plugin for Stream Deck.
Stream Deck Plugin Template
requires Stream Deck 4.1 or later.
Stream Deck Plugin Template
is a complete plugin that shows you how to
If you think about creating a Stream Deck plugin, it's a good idea to start with this template, because it already implements all code required to communicate from your plugin to the Property Inspector
and to your Stream Deck
.
There are also a bunch of utility helpers included, which makes it easy to process messages sent and received via Websockets.
Together with the PISamples
library it helps you create your full-fledged Stream Deck plugin fast.
Features:
A short guide to help you getting started quickly.
Use your utility of choice (or your terminal) to do a full string replace using:
Replace all occurences of:
com.elgato.template
with your.identifier.plugin
and:
Stream Deck Template
with Your Plugin Name
Fire up your preferred code-editor and open app.js
.
Remove what you don't need and start coding (e.g. in the onKeyDown
method)
Happy coding...