add Interactive Mode section to README.

This commit is contained in:
onyx-and-iris 2024-06-27 22:07:53 +01:00
parent f88fb9b994
commit 41bf1322ac

View File

@ -16,7 +16,7 @@
Where: Where:
- `i`: Enable interactive mode. If set any api commands passed will be ignored. - `i`: Enable interactive mode. If set, any api commands passed on the command line will be ignored.
- `k`: The kind of Voicemeeter (basic, banana or potato). Use this to launch the GUI. - `k`: The kind of Voicemeeter (basic, banana or potato). Use this to launch the GUI.
- `D`: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL - `D`: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL
@ -36,6 +36,21 @@ Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then prin
`./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label` `./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label`
## `Interactive Mode`
Running the following command in Powershell:
`./vmrcli.exe -i`
Will open an interactive prompt:
```powershell
Interactive mode enabled. Enter 'Q' to exit.
>>
```
API commands follow the same rules as listed above. Entering `Q` or `q` will exit the program.
## `Script files` ## `Script files`
Scripts can be loaded from text files, for example in Powershell: Scripts can be loaded from text files, for example in Powershell: