https://github.com/ghostzero/streamdeck-own3dpro

https://github.com/ghostzero/streamdeck-own3dpro

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ghostzero/streamdeck-own3dpro
• Owner: ghostzero
• License: mit
• Created: 2023-04-27T08:33:27.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-27T08:33:29.000Z (almost 2 years ago)
• Last Synced: 2024-11-24T08:15:28.589Z (2 months ago)
• Language: HTML
• Size: 45.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Stream Deck Plugin Template

The `Stream Deck Plugin Template` is a 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 6.0 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

## 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.

## Quick Start Guide

A short guide to help you get started quickly.

### Clone the repo

```git clone https://github.com/elgatosf/streamdeck-plugin-template```

### Replace Name

Rename the folder as well as any references.

`com.elgato.template` with `my.domain.plugin-name`

### Get the latest library

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```

### Start Coding

You can get started in app.js!

```javascript

const myAction = new Action('com.elgato.template.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!');

});

```