Skip to content
Cezarijus Kivylius edited this page Mar 10, 2024 · 17 revisions

Welcome to the Webdeck wiki!

Here you will find a lot of helpful tip and trick.

image

About

Webdeck was created to fill a void of a multi-platform solution for physical and virtual decks. The goal from the start was to have everything be a plugin. From each button to evidently all USB drivers and and even UI. This mindset should allow us for fast expansion and versatility as the platform grows. Contributing is needed to keep this project alive, so please bring you ideas forward. We are looking forward to seeing what we can create!

Plugins

Plugins are the heart and soul of Webdeck, anyone can create them and the resource above should tell you know to create one. Before you do It would be helpfull to learn about about them

Dependencies

To talk a little about plugin dependencies; We are using react as the fronted framework, module federation (plus some magic) as the plugin system and rsbuild as the bundler for each plugin. While the last two are not that important, react is, as you should start be writing react code. If you never writen any react code, I would recommend to look at some tutorials online, its not very complicated if you understand basic javascript and html/css. React was chosen as its the most popular framework and we believe it fits this purpose well. There nothing stopping from using any other frontend framework like Angular, Svelte or even web-components, however you mileage may very and bundles will be way bigger potentialy.

Documentation

We have already provided the link above for how to get started with template and that a good starting point, if you need to learn more about plugin api, there plenty of documentation on that.

Drivers

We currently only support the following drivers

  • Stream deck
  • Virtual deck

This was a concision decision to get something out to market first, and add other USB drivers support after. As the project grows, we are planing in imp lamenting a system, similar to plugins where contributers can add new drivers for there devices based on a spec file. Watch this space!

Contributing

If you would like to contribute to this application by adding new features or improve existing ones, please checkout the readme.md.

Clone this wiki locally