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

Control OBS from inside a Godot game or app.
https://github.com/you-win/obs-websocket-gd

godot obs

Last synced: 9 days ago
JSON representation

Control OBS from inside a Godot game or app.

• Host: GitHub
• URL: https://github.com/you-win/obs-websocket-gd
• Owner: you-win
• License: apache-2.0
• Created: 2021-10-07T01:30:15.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-26T16:17:15.000Z (6 months ago)
• Last Synced: 2024-10-28T04:07:35.256Z (11 days ago)
• Topics: godot, obs
• Language: GDScript
• Homepage:
• Size: 772 KB
• Stars: 88
• Watchers: 2
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-godot - obs-websocket-gd - Script and editor plugin to control Open Broadcaster Software from Godot via obs-websocket (Godot 3.x). (Plugins and scripts / 3D)
• awesome-godot-3 - obs-websocket-gd - Script and editor plugin to control Open Broadcaster Software from Godot via obs-websocket (Godot 3.x). (Plugins and scripts / 3D)
• awesome-godot-3 - obs-websocket-gd - Script and editor plugin to control Open Broadcaster Software from Godot via obs-websocket (Godot 3.x). (Plugins and scripts / 3D)

README

        
# ![](obs_godot_icon.png) OBS Websocket GD

A Godot addon to interact with [obs-websocket](https://github.com/Palakis/obs-websocket). Tested on Godot 4.0.2.

## Game/App Quickstart

1. Install [obs-websocket](https://github.com/Palakis/obs-websocket) for your platform. Recent distributions of OBS should come with obs-websocket already included

2. Configure obs-websocket in OBS and set the password to something of your choosing

3. Clone this project

4. Add the `addons/obs-websocket-gd/obs_websocket.gd` node to your scene

5. By default, the addon tries to connect to `localhost:4455` with a password of `password`. Change the password in `addons/obs_websocket_gd/obs_websocket.gd` to the password set in step 2. The variables are exported for convenience

6. (OPTIONAL) Connect some listener to the `data_received(update_data)` signal in `obs_websocket.gd`. `data_received` outputs an `ObsMessage` data structure. This data structure stores the raw response and also maps the data to the expected OpCode fields.

7. Call `establish_connection()` on the `obs_websocket.gd` node to connect to obs-websocket. The `connection_established`, `connection_authenticated`, and `connection_closed` signals are available to connect to

8. Call the `send_command(command: String, data: Dictionary = {})` method on the `obs_websocket.gd` instance. Reference the [obs-websocket protocol](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md) to find out what commands + data to send.