Git Product home page Git Product logo

streamdeck-test's Introduction

streamdeck-test

Test repository to test out Elgato Stream Deck development. This is mostly just to learn how to do it better in actual applications.

Setup

There's two components to this, a Node server and the plugin. Both must be configured before it'll work.

Node

The plugin requires a server running on 127.0.0.1:3000 to show anything.

  1. Install Node.js 10 or newer. I'm running this on v14.3.0, but it really doesn't matter too much.
  2. Install Yarn package manager system-wide by running npm install -g yarn or by following the instructions on the Yarn site. Note that while this project uses Yarn 2, so long as you have Yarn 1.22 or above installed you should be good.
  3. cd into the node directory and install the requisite dependencies by running yarn install
  4. Run the application by running yarn start or yarn node build/index.js. NOTE: You cannot use node start or node build/index.js, as this requires the Yarn 2 PnP shim to function, which does not get loaded by default in the standard Node runtime.

To edit the server application, follow the instructions here to enable type hinting for your particular editor of choice, then modify as you wish in src. To compile the code, run yarn build.

Plugin

Since I kinda just bootstrapped this off of the Counter sample code, it's not really organized, but it does sorta work. To edit:

  1. Install the TypeScript compiler system wide by running npm install -g typescript.
  2. cd into the plugin directory.
  3. Edit the code in src\com.theapplefreak.server-count.sdPlugin\test.ts, then run tsc src\com.theapplefreak.server-count.sdPlugin\test.ts to compile. Alternatively, just edit the compiled code in src\com.theapplefreak.server-count.sdPlugin/test.js directly.
  4. Run .\DistributionTool.exe -b -i src/com.theapplefreak.server-count.sdPlugin -o Release to compile the plugin.
  5. Install the plugin by double clicking the output file in the Releases folder and following the instructions on screen. The counter should begin incrementing once the plugin is dragged onto an empty Stream Deck square.

streamdeck-test's People

Contributors

theapplefreak avatar

Watchers

 avatar

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.