voicemeeter-api-python/examples/obs/README.md

20 lines
658 B
Markdown
Raw Normal View History

2022-07-02 02:23:22 +01:00
## 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)
2022-07-02 02:23:22 +01:00
## 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`.
2022-07-02 02:23:22 +01:00
A valid `config.toml` file might look like this:
2022-07-02 02:23:22 +01:00
```toml
2022-07-02 02:23:22 +01:00
[connection]
host = "localhost"
port = 4455
password = "mystrongpass"
2022-07-02 02:23:22 +01:00
```