From a3bc9ae8d0492632e6f87726e8fdacbc55045e90 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20L?= Date: Sun, 20 Nov 2016 23:24:47 +0100 Subject: [PATCH] Update README.md --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 098e7116..011428c0 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,16 @@ obs-websocket ============== Websocket API for OBS Studio. -## Build prerequisites -You need QT 5.7 (with QtWebSockets), CMake, and a working development environment for OBS Studio installed on your computer. +## How to use +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). ## How to build -In CMake, you'll need to fill these CMake variables : +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 : - **QTDIR** (path) : location of the Qt environment suited for your compiler and architecture - **LIBOBS_INCLUDE_DIR** (path) : location of the libobs subfolder in the source code of OBS Studio - **LIBOBS_LIB** (filepath) : location of the obs.lib file - **OBS_FRONTEND_LIB** (filepath) : location of the obs-frontend-api.lib file -After building the obs-websocket plugin's binary, copy its Qt dependencies (QtCore, QtNetwork and QtWebSockets library binaries) in the same folder. - -## How to use -There's currently no frontend or language API available for obs-websocket. However, the full protocol reference is documented in the [PROTOCOL.md](PROTOCOL.md) file. -A simple websocket client can connect to the plugin's embedded server. \ No newline at end of file +After building the obs-websocket binary, copy its Qt dependencies (QtCore, QtNetwork and QtWebSockets library binaries) in the same folder.