mirror of
https://github.com/onyx-and-iris/vmrcli.git
synced 2026-04-20 02:03:31 +00:00
Compare commits
3 Commits
v0.3.0
...
cc0ec73ef4
| Author | SHA1 | Date | |
|---|---|---|---|
| cc0ec73ef4 | |||
| c45df11286 | |||
| a383aaa36b |
14
README.md
14
README.md
@@ -13,7 +13,7 @@
|
||||
## `Use`
|
||||
|
||||
```powershell
|
||||
./vmrcli.exe [-h] [-i] [-k] [-D] <api commands>
|
||||
./vmrcli.exe [-h] [-i] [-k] [-D] [-v] <api commands>
|
||||
```
|
||||
|
||||
Where:
|
||||
@@ -22,6 +22,7 @@ Where:
|
||||
- `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
|
||||
- `v`: Enable extra console output (toggle, set messages)
|
||||
|
||||
## `API Commands`
|
||||
|
||||
@@ -74,14 +75,19 @@ Multiple API commands can be in a single line but they should be space separated
|
||||
|
||||
Run the included `makefile` with [GNU Make](https://www.gnu.org/software/make/).
|
||||
|
||||
By default the log.c module is built with coloured logging enabled. To disable this you can override the `LOG_USE_COLOR` variable, for example:
|
||||
The binary in [Releases][releases] is compiled with coloured logging enabled. To disable this you can override the `LOG_USE_COLOR` variable, for example:
|
||||
|
||||
`make LOG_USE_COLOR=no`
|
||||
|
||||
## `Official Documentation`
|
||||
|
||||
- [Voicemeeter Remote C API](https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf)
|
||||
- [Voicemeeter Remote C API][remoteapi-docs]
|
||||
|
||||
## `Special Thanks`
|
||||
|
||||
- [rxi](https://github.com/rxi) for writing the [log.c](https://github.com/rxi/log.c) package
|
||||
- [rxi][rxi-user] for writing the [log.c][log-c] package
|
||||
|
||||
[releases]: https://github.com/onyx-and-iris/vmrcli/releases
|
||||
[remoteapi-docs]: https://github.com/onyx-and-iris/Voicemeeter-SDK/blob/main/VoicemeeterRemoteAPI.pdf
|
||||
[rxi-user]: https://github.com/rxi
|
||||
[log-c]: https://github.com/rxi/log.c
|
||||
|
||||
@@ -127,8 +127,8 @@ void help()
|
||||
"\th: Prints the help dialogue\n"
|
||||
"\ti: Enable interactive mode\n"
|
||||
"\tk: The kind of Voicemeeter (basic, banana, potato)\n"
|
||||
"\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL"
|
||||
"\tv: Enable extra console output (toggle, set messages)\n");
|
||||
"\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL\n"
|
||||
"\tv: Enable extra console output (toggle, set messages)");
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
Reference in New Issue
Block a user