onyx_online/voicemeeter-compact
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/voicemeeter-compact.git synced 2024-11-21 20:30:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
added section toml files.
This commit is contained in:
onyx-and-iris 2022-04-20 18:14:38 +01:00
parent bcb7b7f4b8
commit 0502987880
1 changed files with 22 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -53,9 +53,29 @@ A *kind_id* specifies a major Voicemeeter version. This may be one of:
- `banana`
- `potato`
## Config Files
The following config files should be placed in the same directory as your `__main__.py`.
## TOML Files
This is how your files should be organised. Wherever your `__main__.py` file is located (after install this can be any location), `config` and `profiles` directories
should be in the same location.
Regarding profiles, a directory for each kind should hold the profile files and in each there can be any number of config files. Example, a config for streaming, a config for general listening/movie watching or any other type of config.
.
├── `__main__.py`
├── configs
        ├── app.toml
        ├── vban.toml
├── profiles
        ├── basic
                ├── example.toml
                ├── other_config.toml
                ├── streaming_config.toml
        ├── banana
                ├── example.toml
                ├── other.toml
                ├── ...
        ├── potato
                ├── example.toml
                ├── ...
## Config Files
### app.toml
Configure certain startup states for the app.
- `theme`