{"id":34692551,"url":"https://github.com/polycatdev/obs-waykey","last_synced_at":"2025-12-24T22:01:39.078Z","repository":{"id":239333459,"uuid":"799224541","full_name":"PolyCatDev/obs-waykey","owner":"PolyCatDev","description":"Python script for OBS global keybinds under Wayland","archived":false,"fork":false,"pushed_at":"2024-08-01T12:36:13.000Z","size":79,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-21T23:59:00.171Z","etag":null,"topics":["cli-app","global-keybindings","linux","obs-studio-script","wayland"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PolyCatDev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-11T14:01:54.000Z","updated_at":"2025-01-30T10:17:58.000Z","dependencies_parsed_at":"2024-05-11T16:28:17.231Z","dependency_job_id":"123d1e55-3c27-48bd-862f-78d856a7ca39","html_url":"https://github.com/PolyCatDev/obs-waykey","commit_stats":null,"previous_names":["polycatdev/obs-waykey"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/PolyCatDev/obs-waykey","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolyCatDev%2Fobs-waykey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolyCatDev%2Fobs-waykey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolyCatDev%2Fobs-waykey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolyCatDev%2Fobs-waykey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PolyCatDev","download_url":"https://codeload.github.com/PolyCatDev/obs-waykey/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PolyCatDev%2Fobs-waykey/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28010324,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-24T02:00:07.193Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli-app","global-keybindings","linux","obs-studio-script","wayland"],"created_at":"2025-12-24T22:01:35.435Z","updated_at":"2025-12-24T22:01:39.073Z","avatar_url":"https://github.com/PolyCatDev.png","language":"Python","readme":"# OBS WayKey\n\nPython script for setting up OBS global keybinds under wayland\n\n## ATENTION\nThis project currently supports setting up start and pause keybinds as well as specifying the WebSocket password.\nThis is currently featureful enought for myself.\nIf there is demand for more hotkeys just submit a enhancement ticket in the bug reports section and I'll add your keybinds right away.\n\n## Requirements\n\n- [OBS Studio](https://obsproject.com/)\n- [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0)\n  - ATTENTION: For OBS version 28 and above Websocket plugin is included by default. If you run an older version it must be installed manually.\n- Python 3.9 or greater\n\n# Install and Setup\n\n## Install\n\nI recommend installing via [pipx](https://github.com/pypa/pipx)\n\n```\npipx install obs-waykey\n```\n\nIf 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\n\n```\npipx install \u003cfile-name\u003e\n```\n\n## Setup\n\n1. Go to your Desktop settings (or WM config file)\n2. Go to where you configure keybinds\n3. Add a new custom keybind\n4. Name it what you want\n5. Use the command `obs-waykey -t \u003ctoggle\u003e -w \u003cyour-password\u003e`\n6. Set your keybind\n\n### Here's an example\n\n![my keybind](https://github.com/PolyCatDev/obs-waykey/blob/main/.github/toggle-rec-config.png)\n\n## Toggles\n\n1. `toggle-record`\n2. `toggle-record-pause`\n\n# Build from source\n\nATTENTION: This project was built with [poetry](https://python-poetry.org/) in mind.\n\n1. Clone the repo\n\n```\ngit clone https://github.com/PolyCatDev/obs-waykey.git \u0026\u0026 \\\ncd obs-waykey\n```\n\n2. Setup enviroment\n\n```\npython3 -m venv .venv \u0026\u0026 \\\nsource .venv/bin/activate\n```\n\n3. Install dependencies\n\n```\npip install poetry \u0026\u0026 \\\npoetry install\n```\n\n4. Build the package\n\n```\npoetry build\n```\n\n# To do\n\n- [ ] Add more toggles\n- [x] Password Support\n- [ ] Alternative IP support\n- [ ] Alternative port support\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolycatdev%2Fobs-waykey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpolycatdev%2Fobs-waykey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpolycatdev%2Fobs-waykey/lists"}