changes installation instructions
@ -2,15 +2,21 @@
|
|||||||
|
|
||||||
If you don't have Python already you can fetch it easily from the Windows Store. Simply type `store` into the windows search bar. To run this GUI you'll need the latest version, Python 3.11 (Beta).
|
If you don't have Python already you can fetch it easily from the Windows Store. Simply type `store` into the windows search bar. To run this GUI you'll need the latest version, Python 3.11 (Beta).
|
||||||
|
|
||||||
|
![Image of Python 311 in Windows Store](./doc_imgs/python311.png)
|
||||||
|
|
||||||
If you install Python straight from `python.org` instead remember to click 'Add Python environmental variables', this is important.
|
If you install Python straight from `python.org` instead remember to click 'Add Python environmental variables', this is important.
|
||||||
|
|
||||||
## Download|Install Code
|
## Install Code
|
||||||
|
|
||||||
Once Python is installed:
|
Once Python is installed:
|
||||||
|
|
||||||
Enter voicemeeter-compact directory and type `powershell.exe` into the explorer bar as shown in the image below.
|
Create a directory in the location you wish to install the GUI. This can be anywhere.
|
||||||
|
|
||||||
![Image of PS in Explorer](./doc_imgs/powershellinexplorerbar.png)
|
Copy the `__main__.py` file from the code files into this directory. (Copy paste will do but ensure the file name is exactly `__main__.py`)
|
||||||
|
|
||||||
|
Then type `powershell.exe` into the explorer bar as shown in the image below.
|
||||||
|
|
||||||
|
![Image of PS in Explorer](./doc_imgs/gui_install.png)
|
||||||
|
|
||||||
This will open a Powershell in the current directory.
|
This will open a Powershell in the current directory.
|
||||||
|
|
||||||
@ -18,13 +24,25 @@ Then use the command `pip install voicemeeter-compact` and wait for the required
|
|||||||
|
|
||||||
## Use
|
## Use
|
||||||
|
|
||||||
Finally, run the GUI with the command `pythonw .`
|
You will need to set the kind of Voicemeeter you want to run in the `__main__.py` file. Just edit the kind_id line to one of the following:
|
||||||
|
- basic
|
||||||
|
- banana
|
||||||
|
- potato
|
||||||
|
|
||||||
If the GUI looks like the image below 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 :).
|
```python
|
||||||
|
if __name__ == "__main__":
|
||||||
|
# choose the kind of Voicemeeter (Local connection)
|
||||||
|
kind_id = "banana"
|
||||||
|
```
|
||||||
|
|
||||||
|
Finally, in powershell, run the GUI with the command `pythonw .`
|
||||||
|
|
||||||
|
If the GUI looks like the image below when you first load it, then no channels are labelled. From the menu, Configs->Load config, you may load an example config. Save your current Voicemeeter settings first :).
|
||||||
|
|
||||||
![Image of no labels example](./doc_imgs/nolabels.png)
|
![Image of no labels example](./doc_imgs/nolabels.png)
|
||||||
|
|
||||||
## Updates
|
## Updates
|
||||||
|
|
||||||
If there are updates to the app, you can track them in the [CHANGELOG](CHANGELOG.md), simply repeat the
|
If there are updates to the app, you can track them in the [CHANGELOG](CHANGELOG.md)
|
||||||
steps above from [Download|Install Code](https://github.com/onyx-and-iris/voicemeeter-compact/blob/main/INSTALLATION.md#downloadinstall-code) onwards.
|
|
||||||
|
To install any updates simply open a Powershell in the install directory as explained above, then use the commmand `pip install voicemeeter-compact -U`
|
||||||
|
Before Width: | Height: | Size: 34 KiB |
BIN
doc_imgs/gui_install.png
Normal file
After Width: | Height: | Size: 39 KiB |
Before Width: | Height: | Size: 6.3 KiB After Width: | Height: | Size: 7.1 KiB |
Before Width: | Height: | Size: 60 KiB |
BIN
doc_imgs/python311.png
Normal file
After Width: | Height: | Size: 87 KiB |
Before Width: | Height: | Size: 58 KiB |