Question 1

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

Accepted Answer

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.

Question 2

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

Accepted Answer

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.

Question 3

OBS Websocket GD vs writing my own websocket client in Godot

Accepted Answer

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.

Question 4

How to handle authentication with OBS Websocket GD?

Accepted Answer

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.

Question 5

Does OBS Websocket GD work with Godot 3.x?

Accepted Answer

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.

Question 6

Can I control multiple OBS instances with this addon?

Accepted Answer

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.

obs-websocket-gd

What is obs-websocket-gd?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions