obs-websocket-gd

The obs-websocket-gd is a Godot addon that allows interaction with Open Broadcaster Software (OBS) via obs-websocket protocol. It facilitates controlling OBS directly from within Godot, enabling features like scene switching and recording control.

https://github.com/you-win/obs-websocket-gd

Preview Image

Preview

OBS Websocket GDA Godot Addon

The obs-websocket-gd addon enables Godot Engine to interface with Open Broadcaster Software (OBS) using the obs-websocket protocol. This allows Godot applications to control OBS, enabling features such as starting/stopping streams, switching scenes, and more.

Key Features

  • OBS Control: Seamlessly control OBS functionalities directly from Godot.
  • Event Handling: Utilize signals for connection status, authentication, and data reception.
  • Command Sending: Send commands to OBS to trigger actions and retrieve data.
  • Data Mapping: Provides structured data mapping of OBS responses for easy handling.

Quickstart Guide

  1. Install the obs-websocket plugin for OBS Studio.
  2. Configure obs-websocket in OBS and set a secure password.
  3. Clone the obs-websocket-gd repository into your Godot project.
  4. Add the obs_websocket.gd node to your scene.
  5. Configure the connection details (host, port, password) in the obs_websocket.gd script.
  6. Connect to the data_received signal (optional) to handle incoming data.
  7. Call establish_connection() to initiate the connection.
  8. Use send_command() to send specific commands to OBS.

Resource Details

tool

you-win



4.0.2