diff --git a/README.md b/README.md index 011428c0..555137a3 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,11 @@ Websocket API for OBS Studio. The Websocket API server runs on port 4444. A settings window is available in "Websocket server settings" under OBS' "Tools" menu. There's currently no frontend or language API available for obs-websocket. However, the full protocol reference is available in [PROTOCOL.md](PROTOCOL.md). +## Possible use cases +- Remote control OBS from a phone or tablet on the same local network +- Change your stream overlay/graphics based on the current scene (like the AGDQ overlay does) +- Automate scene switching with a third-party program (e.g. : auto-pilot, foot pedal, ...) + ## How to build You'll need QT 5.7 with QtWebSockets, CMake, and a working development environment for OBS Studio installed on your computer. In CMake, you'll have to set the following variables :