Skip to content

About

OBS Studio Module for Companion

Resources

Contributing

Stars

56 stars

Watchers

9 watching

Forks

Repository files navigation

OBS Studio Connection

Control OBS Studio from Bitfocus Buttons or Bitfocus Companion. Switch scenes, control sources and audio, manage recording and streaming, and send custom WebSocket commands.

Important

This release is a major overhaul focused on performance, stability, and modernized core APIs.

Due to underlying API updates, this version requires the following minimum software releases:

  • OBS Studio: v32.1 or newer
  • Bitfocus Buttons: v1.8.0 or newer
  • Bitfocus Companion: v5.0.0 or newer

Quick start

  1. In OBS Studio, open Tools → WebSocket Server Settings.
  2. Enable the WebSocket server, then choose Show Connect Info.
  3. In Buttons or Companion, add an OBS Studio connection.
  4. Enter the server address, port, and password shown by OBS. The default port is 4455.
  5. Add an OBS action or feedback to a button.

Use a secure WebSocket (wss) only when your OBS WebSocket server or reverse proxy is configured for TLS.

Documentation

Contributing

See CONTRIBUTING.md for setup, checks, pull requests, and the note on AI-assisted work. Coding agents should also read AGENTS.md.

License

Licensed under the MIT License.

About

OBS Studio Module for Companion

Resources

Contributing

Stars

56 stars

Watchers

9 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages