Skip to content

Latest commit

 

History

History
103 lines (79 loc) · 8.94 KB

README.md

File metadata and controls

103 lines (79 loc) · 8.94 KB

OBS-web

All Contributors

The easiest way to control OBS remotely

Download latest build here

Screenshot:

Screenshot of OBS-web

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
  • 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 v28 or higher - this includes the latest version of the OBS-websocket plugin
  • 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

Build instructions:

npm ci
npm run dev # or: npm run build

Docker:

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

Contributors ✨

Thanks goes to these wonderful people (emoji key):

verstaerker-583
verstaerker-583

💻
crazy4groovy
crazy4groovy

🐛
Isaac Taylor
Isaac Taylor

💻 🤔
darthclide
darthclide

🐛
Rodrigo Graça
Rodrigo Graça

📖
Daniel Feitosa
Daniel Feitosa

💻
Arun Woosaree
Arun Woosaree

💻
Aleksey Pivkin
Aleksey Pivkin

💻 🤔
Nathan Easton
Nathan Easton

💻
Tristan Smith
Tristan Smith

🐛
Filip Hanes
Filip Hanes

💻 🤔 🎨 🐛
TotalInternalReflection
TotalInternalReflection

🐛
Alessio Nossa
Alessio Nossa

🤔
tt2468
tt2468

🤔
donahuetech
donahuetech

💻 🤔
AshwinSatyawan
AshwinSatyawan

📖
ewized
ewized

💻

This project follows the all-contributors specification. Contributions of any kind welcome!