OBS global shortcuts workaround for wayland using websocket
Project description
OBS WayKey
Python script for setting up OBS global keybinds under wayland
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
- 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
Here's an example
Toggles
toggle-record
toggle-record-pause
Build from source
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
To do
- Add more toggles
- Password Support
- Alternative IP support
- Alternative port support
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
obs_waykey-0.2.0.tar.gz
(14.5 kB
view hashes)
Built Distribution
obs_waykey-0.2.0-py3-none-any.whl
(15.5 kB
view hashes)
Close
Hashes for obs_waykey-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d98d87871c2a97a16a0a945ff934d0ed67197dbc3ab7618ef6353fc010383e6c |
|
MD5 | d204c6fb02231d588ce75885ab480986 |
|
BLAKE2b-256 | aa57450f205ab07b10d628cb24e154aebf268f70fbeb0d5b125ec89588b28f94 |