onyx_online/vbantxt
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vbantxt.git synced 2024-11-21 17:30:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
onyx-and-iris 2022-11-06 07:37:30 +00:00
parent 73a99e5059
commit cfd89fb1ed
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -3,7 +3,7 @@
# VBAN Sendtext CLI Utility # VBAN Sendtext CLI Utility
VBAN sendtext cli utility for sending Voicemeeter string requests over a network. Send Voicemeeter string requests over a network.
## Tested against ## Tested against
@ -14,15 +14,17 @@ VBAN sendtext cli utility for sending Voicemeeter string requests over a network
## Requirements ## Requirements
- [Voicemeeter](https://voicemeeter.com/) - [Voicemeeter](https://voicemeeter.com/)
- Go 1.18 or greater - Go 1.18 or greater (if you want to compile yourself, otherwise check `Releases`)
## `Use` ---
#### `Command Line` ## `Command Line`
Pass `host`, `port` and `streamname` as flags, for example: Pass `host`, `port` and `streamname` as flags, for example:
`vbantxt-cli -h="gamepc.local" -p=6980 -s=Command1 "strip[0].mute=1 strip[1].mono=1"` ```
vbantxt-cli -h="gamepc.local" -p=6980 -s=Command1 "strip[0].mute=1 strip[1].mono=1"
```
You may also store them in a `config.toml` located in `home directory / .vbantxt_cli /` You may also store them in a `config.toml` located in `home directory / .vbantxt_cli /`
@ -35,7 +37,9 @@ Port=6980
Streamname="Command1" Streamname="Command1"
``` ```
#### `Script files` ---
## `Script files`
The vbantxt-cli utility accepts a single string request or an array of string requests. This means you can pass scripts stored in files. The vbantxt-cli utility accepts a single string request or an array of string requests. This means you can pass scripts stored in files.
@ -52,4 +56,5 @@ to load commands from a file:
``` ```
strip[0].mute=0;strip[0].mute=0 strip[0].mute=0;strip[0].mute=0
strip[1].mono=0;strip[1].mono=0 strip[1].mono=0;strip[1].mono=0
bus[3].eq.On=1
``` ```