Giter Club home page Giter Club logo

streamdeck's Introduction

StreamDeck

What?

This is a node project that uses the awesome elgato stream deck package by Lange. I added a script that reads a config JSON file to display all the icons configured in it, either by showing an icon that you've premade and put into the src/icons/premade directory, or by generating an icon on the fly with the txt2png package by tkrkt.

Why?

The original Stream Deck software by Elgato is fine, but I wanted more control over what I could do with it. Plus, the Stream Deck is also just a fun toy to play with in your downtime.

How?

Under the src folder you will find an example.json. The structure is pretty basic. You can define what you want to show on your Stream Deck by creating a config.json under the src folder. You either provide an icon file for each display (0.png for example), or you choose to use the fill option and enter some text, a font, colors, fontsize, etc. The third option is use the display as a folder, then you have to provide the displays that are under that folder. Just take a look at the example.json and it will be clear I guess.

After successfully creating the config.json and providing the png files needed in the src/icons/premade folder, you will have to run the project. You can do this by npm run start to run it once or npm run watch if you want to use it while developing.

If you just want to run in the background, you can npm run daemon:start. Stopping it can be done by running npm run daemon:stop. Additionally you can also delete the entire process by using npm run daemon:delete

The daemon uses the PM2 package to do this. If you want the process to persist you can provide a startup script to do this, for more information visit the PM2 docs.

Contributing

I'm open to contributions of course, I just made this in a few hours to play around with my stream deck. The goal is to eventually also create a frontend application so you don't have to edit the config.json manually anymore. But for now it will do.

streamdeck's People

Contributors

ohnoitsfraa avatar

Watchers

 avatar Niels Bekkers 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.