https://github.com/vv9k/rkd

Rusty keybinding daemon
https://github.com/vv9k/rkd

Last synced: about 1 month ago
JSON representation

Rusty keybinding daemon

• Host: GitHub
• URL: https://github.com/vv9k/rkd
• Owner: vv9k
• License: mit
• Created: 2020-02-29T15:54:01.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-03-07T17:32:09.000Z (over 4 years ago)
• Last Synced: 2024-06-09T00:35:16.554Z (3 months ago)
• Language: Rust
• Size: 55.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rkd 

Rusty keybinding daemon for linux. ⌨️ 🦀

## USAGE

To use `rkd`:

 - add your user to group input by `sudo usermod -G input -a $your_username`

 - clone this repository with `git clone https://github.com/wojciechkepka/rkd`

 - build with `cargo build --release`

 - copy to `sudo cp target/release/rkd /usr/bin/`

 - run with `rkd $path_to_conf_file`

 - To debug and see some output use `RUST_LOG=trace /usr/bin/rkd $path_to_conf_file`

---

## CONFIG

the config file has a syntax very similar to `sxhkd`:

```

super + 1

	bspc desktop -f ^1

super + 2

	bspc desktop -f ^2

super + 3

	bspc desktop -f ^3

super + q

	bspc node -c

# You can do either this

super + Q

	bspc node -k

# or this

super + shift + q

	bspc node -k

## Audio controls

XF86AudioMute

	pactl set-sink-mute 0 toggle

XF86AudioRaiseVolume

	pactl set-sink-volume 0 +5%

XF86AudioLowerVolume

	pactl set-sink-volume 0 -5%

XF86AudioPlay

	playerctl play

XF86AudioPause

	playerctl pause

XF86AudioNext

	playerctl next

# you can also write it in any case

xf86audioprev

	playerctl prev

```

The first key has to be one of `super`|`shift`|`alt`|`ctrl`. The modifier key can be followed by any amount of other mod keys but to actually execute the keybinding on of `[0-9a-z,./;'\\[\]]` has to be pressed.

---

## LICENSE

[**MIT**](https://github.com/wojciechkepka/rkd/blob/master/LICENSE)