vbantxt/README.md

61 lines
1.3 KiB
Markdown
Raw Normal View History

2022-11-05 19:27:16 +00:00
![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)
![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
2022-11-05 19:05:38 +00:00
# VBAN Sendtext CLI Utility
2022-11-05 18:58:36 +00:00
2022-11-06 07:37:30 +00:00
Send Voicemeeter string requests over a network.
2022-11-05 18:58:36 +00:00
## Tested against
- Basic 1.0.8.4
- Banana 2.0.6.4
- Potato 3.0.2.4
## Requirements
- [Voicemeeter](https://voicemeeter.com/)
2022-11-06 07:37:30 +00:00
- Go 1.18 or greater (if you want to compile yourself, otherwise check `Releases`)
2022-11-05 18:58:36 +00:00
2022-11-06 07:37:30 +00:00
---
2022-11-05 18:58:36 +00:00
2022-11-06 07:37:30 +00:00
## `Command Line`
2022-11-05 18:58:36 +00:00
Pass `host`, `port` and `streamname` as flags, for example:
2022-11-06 07:37:30 +00:00
```
vbantxt-cli -h="gamepc.local" -p=6980 -s=Command1 "strip[0].mute=1 strip[1].mono=1"
```
2022-11-05 18:58:36 +00:00
You may also store them in a `config.toml` located in `home directory / .vbantxt_cli /`
A valid `config.toml` might look like this:
```toml
[connection]
Host="gamepc.local"
2022-11-05 19:33:26 +00:00
Port=6980
2022-11-05 18:58:36 +00:00
Streamname="Command1"
```
2022-11-06 07:37:30 +00:00
---
## `Script files`
2022-11-05 18:58:36 +00:00
The vbantxt-cli utility accepts a single string request or an array of string requests. This means you can pass scripts stored in files.
For example, in Windows with Powershell you could:
`vbantxt-cli $(Get-Content .\script.txt)`
2022-11-05 19:27:16 +00:00
Or with Bash:
`cat script.txt | xargs vbantxt-cli`
2022-11-05 18:58:36 +00:00
to load commands from a file:
```
strip[0].mute=0;strip[0].mute=0
strip[1].mono=0;strip[1].mono=0
2022-11-06 07:37:30 +00:00
bus[3].eq.On=1
2022-11-05 18:58:36 +00:00
```