voicemeeter/examples/vm-cli/README.md

## About

A Voicemeeter CLI, offers ability to toggle, get and set parameters.

## Install

First build and install it with `go install` (skip this step if using binary from [Releases](https://github.com/onyx-and-iris/voicemeeter/releases))

## Use

Commands that begin with `!` will toggle a parameter, commands that contain `=` will set a parameter, all other commands will get a value.

You may pass the following optional flags:

- -h: Print the help dialogue
- -i: Enable interactive mode
- -k: The kind of Voicemeeter GUI to launch, defaults to Banana
- -l: Log level (0 up to 6), defaults to 3, Warn Level
- -d: Set the delay between commands, defaults to 20ms
- -v: Enable extra console output (toggle and set messages).

for example:

`vm-cli.exe -v -l=4 -k=potato strip[0].mute=0 strip[0].mute !strip[0].mute strip[0].mute bus[0].gain=-8.8 command.lock=1`

Expected output:

```
time="<timestamp>" level=info msg="Logged into Voicemeeter Potato v3.1.1.1"
Setting strip[0].mute=0
strip[0].mute: 0.00
Toggling strip[0].mute
strip[0].mute: 1.00
Setting bus[0].gain=-8.8
Setting command.lock=1
time="<timestamp>" level=info msg="Logged out of Voicemeeter Potato"
```

If running in interactive mode enter `Q`, to exit.
add readme to vm-cli example 2022-09-17 03:21:04 +01:00			`## About`

add help dialogue add guard for toggleCmd to prevent unsafe gain changes. use logrus for control of log levels. add an input prompt for interactive mode 2024-07-02 06:50:28 +01:00			`A Voicemeeter CLI, offers ability to toggle, get and set parameters.`
add readme to vm-cli example 2022-09-17 03:21:04 +01:00
add install to vm-cli readme 2022-09-29 18:17:23 +01:00			`## Install`

add note to install in vm-cli 2022-09-29 18:27:26 +01:00			First build and install it with `go install` (skip this step if using binary from [Releases](https://github.com/onyx-and-iris/voicemeeter/releases))
add install to vm-cli readme 2022-09-29 18:17:23 +01:00
add readme to vm-cli example 2022-09-17 03:21:04 +01:00			`## Use`

add help dialogue add guard for toggleCmd to prevent unsafe gain changes. use logrus for control of log levels. add an input prompt for interactive mode 2024-07-02 06:50:28 +01:00			Commands that begin with `!` will toggle a parameter, commands that contain `=` will set a parameter, all other commands will get a value.
md fix 2022-09-18 05:45:09 +01:00
set log level to info in examples add verbose flag to vm-cli example update readme for vm-cli example 2022-09-29 18:05:21 +01:00			`You may pass the following optional flags:`
md fix 2022-09-18 05:45:09 +01:00
add help dialogue add guard for toggleCmd to prevent unsafe gain changes. use logrus for control of log levels. add an input prompt for interactive mode 2024-07-02 06:50:28 +01:00			`- -h: Print the help dialogue`
			`- -i: Enable interactive mode`
			`- -k: The kind of Voicemeeter GUI to launch, defaults to Banana`
			`- -l: Log level (0 up to 6), defaults to 3, Warn Level`
			`- -d: Set the delay between commands, defaults to 20ms`
			`- -v: Enable extra console output (toggle and set messages).`
add readme to vm-cli example 2022-09-17 03:21:04 +01:00
vm-cli reworked. now accepts -kind and -delay flags. arg parsing moved into separate run_commands function. README added to vm-cli example 2022-09-18 05:39:42 +01:00			`for example:`

add help dialogue add guard for toggleCmd to prevent unsafe gain changes. use logrus for control of log levels. add an input prompt for interactive mode 2024-07-02 06:50:28 +01:00			`vm-cli.exe -v -l=4 -k=potato strip[0].mute=0 strip[0].mute !strip[0].mute strip[0].mute bus[0].gain=-8.8 command.lock=1`
add readme to vm-cli example 2022-09-17 03:21:04 +01:00
			`Expected output:`

			```
fix expected output 2024-07-02 06:57:58 +01:00			`time="<timestamp>" level=info msg="Logged into Voicemeeter Potato v3.1.1.1"`
fix expected output 2024-07-02 06:55:30 +01:00			`Setting strip[0].mute=0`
add help dialogue add guard for toggleCmd to prevent unsafe gain changes. use logrus for control of log levels. add an input prompt for interactive mode 2024-07-02 06:50:28 +01:00			`strip[0].mute: 0.00`
fix expected output 2024-07-02 06:55:30 +01:00			`Toggling strip[0].mute`
			`strip[0].mute: 1.00`
			`Setting bus[0].gain=-8.8`
			`Setting command.lock=1`
			`time="<timestamp>" level=info msg="Logged out of Voicemeeter Potato"`
add readme to vm-cli example 2022-09-17 03:21:04 +01:00			```
add verbosePrinter to vm-cli example add info exit from interactive in README 2022-10-05 21:34:59 +01:00
add help dialogue add guard for toggleCmd to prevent unsafe gain changes. use logrus for control of log levels. add an input prompt for interactive mode 2024-07-02 06:50:28 +01:00			If running in interactive mode enter `Q`, to exit.