{"id":13561050,"url":"https://github.com/rbuckton/obs-remote","last_synced_at":"2025-07-12T23:34:45.602Z","repository":{"id":38355183,"uuid":"354674628","full_name":"rbuckton/obs-remote","owner":"rbuckton","description":"A touch-friendly desktop application designed for tablets that can be used to control OBS Studio remotely using 'obs-websocket'","archived":false,"fork":false,"pushed_at":"2022-09-15T07:37:56.000Z","size":2806,"stargazers_count":39,"open_issues_count":17,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-19T18:13:01.281Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/rbuckton.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["rbuckton"]}},"created_at":"2021-04-05T00:21:13.000Z","updated_at":"2025-04-08T14:36:09.000Z","dependencies_parsed_at":"2022-08-09T09:15:45.285Z","dependency_job_id":null,"html_url":"https://github.com/rbuckton/obs-remote","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/rbuckton/obs-remote","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rbuckton%2Fobs-remote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rbuckton%2Fobs-remote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rbuckton%2Fobs-remote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rbuckton%2Fobs-remote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rbuckton","download_url":"https://codeload.github.com/rbuckton/obs-remote/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rbuckton%2Fobs-remote/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265068720,"owners_count":23706517,"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","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":[],"created_at":"2024-08-01T13:00:52.022Z","updated_at":"2025-07-12T23:34:45.586Z","avatar_url":"https://github.com/rbuckton.png","language":"TypeScript","readme":"# obs-remote\r\n\r\nA touch-friendly desktop application designed for tablets that can be used to control OBS Studio remotely using `obs-websocket`.\r\n\r\n[![nightly](https://github.com/rbuckton/obs-remote/actions/workflows/nightly.yml/badge.svg)](https://github.com/rbuckton/obs-remote/actions/workflows/nightly.yml)\r\n\r\n# Installation\r\n\r\n## Prerequisites\r\n\r\n### Installing the `obs-websocket` Plugin\r\n\r\nBefore you can use `obs-remote`, you first need to install the `obs-websocket` plugin for OBS Studio on the machine running OBS:\r\n\r\n- \u003chttps://github.com/Palakis/obs-websocket#downloads\u003e\r\n\r\n`obs-remote` requires a version of `obs-websocket` between 4.8.0 and 4.9.1. \r\n\r\n### Setting a Password for `obs-websocket`\r\n\r\nIt is recommended that you set a password for `obs-websocket` in OBS Studio:\r\n\r\n1. In the OBS Studio menu, click `Tools \u003e Websocket server settings`.\r\n2. Enable authentication and set a password.\r\n   - NOTE: You will need this password when connecting via `obs-remote` later.\r\n\r\n## Downloading `obs-remote`\r\n\r\nYou can find the latest version of `obs-remote` in the [Releases](https://github.com/rbuckton/obs-remote/releases) tab.\r\n\r\n\u003e NOTE: The `nightly` release is the most recent, but least stable release. It is generated each night from the latest sources in `main`.\r\n\r\n\u003e NOTE: Releases aren't currently signed. I'm working on that...\r\n\r\n# Usage\r\n\r\n## Connecting to OBS Studio\r\n\r\nThe first time you start `obs-remote`, you'll be presented with the connection screen:\r\n\r\n![Connect to OBS Studio](docs/connect.png)\r\n\r\n1. Provide the following options:\r\n   - **Hostname** \u0026mdash; The machine name, host name, or IP address of the computer running OBS Studio and `obs-websocket`.\r\n   - **Port** \u0026mdash; The port number for `obs-websocket` (see `Tools \u003e Websocket server settings` in OBS Studio).\r\n   - **Auth Key** \u0026mdash; The password for `obs-websocket` (see `Tools \u003e Websocket server settings` in OBS Studio). Leave blank if authentication is disabled.\r\n     - WARNING: The password is stored in plain text on the machine running `obs-remote`.\r\n   - **Automatically Connect** \u0026mdash; Automatically connect to the remote machine on startup.\r\n2. Click `CONNECT` to connect to the remote OBS Studio instance.\r\n   - NOTE: OBS Studio must already be running on the remote machine.\r\n\r\n\u003e NOTE: You can use the `DEMO` button to try out the dashboard without connecting to OBS.\r\n\r\n## Dashboard\r\n\r\nOnce connected you can manage OBS Studio remotely from the dashboard:\r\n\r\n![Dashboard](docs/dashboard.png)\r\n\r\nThe Dashboard is broken down into 4 main sections:\r\n\r\n- Menu and Tools\r\n- Stream/Recording Manager\r\n- Scene Switcher\r\n- Audio Source Controls\r\n\r\n### Menu and Tools\r\n\r\n![Menu and Tools](docs/menu-tools.png)\r\n\r\nThe Menu and Tools app bar can be used to control the following behaviors:\r\n\r\n- Open the Menu to view connection information or disconnect\r\n- Enter or exit \"Visibility Editor\" mode\r\n- Switch between Light and Dark mode\r\n- Enter or exit Fullscreen mode\r\n  - NOTE: When in Fullscreen mode, the application will prevent the system from going to sleep.\r\n\r\n### Stream/Recording Manager\r\n\r\n![Stream/Recording Manager](docs/stream-recording-manager.png)\r\n\r\nThe Stream/Recording Manager bar gives you quick access to:\r\n\r\n- Start or stop a live stream\r\n- Start, stop, or pause a recording\r\n- Start, stop, and save the replay buffer\r\n\r\n### Scene Switcher\r\n\r\n![Scene Switcher](docs/scene-switcher.png)\r\n\r\nThe scene switcher gives you a preview of your available scenes in OBS and allows you to quickly switch between scenes.\r\n\r\n#### \"Visibility Editor\" mode\r\n\r\nWhen in the \"Visibility Editor\" mode, scenes will be tagged with whether they are visible or hidden from `obs-remote`. Clicking a Scene will change its visibility state:\r\n\r\n![Scene Switcher in \"Visiblity Editor\" mode](docs/scene-switcher-visibility-editor.png)\r\n\r\n\u003e NOTE: The visiblity state of a Scene is stored in the scene settings in OBS Studio, but does not affect the visibility of the scene in OBS Studio itself, only in `obs-remote`.\r\n\r\n### Audio Source Controls\r\n\r\n![Audio Source Controls](docs/audio-source-controls.png)\r\n\r\nThe Audio Source Controls bar gives you quick access to mute/unmute all of audio sources in OBS Studio.\r\n\r\n#### \"Visibility Editor\" mode\r\n\r\nWhen in the \"Visibility Editor\" mode, audio sources will be tagged with whether they are visible or hidden from `obs-remote`. Clicking an Audio Source will change its visibility state:\r\n\r\n![Audio Source Controls in \"Visiblity Editor\" mode](docs/audio-source-controls-visibility-editor.png)\r\n\r\n\u003e NOTE: The visiblity state of a Scene is stored in the scene settings in OBS Studio, but does not affect the visibility of the scene in OBS Studio itself, only in `obs-remote`.\r\n\r\n# Building `obs-remote`\r\n\r\n`obs-remote` is built using NodeJS and Electron. To build and launch `obs-remote`, perform the following in a command shell:\r\n\r\n```\r\ngit clone https://github.com/rbuckton/obs-remote.git\r\ncd obs-remote\r\nnpm install\r\nnpm run start\r\n```\r\n\r\nFor more information about how `obs-remote` is structured, see [src/README.md](src/README.md).\r\n\r\n# Sponsors\r\n\r\nIf you would like your name or logo listed here, you can sponsor this work via [GitHub Sponsors](https://github.com/sponsors/rbuckton).\r\n\r\n# License\r\n\r\n`obs-remote` is published under the [MIT License](LICENSE).","funding_links":["https://github.com/sponsors/rbuckton"],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frbuckton%2Fobs-remote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frbuckton%2Fobs-remote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frbuckton%2Fobs-remote/lists"}