https://github.com/Niek/obs-web

OBS-web - the easiest way to control OBS remotely
https://github.com/Niek/obs-web

hacktoberfest obs obs-studio obs-websocket obs-websocket-js openbroadcaster openbroadcastersoftware svelte

Last synced: 5 days ago
JSON representation

OBS-web - the easiest way to control OBS remotely

• Host: GitHub
• URL: https://github.com/Niek/obs-web
• Owner: Niek
• License: gpl-3.0
• Created: 2020-06-10T10:42:28.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-10-28T00:36:19.000Z (8 days ago)
• Last Synced: 2024-10-29T15:17:44.309Z (7 days ago)
• Topics: hacktoberfest, obs, obs-studio, obs-websocket, obs-websocket-js, openbroadcaster, openbroadcastersoftware, svelte
• Language: Svelte
• Homepage: http://obs-web.niek.tv
• Size: 2.78 MB
• Stars: 1,154
• Watchers: 25
• Forks: 135
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - obs-web - web - the easiest way to control OBS remotely | Niek | 577 | (Svelte)

README

        
# OBS-web

[![All Contributors](https://img.shields.io/badge/all_contributors-18-orange.svg?style=flat-square)](#contributors-)

#### The easiest way to control [OBS](https://obsproject.com/) remotely

### **URL: http://obs-web.niek.tv/**

###### Download latest build [here](https://github.com/Niek/obs-web/archive/gh-pages.zip)

---

#### Screenshot:

![Screenshot of OBS-web](.github/screenshot.png)

#### Features:

- No installation or extra software is needed, works in any modern browser (desktop + mobile)

- Support for local network and internet control through [WSS tunnels](https://github.com/obsproject/obs-websocket/blob/4.x-compat/SSL-TUNNELLING.md)

- Easily switch scenes and start/stop streaming and recording

- Support for Studio Mode (preview and program scenes)

- Support for Virtual Camera

- Live view of preview & output, updating 1 fps

- Fullscreen button and wakelock support (keeps the screen on)

- Replay Buffer button

- Easy bookmarking/deeplink by specifying host in URL

- Profile switching support

- Scene Collections switching support

- Custom transition support

- Extra features:

  - Hide scenes that have `(hidden)` in their name

  - Switch sources in scenes with `(switch)` in their name visually by thumbnails

---

#### Requirements:

- [OBS](https://obsproject.com/) v28 or higher - this includes the latest version of the OBS-websocket plugin

  - OBS v27 is also supported, by manually installing the [OBS-websocket v5](https://github.com/obsproject/obs-websocket/releases/latest) plugin

  - For older OBS versions, use the [OBS-websocket v4](https://github.com/obsproject/obs-websocket/releases/tag/4.9.1-compat) plugin and [OBS-web v4](http://obs-web.niek.tv/v4/) (no longer maintained)

- Enabling the OBS-websocket server in OBS under `Tools -> obs-websocket Settings -> Enable WebSocket Server`

- Optionally: a tunnel service if you want to control OBS outside your local network, [see these instructions](https://github.com/obsproject/obs-websocket/blob/4.x-compat/SSL-TUNNELLING.md)

---

#### Build instructions:

```bash

npm ci

npm run dev # or: npm run build

```

#### Docker:

```bash

docker run --rm -p5000:5000 ghcr.io/niek/obs-web

```

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
verstaerker-583
💻

      
crazy4groovy
🐛

      
Isaac Taylor
💻 🤔

      
darthclide
🐛

      
Rodrigo Graça
📖

      
Daniel Feitosa
💻

      
Arun Woosaree
💻

    

    

      
Aleksey Pivkin
💻 🤔

      
Nathan Easton
💻

      
Tristan Smith
🐛

      
Filip Hanes
💻 🤔 🎨 🐛

      
TotalInternalReflection
🐛

      
Alessio Nossa
🤔

      
tt2468
🤔

    

    

      
donahuetech
💻 🤔

      
AshwinSatyawan
📖

      
ewized
💻

      
bzip22
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!