Installation

Deckster is normally installed with pip.

pip install deckster-sd

Install dependencies and add permissions:

# Install system packages needed for the default LibUSB HIDAPI backend
sudo apt install -y libudev-dev libusb-1.0-0-dev libhidapi-libusb0

# Install system packages needed for the Python Pillow package installation
sudo apt install -y libjpeg-dev zlib1g-dev libopenjp2-7 libtiff5

# Add udev rule to allow all users non-root access to Elgato StreamDeck devices:
sudo tee /etc/udev/rules.d/10-streamdeck.rules << EOF
    SUBSYSTEMS=="usb", ATTRS{idVendor}=="0fd9", GROUP="users", TAG+="uaccess"
    EOF

# Reload udev rules to ensure the new permissions take effect
    sudo udevadm control --reload-rules

The install process will create a default config.json to your /home/.config/deckster folder.

{
  "icons_dir": "~/deckster/icons",
  "plugins_dir": "~/deckster/deckster-plugins",
  "generators_dir": "~/deckster/generators",
  "current_page": 1,
  "keys_dir": "~/deckster/keys.d",
  "loglevel": "info",
  "brightness": 100
}

Configuration	Description	Default	Values
icons_dir	The directory where the icons are located	~/deckster/icons	A directory
plugins_dir	The directory where your custom plugins are installed	~/deckster/deckster-plugins	A directory
current_page	The page to display. You should not have to manually change this	1	integer > 1
keys_dir	The directory where your key configurations are stored	~/deckster/keys.d	A directory
loglevel	The log level to output	info	debug, info, warning, error, critical
brightness	The global brightness of your deck	100	integer between 1-100
generators_dir	The directory where your custom generators	~/deckster/generators	A directory
generators	Generator configurations array	[]	An array of configuration. See generators

Service

You can have deckster run as a service by using the service file in the repository. Run:

mkdir -p $HOME/.local/share/systemd/user
cp deckster.service $HOME/.local/share/systemd/user
systemctl --user daemon-reload
systemctl --user enable 
systemctl --user start deckster