https://github.com/elgatosf/streamdeck-plugintemplate
Stream Deck SDK: Plugin Template
https://github.com/elgatosf/streamdeck-plugintemplate
elgato elgato-stream-deck streamdeck streamdeck-sdk streamdecksdk
Last synced: 9 months ago
JSON representation
Stream Deck SDK: Plugin Template
- Host: GitHub
- URL: https://github.com/elgatosf/streamdeck-plugintemplate
- Owner: elgatosf
- License: mit
- Archived: true
- Created: 2019-02-28T15:48:55.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T11:33:59.000Z (about 3 years ago)
- Last Synced: 2024-08-10T14:06:22.984Z (over 1 year ago)
- Topics: elgato, elgato-stream-deck, streamdeck, streamdeck-sdk, streamdecksdk
- Language: JavaScript
- Homepage: https://developer.elgato.com/documentation/stream-deck/
- Size: 346 KB
- Stars: 228
- Watchers: 17
- Forks: 65
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stream Deck Plugin Template
## PLEASE NOTE:
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](https://developer.elgato.com/documentation/stream-deck/).
`Stream Deck Plugin Template` requires Stream Deck 4.1 or later.
# Description
`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
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](https://github.com/elgatosf/streamdeck-pisamples/) it helps you create your full-fledged Stream Deck plugin fast.
## Features:
Features:
- code written in Javascript
- cross-platform (macOS, Windows)
- localization support
- styled [Property Inspector](https://developer.elgato.com/documentation/stream-deck/sdk/property-inspector/) included
- Property Inspector contains all required boilerplate code to let you instantly work on your plugin's code.
----
# Quickstart: From Template to Plugin in under a minute
A short guide to help you getting started quickly.
### Pre-requisites
- Download or clone the template plugin.
### Do a search/replace on strings in the template's files:
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...