Important Notes
- Only use this release with OBS Studio 27.1.0 or above.
- All plugin components have been finished, however there are some events and requests which have not yet been implemented. See the event and request sheets to find out what has been implemented.
- We've changed a lot about the low-level protocol since first announcing it. If you are developing software and do not know about the changes (like OpCodes), please check it out.
Resources
- The protocol specification is available here
- Breaking changes to the protocol specification performed during the development process are available here
- The planned requests sheet is available here
- The planned events sheet is available here
- To aid developers, I've updated simpleobsws (a client library I maintain) for the latest 5.0.0 protocol spec. This should help with testing and as an implementation example. See the branch here
Install instructions
Windows
- Using the installer (recommended, works only with combined 32/64-bit installations) : download it, launch it and follow the instructions.
- Using the
obs-websocket-5.0.0-alpha1-Windows.ziparchive : copy the contents of the archive to the root of your OBS Studio installation folder (C:\Program Files\obs-studio).
Debian / Ubuntu (64-bit)
Download obs-websocket-5.0.0-alpha1-Ubuntu64.deb (provided below) and install it on your system.
macOS
Sorry, but no binaries are available for macOS right now.