OBS global shortcuts workaround for wayland sing 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 ATTENTION: This package is currently not up on pypi so this command won't work
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
ATTENTION: WebScoket authentication must be disabled for this script to work.
You can find it under Tools > WebScoket Server Settings > Enable Authentication
.
- Go to your Desktop settings (or WM config file)
- Go to where you configure keybinds
- Add a new custom keybind
- Name it what u want
- Use the command
obs-waykey <toggle>
- Set ur keybind
Here's how mine looks
Toggles
toggle-rec
toggle-rec-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.1.0.tar.gz
(14.3 kB
view hashes)
Built Distribution
obs_waykey-0.1.0-py3-none-any.whl
(15.3 kB
view hashes)
Close
Hashes for obs_waykey-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 18b31d95c6c093b4f3cc07654786c01eccdce606d5a7656b734d4198dfeb0cf4 |
|
MD5 | e922df13f2c979743668883eca01541c |
|
BLAKE2b-256 | 5323b9482b6f2090bf2330989ba24c1a5528214ef564f38368d2fad3d546d514 |