From 41bf1322ac019f1ec19dbdcaec2263d15ea36b2a Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Thu, 27 Jun 2024 22:07:53 +0100 Subject: [PATCH] add Interactive Mode section to README. --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3adb441..04d6f0a 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ 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. - `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` +## `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` Scripts can be loaded from text files, for example in Powershell: