voicemeeter-api-python/examples/obs/README.md
onyx-and-iris bc370b4b32 obs example updated for websocket v5
setup.py added to obs example

readme for obs example updated
2022-07-29 20:06:26 +01:00

20 lines
658 B
Markdown

## Requirements
- [OBS Studio](https://obsproject.com/)
- [OBS Websocket v5 Plugin](https://github.com/obsproject/obs-websocket/releases/tag/5.0.0)
- [OBS Python SDK for Websocket v5](https://github.com/onyx-and-iris/obs-websocket-py)
## About
A simple demonstration showing how to sync OBS scene switches to Voicemeeter states. The script assumes you have connection info saved in
a config file named `config.toml` placed next to `__main__.py`. It also assumes you have scenes named `START` `BRB` `END` and `LIVE`.
A valid `config.toml` file might look like this:
```toml
[connection]
host = "localhost"
port = 4455
password = "mystrongpass"
```