Giter Club home page Giter Club logo

sdk's Introduction

Now they support Node.js plugins, hot reload and more.

This project is now archived


Elgato Stream Deck SDK

Unofficial Node.js SDK

Library Features

  • Allow the creation and building of a Node.js plugin (not everything can be done with the internal JavaScript in the Stream Deck App)
  • Strictly typed
  • Simplify the plugin's development
  • Auto-populate the plugin settings
  • Single / double taps and long press managed events
  • Automatically handles image url, file or Base64 images
  • Easy debugging + development (no stream deck application's reload necessary!)
  • Per action class development (not worry about checking every time the action UUID)

Samples

There are different types of sample (in the directory /sample), written in JavaScript and TypeScript and also a built plugin.

Documentation

You can read the full documentation at https://stream-deck-for-node.netlify.app

TODO

  • Testing on Mac

Changelog

1.0 (12/2021)

An initial sdk version is released

Inspiration

I took my inspiration from streamdeck-tools of BarRaider, but I don't really like C#... so I created a tool to execute on-fly Node.js script through a binary executable or a full node packaged app.

Author

Francesco Saverio Cannizzaro (fcannizzaro)

License

GPL-3.0

sdk's People

Contributors

fcannizzaro avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

sdk's Issues

stream-deck create Not valid

1、npm i -g @stream-deck-for-node/cli
2、stream-deck create but it is not valid stream-deck: command not found

Streamdeck SDK Update

Hi! Thanks a bunch for this node implementation for the streamdeck sdk!

Recently Streamdeck sd had some updates we are interested in. In particular the Streamdeck + with its dial buttons.

Is this something thats on the roadmap for this project?

Thanks again!

How to get the list of plugin's profiles?

Hi! How can I get the list of profiles that the plugin can switch to? Should I manually read manifest.json from inside my plugin or is there a "proper" way to obtain the list of plugin's profiles?

stream-deck create throws error on "Building the project" step

Here's the full output:

D:\Programming>stream-deck create

 [stream-deck] @stream-deck-for-node/cli

? Template JavaScript
? Plugin UUID nl.tyrope.streamdecktest
? Name TestProject
? Description This is a test
? Author Tyrope
? Category Custom
√ Boilerplate generated
√ Node modules installed
- Building the project...node:internal/errors:863
  const err = new Error(message);
              ^

Error: Command failed: npm run build

    at ChildProcess.exithandler (node:child_process:412:12)
    at ChildProcess.emit (node:events:513:28)
    at maybeClose (node:internal/child_process:1091:16)
    at ChildProcess._handle.onexit (node:internal/child_process:302:5) {
  code: 2,
  killed: false,
  signal: null,
  cmd: 'npm run build',
  stdout: '\n' +
    '> [email protected] build\n' +
    '> npx pkg package.json --compress GZip -o plugin/nl.tyrope.streamdecktest.exe\n' +
    '\n' +
    '> [email protected]\n' +
    'compression:  GZip\n' +
    "> Error! Property 'bin' does not exist in\n" +
    '  D:\\Programming\\nl.tyrope.streamdecktest\\package.json\n',
  stderr: ''
}

Node.js v18.12.1

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.