From 575b681445b787ff30dbfaacab3d12484f398050 Mon Sep 17 00:00:00 2001 From: onyx-and-iris <75868496+onyx-and-iris@users.noreply.github.com> Date: Thu, 16 Jun 2022 16:56:20 +0100 Subject: [PATCH] Update README.md add config files section to readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 37368fc..3214e3e 100644 --- a/README.md +++ b/README.md @@ -171,6 +171,22 @@ vban.strip[0].apply(mute: true, gain: 3.2, A1: true) vban.vban.outstream[0].apply(on: true, name: 'streamname', bit: 24) ``` +## Config Files + +`vban.apply_config('config')` + +You may load config files in TOML format. +Three example profiles have been included with the package. Remember to save +current settings before loading a profile. To set one you may do: + +```python +import vban_cmd +with vban_cmd.api('banana') as vban: + vban.apply_config('config') +``` + +will load a config file at configs/banana/config.toml for Voicemeeter Banana. + ## `Base Module` ### VbanCmd class