Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document deck switching #63

Merged
merged 2 commits into from
Feb 5, 2022
Merged

Document deck switching #63

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5751313
Document deck switching. Minor formatting tweaks to special words
marcusramberg Jan 23, 2022
fe03254
Clean up README changes
muesli Feb 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ An application to control your Elgato Stream Deck on Linux
### From source

Make sure you have a working Go environment (Go 1.16 or higher is required).
See the [install instructions](https://golang.org/doc/install.html).
See the [installation instructions](https://golang.org/doc/install.html).

To install deckmaster, simply run:

Expand All @@ -48,7 +48,7 @@ To install deckmaster, simply run:

## System Setup

On Linux you need to set up some udev rules to be able to access the device as a
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:

```
Expand All @@ -60,7 +60,7 @@ SUBSYSTEM=="usb", ATTRS{idVendor}=="0fd9", ATTRS{idProduct}=="006c", MODE:="666"
```

Make sure your user is part of the `plugdev` group and reload the rules with
`sudo udevadm control --reload-rules`. Unplug and replug the device and you
`sudo udevadm control --reload-rules`. Unplug and re-plug the device, and you
should be good to go.

### Starting deckmaster automatically
Expand Down Expand Up @@ -285,6 +285,13 @@ background = "/some/image.png"

You can hook up any key with several actions:

#### Switch deck

```toml
[keys.action]
deck= "another.deck"
```

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

#### Run a command

```toml
Expand All @@ -306,7 +313,7 @@ Emulate a series of key-presses with delay in between:
keycode = "Leftctrl-X+500 / Leftctrl-V / Num1"
```

A list of available keycodes can be found here: [keycodes](https://github.com/muesli/deckmaster/blob/master/keycodes.go)
A list of available `keycodes` can be found here: [keycodes](https://github.com/muesli/deckmaster/blob/master/keycodes.go)

#### Paste to clipboard

Expand Down