OBS WayKey

Python script for setting up OBS global keybinds under wayland

ATENTION

This project currently supports setting up start and pause keybinds as well as specifying the WebSocket password. This is currently featureful enought for myself. If there is demand for more hotkeys just submit a enhancement ticket in the bug reports section and I'll add your keybinds right away.

Requirements

• OBS Studio
• OBS Websocket v5 Plugin
  • ATTENTION: For OBS version 28 and above Websocket plugin is included by default. If you run an older version it must be installed manually.
• Python 3.9 or greater

Install and Setup

Install

I recommend installing via pipx

pipx install obs-waykey

If you want a specific version you can grab the .vhl from the releases page and install it with pipx

pipx install <file-name>

Setup

1. Go to your Desktop settings (or WM config file)
2. Go to where you configure keybinds
3. Add a new custom keybind
4. Name it what you want
5. Use the command obs-waykey -t <toggle> -w <your-password>
6. Set your keybind

Here's an example

Toggles

1. toggle-record
2. toggle-record-pause

Build from source

ATTENTION: This project was built with poetry in mind.

1. Clone the repo

git clone https://github.com/PolyCatDev/obs-waykey.git && \
cd obs-waykey

2. Setup enviroment

python3 -m venv .venv && \
source .venv/bin/activate

3. Install dependencies

pip install poetry && \
poetry install

4. Build the package

poetry build

To do

• Add more toggles
• Password Support
• Alternative IP support
• Alternative port support