Skip to main content

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

ATTENTION: WebSocket authentication must be disabled for this script to work.

You can find it under Tools > WebSocket Server Settings > Enable Authentication.

  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 <toggle>
  6. Set your keybind

Here's how mine looks

my keybind

Toggles

  1. toggle-rec
  2. toggle-rec-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
  1. Setup enviroment
python3 -m venv .venv && \
source .venv/bin/activate
  1. Install dependencies
pip install poetry && \
poetry install
  1. Build the package
poetry build

To do

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

Project details


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.2.tar.gz (14.3 kB view hashes)

Uploaded Source

Built Distribution

obs_waykey-0.1.2-py3-none-any.whl (15.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page