Skip to content

Commit a17bd87

Browse files
Update README.md
1 parent ad71251 commit a17bd87

File tree

1 file changed

+46
-3
lines changed

1 file changed

+46
-3
lines changed

README.md

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22

33
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
44
[![C Standard](https://img.shields.io/badge/C-11-blue.svg)]()
5-
[![Version](https://img.shields.io/badge/version-1.0.0-brightgreen.svg)]()
6-
[![Build macOS](https://img.shields.io/badge/Build-Passing-green)](https://img.shields.io/badge/Build-Passing-green)
5+
[![Version](https://img.shields.io/badge/version-1.1.0-brightgreen.svg)]()
6+
[![Build macOS](https://img.shields.io/badge/macOS_Build-Passing-green)](https://img.shields.io/badge/macOS_Build-Passing-green)
7+
[![Build macOS](https://img.shields.io/badge/Debian_Build-Passing-green)](https://img.shields.io/badge/Debian_Build-Passing-green)
8+
[![Build macOS](https://img.shields.io/badge/Windows_Build-N/A-red)](https://img.shields.io/badge/Windows_Build-N/A-red)
79

810
A high-performance C library for communicating with OBS Studio via the WebSocket v5 protocol. Designed for streaming professionals, developers, and automation systems that need reliable control over OBS instances.
911

@@ -19,6 +21,47 @@ A high-performance C library for communicating with OBS Studio via the WebSocket
1921
- **Error Handling** - Comprehensive error codes and detailed status reporting
2022
- **No External Dependencies** - Uses standard C libraries (libwebsockets, OpenSSL, cJSON)
2123

24+
---
25+
## Why libwsv5?
26+
27+
**The fastest, most reliable OBS WebSocket v5 client for C/C++ applications.**
28+
29+
- **Zero-copy design** - Direct memory mapping, no Python/JS overhead
30+
- **Production-tested** - Powers [ROCStreamer/Matt's Outback Paintball] serving 150+ users
31+
- **Full protocol support** - 50+ OBS commands, all v5 features
32+
- **Thread-safe** - Manage multiple OBS instances concurrently
33+
- **Auto-reconnect** - Survives network hiccups and OBS crashes
34+
- **Multi-Platform Support** - Currently Supports macOS and Linux natively with Windows support planned.
35+
36+
### Use Cases
37+
- **Broadcast automation** - Trigger scene changes from external events
38+
- **Stream directors** - Multi-camera switching applications
39+
- **Recording managers** - Automated recording start/stop systems
40+
- **Monitoring dashboards** - Real-time OBS status displays
41+
- **Hardware controllers** - Stream decks, MIDI controllers, GPIO triggers
42+
43+
## Quick to Get Running (~30 seconds)
44+
```c
45+
#include
46+
47+
int main() {
48+
obsws_init();
49+
50+
obsws_config_t config;
51+
obsws_config_init(&config);
52+
config.host = "localhost";
53+
config.password = "your_password";
54+
55+
obsws_connection_t *obs = obsws_connect(&config);
56+
obsws_set_current_scene(obs, "Gaming Scene", NULL);
57+
58+
obsws_disconnect(obs);
59+
obsws_cleanup();
60+
return 0;
61+
}
62+
```
63+
---
64+
2265
## Quick Start
2366

2467
### Prerequisites
@@ -423,4 +466,4 @@ For issues and questions:
423466

424467
---
425468

426-
*libwsv5 is a community-supported project. Contributions and feedback are welcome.*
469+
*libwsv5 is a community-supported project. Contributions and feedback are welcome.*

0 commit comments

Comments
 (0)