Python script for setting up OBS global keybinds under wayland
- 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
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>
- Go to your Desktop settings (or WM config file)
- Go to where you configure keybinds
- Add a new custom keybind
- Name it what you want
- Use the command
obs-waykey -t <toggle> -w <your-password>
- Set your keybind
toggle-record
toggle-record-pause
ATTENTION: This project was built with poetry in mind.
- Clone the repo
git clone https://github.com/PolyCatDev/obs-waykey.git && \
cd obs-waykey
- Setup enviroment
python3 -m venv .venv && \
source .venv/bin/activate
- Install dependencies
pip install poetry && \
poetry install
- Build the package
poetry build
- Add more toggles
- Password Support
- Alternative IP support
- Alternative port support