From 276d34feb9fe20f5202805b84639b36ab13a7374 Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Wed, 26 Jun 2024 17:00:54 +0100 Subject: [PATCH] add README --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9490b13 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# VMRCLI Command Line Utility + +## `Tested against` + +- Basic 1.1.1.1 +- Banana 2.1.1.1 +- Potato 3.1.1.1 + +## `Requirements` + +- [Voicemeeter](https://voicemeeter.com/) + +## `Use` + +`./vmrcli.exe [-i] [-k] [-D] ` + +Where: + +- `i`: Enable interactive mode. If set any api commands passed 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 + +## `Script files` + +Scripts can be loaded from text files, for example: + +```powershell +./vbantxt-cli $(Get-Content .\example_commands.txt) +```