https://github.com/polycatdev/obs-waykey
Python script for OBS global keybinds under Wayland
https://github.com/polycatdev/obs-waykey
cli-app global-keybindings linux obs-studio-script wayland
Last synced: 5 days ago
JSON representation
Python script for OBS global keybinds under Wayland
- Host: GitHub
- URL: https://github.com/polycatdev/obs-waykey
- Owner: PolyCatDev
- License: mit
- Created: 2024-05-11T14:01:54.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-01T12:36:13.000Z (over 1 year ago)
- Last Synced: 2025-09-21T23:59:00.171Z (3 months ago)
- Topics: cli-app, global-keybindings, linux, obs-studio-script, wayland
- Language: Python
- Homepage:
- Size: 77.1 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://obsproject.com/)
- [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0)
- 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](https://github.com/pypa/pipx)
```
pipx install obs-waykey
```
If you want a specific version you can grab the `.vhl` from the [releases page](https://github.com/PolyCatDev/obs-waykey/releases) and install it with pipx
```
pipx install
```
## 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 -w `
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](https://python-poetry.org/) 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
- [x] Password Support
- [ ] Alternative IP support
- [ ] Alternative port support