mirror of
https://github.com/onyx-and-iris/voicemeeter-compact.git
synced 2024-11-21 20:30:56 +00:00
add rt packet service to special thanks
add rt packet service to special thanks
This commit is contained in:
parent
0d6f9c8a86
commit
fd73a8f687
@ -1,7 +1,9 @@
|
||||
## Git Installation
|
||||
|
||||
https://git-scm.com/download/win
|
||||
|
||||
## Python Installation
|
||||
|
||||
If you don't have Python already you can fetch it easily from the Windows Store. Simply type `store` into the windows search bar, and select the latest version. At the time of writing that is Python 3.10.
|
||||
|
||||
![Image of Python in Windows Store](./doc_imgs/wspython310.png)
|
||||
|
54
README.md
54
README.md
@ -2,13 +2,17 @@
|
||||
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
|
||||
|
||||
![Image of app/potato size comparison](./doc_imgs/potatocomparisonsmaller.png)
|
||||
|
||||
# Voicemeeter Compact
|
||||
|
||||
## Prerequisites
|
||||
- Voicemeeter (Basic v1.0.8.2), (Banana v2.0.6.2) or (Potato v3.0.2.2)
|
||||
- [Git for Windows](https://git-scm.com/download/win)
|
||||
- Python 3.9+
|
||||
|
||||
- Voicemeeter (Basic v1.0.8.2), (Banana v2.0.6.2) or (Potato v3.0.2.2)
|
||||
- [Git for Windows](https://git-scm.com/download/win)
|
||||
- Python 3.9+
|
||||
|
||||
## Installation
|
||||
|
||||
For a step-by-step guide [click here](INSTALLATION.md)
|
||||
|
||||
```
|
||||
@ -18,7 +22,9 @@ pip install .
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
Example `__main__.py` file:
|
||||
|
||||
```python
|
||||
import voicemeeter
|
||||
import vmcompact
|
||||
@ -40,7 +46,6 @@ if __name__ == "__main__":
|
||||
main()
|
||||
```
|
||||
|
||||
|
||||
It's important to know that only labelled strips and buses will appear in the Channel frames. Removing a Channels label will cause the GUI to grow/shrink in real time.
|
||||
|
||||
![Image of unlabelled app](./doc_imgs/nolabels.png)
|
||||
@ -48,12 +53,15 @@ 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`
|
||||
|
||||
A _kind_id_ specifies a major Voicemeeter version. This may be one of:
|
||||
|
||||
- `basic`
|
||||
- `banana`
|
||||
- `potato`
|
||||
|
||||
## 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.
|
||||
@ -92,30 +100,35 @@ Regarding profiles, a directory for each kind should hold the profile files and
|
||||
|
||||
├── ...
|
||||
|
||||
## Config Files
|
||||
## Configs
|
||||
|
||||
### app.toml
|
||||
|
||||
Configure certain startup states for the app.
|
||||
- `theme`
|
||||
By default the app loads up the [Sun Valley light or dark theme](https://github.com/rdbende/Sun-Valley-ttk-theme) by @rdbende. When all 16 channels for Potato are labelled you may find the app becomes slower so you have the option to load up the app without any theme loaded. Simply set `enabled` to false and `mode` will take no effect.
|
||||
|
||||
- `extends`
|
||||
Extending the app will show both strips and buses. In reduced mode only one or the other. This app will extend both horizontally and vertically, simply set `extends_horizontal` true or false accordingly.
|
||||
- `theme`
|
||||
By default the app loads up the [Sun Valley light or dark theme](https://github.com/rdbende/Sun-Valley-ttk-theme) by @rdbende. When all 16 channels for Potato are labelled you may find the app becomes slower so you have the option to load up the app without any theme loaded. Simply set `enabled` to false and `mode` will take no effect.
|
||||
|
||||
- `channel`
|
||||
For each channel labelframe the width and height may be adjusted which effects the spacing between widgets and the length of the scales and progressbars respectively.
|
||||
- `extends`
|
||||
Extending the app will show both strips and buses. In reduced mode only one or the other. This app will extend both horizontally and vertically, simply set `extends_horizontal` true or false accordingly.
|
||||
|
||||
- `mwscroll_step`
|
||||
Sets the amount (in db) the gain slider moves with a single mousewheel step. Default 3.
|
||||
- `channel`
|
||||
For each channel labelframe the width and height may be adjusted which effects the spacing between widgets and the length of the scales and progressbars respectively.
|
||||
|
||||
- `submixes`
|
||||
Select the default submix bus when Submix frame is shown. For example, a dedicated bus for OBS.
|
||||
- `mwscroll_step`
|
||||
Sets the amount (in db) the gain slider moves with a single mousewheel step. Default 3.
|
||||
|
||||
- `submixes`
|
||||
Select the default submix bus when Submix frame is shown. For example, a dedicated bus for OBS.
|
||||
|
||||
### vban.toml
|
||||
|
||||
Configure as many vban connections as you wish. This allows the app to work over a LAN connection as well as with a local Voicemeeter installation.
|
||||
|
||||
For vban connections to work correctly VBAN TEXT incoming stream MUST be configured correctly on the remote machine. Both pcs ought to be connected to a local private network and should be able to ping one another.
|
||||
|
||||
## Profiles
|
||||
|
||||
Three example profiles are included with the package, one for each kind of Voicemeeter. Use these to configure parameter startup states. Any parameter supported by the underlying interfaces may be used. For a detailed description of parameter coverage see:
|
||||
|
||||
[Voicemeeter Remote API Python](https://github.com/onyx-and-iris/voicemeeter-api-python)
|
||||
@ -125,7 +138,8 @@ Three example profiles are included with the package, one for each kind of Voice
|
||||
Profiles may be loaded at any time via the menu.
|
||||
|
||||
## Special Thanks
|
||||
[Vincent Burel](https://github.com/vburel2018) for creating Voicemeeter, its SDK, the C Remote API and Streamer View app!
|
||||
|
||||
[Vincent Burel](https://github.com/vburel2018) for creating Voicemeeter, its SDK, the C Remote API, the RT Packet service and Streamer View app!
|
||||
|
||||
[Christian Volkmann](https://github.com/chvolkmann/voicemeeter-remote-python) for the detailed work that went into creating the underlying Remote API Python Interface.
|
||||
Unfortunately, the Remote API Python Interface has `NOT` been open source licensed. I have raised an issue and asked directly and politely but so far no response. If a license is added in future I will update this section. Without an open source license there is no guarantee that in future this package may not be pulled down, without any notice.
|
||||
|
Loading…
Reference in New Issue
Block a user