How do I set up OBS Websocket GD in my Godot project?

Clone the addon, add the obs_websocket.gd node to your scene, configure the password in the script to match your OBS settings, and call establish_connection(). The README provides a step-by-step quickstart guide for this process.

What OBS commands can I send from Godot using this addon?

You can send any command supported by the obs-websocket protocol by using the send_command method with the appropriate command string and data dictionary, as detailed in the official protocol documentation linked in the README.

OBS Websocket GD vs writing my own websocket client in Godot

This addon saves development time by handling the websocket connection and protocol compliance out-of-the-box, but if you need highly custom features or full control over the implementation, a custom client might be preferable. For most standard OBS integrations, this addon is more efficient.

How to handle authentication with OBS Websocket GD?

Set the password in the addon's exported variables to match your OBS configuration; the addon handles authentication automatically, and you can connect to the connection_authenticated signal to confirm success, as mentioned in the README.

Does OBS Websocket GD work with Godot 3.x?

The README states it's tested only on Godot 4.0.2, so it likely isn't compatible with Godot 3.x without significant modifications, due to differences between Godot 3 and 4 in scripting and addon systems.

Can I control multiple OBS instances with this addon?

By default, it connects to a single instance at localhost:4455; for multiple instances, you'd need to modify the connection settings or use multiple nodes, but this isn't explicitly supported in the current version and may require custom coding.

Open-Awesome

obs-websocket-gd

Apache-2.0GDScript1.0.1

A Godot addon to control OBS Studio via obs-websocket from within Godot games and applications.

GitHub

116 stars8 forks0 contributors

What is obs-websocket-gd?

OBS Websocket GD is a Godot addon that allows developers to control OBS Studio from within Godot games or applications using the obs-websocket protocol. It solves the problem of programmatically managing OBS scenes, sources, and streaming functions directly from a Godot project, enabling interactive live streaming and recording integrations.

Target Audience

Godot developers building games or applications that require integration with OBS Studio for live streaming, recording, or interactive content creation.

Value Proposition

Developers choose this addon because it provides a native Godot solution for OBS control, leveraging the obs-websocket protocol for reliable, real-time communication and seamless integration with Godot's signal system.

Overview

Control OBS from inside a Godot game or app.

Use Cases

Best For

Adding OBS scene switching triggers from in-game events
Creating interactive live streams with Godot-based overlays
Automating OBS recording start/stop based on game state
Building Godot applications that control OBS for presentations
Integrating OBS source visibility toggles in Godot projects
Developing Godot tools for streamers to manage OBS remotely

Not Ideal For

Projects requiring plug-and-play integration without any external setup or configuration
Teams using streaming software other than OBS Studio that lacks obs-websocket support
Developers who need a high-level, abstraction-based API without dealing with raw protocol commands
Applications that must run on Godot versions older than 4.0 without compatibility assurances

Pros & Cons

Pros

Protocol Compliance

Follows the official obs-websocket protocol, ensuring reliable compatibility with OBS Studio's features and updates, as stated in the README.

Real-time Integration

Establishes a live connection between Godot and OBS, enabling responsive control through signals like data_received and connection_established.

Godot-native Design

Integrates seamlessly with Godot's node-based architecture and signal system, making it intuitive for developers familiar with Godot's workflow.

Straightforward Setup

Provides clear steps in the README, with exported variables for connection configuration, simplifying initial integration despite manual steps.

Cons

Manual Configuration Overhead

Requires users to install and configure obs-websocket separately in OBS Studio and modify password variables in the addon script, adding setup complexity.

Low-level Command Interface

Users must reference the obs-websocket protocol to send commands via send_command, lacking high-level abstractions or pre-built functions for common tasks.

Limited Version Testing

Only tested on Godot 4.0.2 per the README, so compatibility with other Godot versions is uncertain and may require adjustments or cause issues.

Frequently Asked Questions

Related Projects

Pixelorama

Unleash your creativity with Pixelorama, a powerful and accessible open-source pixel art multitool. Whether you want to create sprites, tiles, animations, or just express yourself in the language of pixel art, this software will realize your pixel-perfect dreams with a vast toolbox of features. Available on Windows, Linux, macOS and the Web!

Demonstration and Template Projects

Stars9,221

Forks2,193

Last commit2 days ago

Lorien

Infinite canvas drawing/whiteboarding app for Windows, Linux and macOS. Made with Godot.

Stars6,737

Forks306

Last commit10 months ago

Dialogic

💬 Create Dialogs, Visual Novels, RPGs, and manage Characters with Godot to create your Game!

Stars5,836

Forks341

Last commit3 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub