# @sometimes_youwin/obs-websocket-gd

> Control OBS from inside a Godot game or app.

Latest version **1.0.1** (published 2022-05-04) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @sometimes_youwin/obs-websocket-gd
pnpm add @sometimes_youwin/obs-websocket-gd
yarn add @sometimes_youwin/obs-websocket-gd
bun add @sometimes_youwin/obs-websocket-gd
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-05-04 |
| First published | 2022-05-04 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 39.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 116 |
| Author | Tim Yuen |
| Maintainers | youwin |
| Keywords | godot, godot-engine, obs |

## Links

- npm: https://www.npmjs.com/package/@sometimes_youwin/obs-websocket-gd
- Repository: https://github.com/you-win/obs-websocket-gd
- Homepage: https://github.com/you-win/obs-websocket-gd#readme
- Issues: https://github.com/you-win/obs-websocket-gd/issues
- npm.io page: https://npm.io/package/@sometimes_youwin/obs-websocket-gd

## Recent versions

- 1.0.1 (latest) — 2022-05-04

## README

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

[![Chat on Discord](https://img.shields.io/discord/853476898071117865?label=chat&logo=discord)](https://discord.gg/6mcdWWBkrr)

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

## IMPORTANT
This addon targets obs-websocket 5.x. Please use the `obs-websocket_4.x` branch if you are using obs-websocket 4.x.

## Game/App Quickstart
1. Install [obs-websocket](https://github.com/Palakis/obs-websocket) for your platform
2. Configure obs-websocket in OBS and set the password to something of your choosing
3. Clone this project
4. Instance in the `addons/obs_websocket_gd/obs_websocket.tscn` file somewhere in your project
5. By default, the addon tries to connect to `localhost:4444` 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 `obs_data_received(update_data)` signal in `obs_websocket.gd`. `obs_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 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

---
_Source: https://npm.io/package/@sometimes_youwin/obs-websocket-gd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._