obs-urlsource  by royshil

Dynamic content integration for OBS streaming

Created 2 years ago
251 stars

Top 99.8% on SourcePulse

GitHubView on GitHub
Project Summary

Summary OBS URL/API Source is an OBS Studio plugin enabling dynamic content integration by fetching data from URLs, APIs, or files. It allows users to display this data as text, images, or audio within OBS scenes, enhancing live streams and content creation with real-time, external information. The plugin targets OBS users seeking to automate or enrich their broadcasts.

How It Works The plugin utilizes the Inja templating engine for constructing input URLs/POST bodies and parsing output. It supports HTTP GET/POST requests with custom headers and bodies. Data extraction is versatile, covering JSON (JSONPointer, JSONPath), XML/HTML (XPath, XQuery), Key-Value, Regex, and CSS selectors. Rendered HTML supports a subset of HTML4/CSS, including image tags, and audio output is supported for Media Sources.

Quick Start & Requirements

  • Build: Tested on macOS (Intel/Apple Silicon), Windows, Linux. Requires cloning, initializing submodules (git submodule update --init --recursive), and running platform-specific build scripts (e.g., ./.github/scripts/build-macos, .\.github/scripts/Build-Windows.ps1).
  • Install: Copy the generated .plugin file to the OBS Studio plugins directory (e.g., ~/Library/Application Support/obs-studio/plugins).
  • Prerequisites: C++ build tools (CMake, compilers).

Highlighted Details

  • Supports HTTP GET/POST with headers and bodies.
  • Versatile parsing: JSON, XML/HTML, Key-Value, Regex, CSS selectors.
  • Dynamic templating (Inja) for inputs and outputs.
  • Renders HTML (subset) and images; supports audio output.
  • Multi-value capture, object unpacking, and output mapping.
  • Live updates via timers.
  • Websocket support is planned.

Maintenance & Community Actively maintained with CI pipelines. Links to other related OBS plugins by the same team are provided. GitHub sponsors are accepted. No direct community channels (Discord/Slack) are listed.

Licensing & Compatibility Licensed under the MIT License, permitting commercial use and integration into closed-source projects with attribution.

Limitations & Caveats "Coming soon" features include advanced authentication (Basic, Digest, OAuth), additional HTTP methods (PUT, DELETE, PATCH, GraphQL), and more output formats (CSV, Markdown, slim, HAML). HTML rendering supports a reduced feature subset.

Health Check
Last Commit

4 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
2
Star History
5 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.