From 681293bfa9d0f77058da8e9d94e6463ae2ecd8c1 Mon Sep 17 00:00:00 2001 From: onyx-and-iris <75868496+onyx-and-iris@users.noreply.github.com> Date: Tue, 12 Apr 2022 18:35:33 +0100 Subject: [PATCH] Update README.md add kind_id section to readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 428a4c2..f77e6ae 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,8 @@ if __name__ == "__main__": kind_id = "banana" # hide can be used to enable/disable the Voicemeeter GUI - # if hidden the audio engine will still start and the app should work as normal but the main VM GUI will not display, + # if hidden the audio engine will still start and the app should work as normal + # but the main VM GUI will not display, # nor will there be an icon in the taskbar. voicemeeter.launch(kind_id, hide=False) @@ -43,6 +44,12 @@ It's important to know that only labelled strips and buses will appear in the Ch If the GUI looks like the above when you first load it, then no channels are labelled. From the `menu->Profiles->Load Profile` you may load an example config. Save your current Voicemeeter settings first :). +### kind_id +A *kind_id* specifies a major Voicemeeter version. This may be one of: +- `basic` +- `banana` +- `potato` + ## Config Files ### app.toml Configure certain startup states for the app.