obs-hotkey-1.0.17 is not a library.

obs-hotkey

A lightweight Rust daemon for controlling OBS Studio with global hotkeys on Wayland and X11.

Works on Wayland! Uses evdev for direct keyboard input capture, bypassing Wayland's security restrictions.

Features

Wayland & X11 Support — works on both display servers
Single Static Binary — no runtime dependencies
Global Hotkeys — works even when OBS is not focused
Auto-start on Login — systemd user service integration
Auto-reconnect — automatically reconnects if OBS restarts
Multi-keyboard — monitors all connected keyboards
F13-F24 Support — use extra keys as stream deck buttons

Quick Start

# 1. Install
cargo install obs-hotkey

# 2. Run once — shows the setup guide
obs-hotkey

# 3. Follow the on-screen steps:
#    - Enable OBS WebSocket Server
#    - Add yourself to the input group
#    - Run: obs-hotkey setup

Installation

From crates.io

cargo install obs-hotkey

From GitHub Releases

# amd64
curl -L https://github.com/DraconDev/obs-wayland-hotkey/releases/latest/download/obs-hotkey-x86_64-unknown-linux-gnu -o obs-hotkey
chmod +x obs-hotkey
sudo cp obs-hotkey /usr/local/bin/

# ARM64
curl -L https://github.com/DraconDev/obs-wayland-hotkey/releases/latest/download/obs-hotkey-aarch64-unknown-linux-gnu -o obs-hotkey
chmod +x obs-hotkey
sudo cp obs-hotkey /usr/local/bin/

From source

git clone https://github.com/DraconDev/obs-wayland-hotkey.git
cd obs-wayland-hotkey
./install.sh    # builds and runs setup

Setup

1. Enable OBS WebSocket Server

Open OBS Studio
Go to Tools → WebSocket Server Settings
Check Enable WebSocket server
Port: 4455 (default)
Authentication: disabled

2. Add yourself to the input group

sudo usermod -aG input $(whoami)
# Log out and back in for changes to take effect

3. Run setup

obs-hotkey setup

This writes the systemd user service and enables it to start on login.

Usage

obs-hotkey              # Show quickstart guide (interactive setup help)
obs-hotkey daemon      # Run the hotkey daemon
obs-hotkey setup        # Install systemd user service
obs-hotkey teardown     # Remove service and binaries
obs-hotkey status       # Check service, config, and OBS connectivity

Global flags

Flag	Description
`--config <path>`	Use a custom config file
`--version`	Show version
`--help`	Show full help

Teardown options

Command	Description
`obs-hotkey teardown`	Stop service, remove service files and binaries
`obs-hotkey teardown --purge`	Above + remove config directory

Default Hotkeys

Key	Action
Scroll Lock	Toggle recording start/stop
Pause	Toggle recording pause/resume

Customizing Hotkeys

Edit ~/.config/obs-hotkey/hotkeys.json:

{
  "obs_host": "ws://localhost:4455",
  "hotkeys": {
    "toggle_recording": "scroll lock",
    "toggle_pause": "pause",
    "toggle_streaming": "",
    "screenshot": "",
    "toggle_mute_mic": "",
    "toggle_studio_mode": "",
    "toggle_replay_buffer": "",
    "save_replay": ""
  },
  "screenshot_source": "",
  "screenshot_dir": "~/Pictures",
  "mic_name": ""
}

Supported Keys

Function keys: f1 – f24
Special keys: scroll lock, pause, home, end, page up, page down, insert, delete

Available Actions

Action	OBS Request	Notes
`toggle_recording`	`ToggleRecord`	Start/stop recording
`toggle_pause`	`ToggleRecordPause`	Pause/resume recording
`toggle_streaming`	`ToggleStream`	Start/stop streaming
`screenshot`	`SaveSourceScreenshot`	Saves PNG to `screenshot_dir`
`toggle_mute_mic`	`ToggleInputMute`	Requires `mic_name` in config
`toggle_studio_mode`	`SetStudioModeEnabled`	Toggles studio mode
`toggle_replay_buffer`	`ToggleReplayBuffer`	Requires replay buffer enabled
`save_replay`	`SaveReplayBuffer`	Saves current replay buffer

Managing the Service

# Check status
systemctl --user status obs-hotkey.service

# View live logs
journalctl --user -u obs-hotkey.service -f

# Restart (after config changes)
systemctl --user restart obs-hotkey.service

# Stop
systemctl --user stop obs-hotkey.service

Building

# Build release binary
cargo build --release

# Cross-compile for ARM64
rustup target add aarch64-unknown-linux-gnu
cargo build --release --target aarch64-unknown-linux-gnu

Requirements

Linux (Wayland or X11)
OBS Studio 28+ with WebSocket enabled
Membership in the input group

Uninstall

# Stop service and remove everything
obs-hotkey teardown --purge

License

MIT

obs-hotkey 1.0.17