OBS Websocket GD
A Godot addon to interact with obs-websocket. Tested on Godot 3.4.
Editor Plugin Quickstart
- Install obs-websocket for your platform
- Configure obs-websocket in OBS and set the password to something of your choosing
- Clone this project and move the
addons/obs_websocket_gd
folder to youraddons
folder - By default, the addon tries to connect to
localhost:4444
with a password ofpassword
. Change the password inaddons/obs_websocket_gd/obs_websocket.gd
to the password set in step 2 - Activate the addon in the Godot editor
- A new
OBS
menu should appear in the bottom bar of the editor
Game/App Quickstart
- Install obs-websocket for your platform
- Configure obs-websocket in OBS and set the password to something of your choosing
- Clone this project
- Instance in the
addons/obs_websocket_gd/obs_websocket.tscn
file somewhere in your project - By default, the addon tries to connect to
localhost:4444
with a password ofpassword
. Change the password inaddons/obs_websocket_gd/obs_websocket.gd
to the password set in step 2. The variables are exported for convenience - (OPTIONAL) Connect some listener to the
obs_updated(update_data)
signal inobs_websocket.gd
.obs_updated
outputs a Dictioanry - Call the
send_command(command: String, data: Dictionary = {})
method on theobs_websocket.gd
instance. Reference the obs-websocket protocol to find out what commands + data to send
Discussion
A Discord server is available here if you need help, like to contribute, or just want to chat.