An application to control your Elgato Stream Deck on Linux
- Multiple pages & navigation between decks
- Buttons (icons & text)
- Background images
- Brightness control
- Supports different actions for short & long presses
- Comes with a collection of widgets:
- Buttons
- Time (with formatting)
- CPU/Mem usage
- Weather
- Command output
- Recently used windows (X11-only)
- Lets you trigger several actions:
- Run commands
- Emulate a key-press
- Paste to clipboard
- Trigger a dbus call
- Arch Linux: deckmaster
- Packages in Alpine, Debian & RPM formats
- Binaries for various architectures
Make sure you have a working Go environment (Go 1.17 or higher is required). See the install instructions.
To install deckmaster, simply run:
git clone https://github.com/muesli/deckmaster.git
cd deckmaster
go build
On Linux you need to set up some udev rules to be able to access the device as
a regular user. Edit /etc/udev/rules.d/99-streamdeck.rules and add these lines:
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0060", MODE:="666", GROUP="plugdev", SYMLINK+="streamdeck"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="006d", MODE:="666", GROUP="plugdev", SYMLINK+="streamdeck"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0080", MODE:="666", GROUP="plugdev", SYMLINK+="streamdeck"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="0063", MODE:="666", GROUP="plugdev", SYMLINK+="streamdeck-mini"
SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="006c", MODE:="666", GROUP="plugdev", SYMLINK+="streamdeck-xl"
Make sure your user is part of the plugdev group and reload the rules with
sudo udevadm control --reload-rules. Unplug and re-plug the device, and you
should be good to go.
If you want deckmaster to be started automatically upon device plugin, you can
use systemd path activation, adding streamdeck.path and streamdeck.service
files to $HOME/.config/systemd/user.
streamdeck.path contents:
[Unit]
Description="Stream Deck Device Path"
[Path]
# the device name will be different if you use streamdeck-mini or streamdeck-xl
PathExists=/dev/streamdeck
Unit=streamdeck.service
[Install]
WantedBy=multi-user.targetstreamdeck.service contents:
[Unit]
Description=Deckmaster Service
[Service]
# adjust the path to deckmaster and .deck file to suit your needs
ExecStart=/usr/local/bin/deckmaster --deck path-to/some.deck
Restart=on-failure
ExecReload=kill -HUP $MAINPID
[Install]
WantedBy=default.targetThen enable and start the streamdeck.path unit:
systemctl --user enable streamdeck.path
systemctl --user start streamdeck.pathStart deckmaster with the initial deck configuration you want to load:
deckmaster -deck deck/main.deckYou can control the brightness, in percent:
deckmaster -brightness 50Control a specific streamdeck:
deckmaster -device [serial number]Set a sleep timeout after which the screen gets turned off:
deckmaster -sleep 10mYou can find a few example configurations in the decks directory. Edit them to your needs!
Any widget is build up the following way:
[[keys]]
index = 0index needs to be present in every widget and describes the position of the
widget on the streamdeck. index is 0-indexed and counted from top to bottom
and left to right.
Optionally, you can configure an update interval for each widget:
[keys.widget]
id = "button"
interval = 500 # optionalThe attribute interval defines the time in ms between two consecutive
updates of a widget.
A simple button that can display an image and/or a label.
[keys.widget]
id = "button"
[keys.widget.config]
icon = "/some/image.png" # optional
label = "My Button" # optional
fontsize = 10.0 # optional
color = "#fefefe" # optional
flatten = true # optionalIf flatten is true all opaque pixels of the icon will have the color color.
Displays the icon of a recently used window/application. Pressing the button activates the window.
[keys.widget]
id = "recentWindow"
[keys.widget.config]
window = 1
showTitle = true # optionalIf showTitle is true, the title of the window will be displayed below the
window icon.
A flexible widget that can display the current time or date.
[keys.widget]
id = "time"
[keys.widget.config]
format = "%H;%i;%s"
font = "bold;regular;thin" # optional
color = "#fefefe" # optional
layout = "0x0+72x24;0x24+72x24;0x48+72x24" # optionalWith layout custom layouts can be definded in the format [posX]x[posY]+[width]x[height].
Values for format are:
| % | gets replaced with |
|---|---|
| %Y | A full numeric representation of a year, 4 digits |
| %y | A two digit representation of a year |
| %F | A full textual representation of a month, such as January or March |
| %M | A short textual representation of a month, three letters |
| %m | Numeric representation of a month, with leading zeros |
| %l | A full textual representation of the day of the week |
| %D | A textual representation of a day, three letters |
| %d | Day of the month, 2 digits with leading zeros |
| %h | 12-hour format of an hour with leading zeros |
| %H | 24-hour format of an hour with leading zeros |
| %i | Minutes with leading zeros |
| %s | Seconds with leading zeros |
| %a | Lowercase Ante meridiem and Post meridiem |
| %t | Timezone abbreviation |
This widget shows the current CPU or memory utilization as a bar graph.
[keys.widget]
id = "top"
[keys.widget.config]
mode = "cpu"
color = "#fefefe" # optional
fillColor = "#d497de" # optionalThere are two values for mode: cpu and memory.
A widget that displays the output of commands.
[keys.widget]
id = "command"
[keys.widget.config]
command = "echo 'Files:'; ls -a ~ | wc -l"
font = "regular;bold" # optional
color = "#fefefe" # optional
layout = "0x0+72x20;0x20+72x52" # optionalA widget that displays the weather condition and temperature.
[keys.widget]
id = "weather"
[keys.widget.config]
location = "MyCity" # optional
unit = "celsius" # optional
color = "#fefefe" # optional
flatten = true # optional
theme = "openmoji" # optionalThe supported location types can be found here. The unit
has to be either celsius or fahrenheit. If flatten is true all opaque
pixels of the condition icon will have the color color. In case theme is set
corresponding icons with correct names need to be placed in
~/.local/share/deckmaster/themes/[theme]. The default icons with their
respective names can be found here.
You can hook up any key with several actions. A regular keypress will trigger
the widget's configured keys.action, while holding the key will trigger
keys.action_hold.
[keys.action]
deck = "relative/path/to/another.deck"[keys.action]
exec = "some_command --with-parameters"[keys.action]
keycode = "Leftctrl-C"Emulate a series of key-presses with delay in between:
[keys.action]
keycode = "Leftctrl-X+500 / Leftctrl-V / Num1"A list of available keycodes can be found here: keycodes
[keys.action]
paste = "some text"[keys.action]
[dbus]
object = "object"
path = "path"
method = "method"
value = "value"Increase the brightness. If no value is specified, it will be increased by 10%:
[keys.action]
device = "brightness+5"Decrease the brightness. If no value is specified, it will be decreased by 10%:
[keys.action]
device = "brightness-5"Set the brightness to a specific value between 0 and 100:
[keys.action]
device = "brightness=50"Put the device into sleep mode, blanking the screen until the next key gets pressed:
[keys.action]
device = "sleep"You can configure each deck to display an individual wallpaper behind its widgets:
background = "/some/image.png"If you specify a parent inside a deck's configuration, it will inherit all
of the parent's settings that are not overwritten by the deck's own settings.
This even works recursively:
parent = "another.deck"- deckmaster-emojis, an Emoji keyboard deck
- deckmaster-helldivers2, a deck for calling down Helldivers 2 game stratagems
Made your own useful decks? Submit a pull request!
Got some feedback or suggestions? Please open an issue or drop me a note!
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent