Skip to content

Commit

Permalink
Add widget documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
muesli committed Jun 2, 2021
1 parent 3e90f69 commit cbf0bed
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ 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:
Expand Down Expand Up @@ -106,6 +107,65 @@ systemctl --user start streamdeck.path
You can find a few example configurations in the [decks](https://github.com/muesli/deckmaster/tree/master/decks)
directory. Edit them to your needs!

### Widgets

#### Button

A simple button that can display an image and/or a label.

```
[keys.widget]
id = "button"
[keys.widget.config]
icon = "/some/image.png"
label = "My Button"
```

#### Recent Window (requires X11)

Displays the icon of a recently used window/application. Pressing the button
activates the window.

```
[keys.widget]
id = "recentWindow"
[keys.widget.config]
window = "1"
```

#### Time

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"
```

#### Top

This widget shows the current CPU or memory utilization as a bar graph.

```
[keys.widget]
id = "top"
[keys.widget.config]
mode = "cpu"
fillColor = "#d497de"
```

### Background Image

You can configure each deck to display an individual wallpaper behind its
widgets:

```
background = "/some/image.png"
```

## Usage

Start `deckmaster`:
Expand Down

0 comments on commit cbf0bed

Please sign in to comment.