mirror of
https://github.com/onyx-and-iris/vmrcli.git
synced 2025-01-18 08:41:08 +00:00
add README
This commit is contained in:
parent
6373d78c52
commit
276d34feb9
29
README.md
Normal file
29
README.md
Normal file
@ -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] <api commands>`
|
||||
|
||||
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)
|
||||
```
|
Loading…
Reference in New Issue
Block a user