vanja/yabridge
1
0
Fork 0
mirror of https://github.com/robbert-vdh/yabridge.git synced 2026-06-19 18:03:56 +02:00
Code Issues Packages Projects Releases Wiki Activity

[yabridgectl] Update readme for VST3

Browse Source
This commit is contained in:
Robbert van der Helm
2020-12-26 12:55:57 +01:00
parent 57e23ee392
commit f4ad43638f
1 changed files with 34 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/yabridgectl/README.md
+34 -29
View File
@@ -13,11 +13,12 @@ from anywhere. All of the information below can also be found through
### Yabridge path ### Yabridge path
Yabridgectl will need to know where it can find the `libyabridge-vst*.so` files. Yabridgectl will need to know where it can find `libyabridge-vst2.so` and
By default it will search for it in both `~/.local/share/yabridge` (the `libyabridge-vst3.so`. By default it will search for it in both
recommended installation directory when using the prebuilt binaries) and in `~/.local/share/yabridge` (the recommended installation directory when using the
`/usr/lib`. You can use the command below to override this behaviour and to use prebuilt binaries), in `/usr/lib` and in `/usr/local/lib`. You can use the
a custom installation directory instead. command below to override this behaviour and to use a custom installation
directory instead.
```shell ```shell
yabridgectl set --path=<path/to/directory/containing/yabridge/files> yabridgectl set --path=<path/to/directory/containing/yabridge/files>
@@ -26,11 +27,11 @@ yabridgectl set --path=<path/to/directory/containing/yabridge/files>
### Installation methods ### Installation methods
Yabridge can be set up using either copies or symlinks. By default, yabridgectl Yabridge can be set up using either copies or symlinks. By default, yabridgectl
will use the copy-based installation method since this will work with any VST will use the copy-based installation method since this will work with any host,
host. If you are using a DAW that supports individually sandboxed plugins such and there's usually no reason to use symlinks anymore. If you are using a DAW
as Bitwig Studio, then you can choose between using copies and symlinks using that supports individually sandboxed plugins such as Bitwig Studio, then you can
the command below. Make sure to rerun `yabridgectl sync` after changing this choose between using copies and symlinks using the command below. Make sure to
setting. rerun `yabridgectl sync` after changing this setting.
```shell ```shell
yabridgectl set --method=<copy|symlink> yabridgectl set --method=<copy|symlink>
@@ -38,15 +39,18 @@ yabridgectl set --method=<copy|symlink>
### Managing directories ### Managing directories
Yabridgectl can manage multiple Windows VST plugin install locations for you. To Yabridgectl can manage multiple Windows plugin install locations for you.
add, remove and list directories, you can use the commands below. The status Whenever you run `yabridgectl sync` it will search these directories for VST2
command will show you yabridgectl's current settings and the installation status plugins and VST3 modules. To add, remove and list directories, you can use the
for all of your plugins. commands below. The status command will show you yabridgectl's current settings
and the installation status for all of your plugins.
```shell ```shell
# Add a directory containing plugins # Add a directory containing plugins
# Use the command from the next line to add the most common VST2 plugin directory # Use the command from the next line to add the most common VST2 plugin directory:
# yabridgectl add "$HOME/.wine/drive_c/Program Files/Steinberg/VstPlugins" # yabridgectl add "$HOME/.wine/drive_c/Program Files/Steinberg/VstPlugins"
# VST3 plugins are located here:
# yabridgectl add "$HOME/.wine/drive_c/Program Files/Common Files/VST3"
yabridgectl add <path/to/plugins> yabridgectl add <path/to/plugins>
# Remove a plugin location, this will ask you if you want to remove any leftover files from yabridge # Remove a plugin location, this will ask you if you want to remove any leftover files from yabridge
yabridgectl rm <path/to/plugins> yabridgectl rm <path/to/plugins>
@@ -59,12 +63,13 @@ yabridgectl status
### Installing and updating ### Installing and updating
Lastly you can tell yabridgectl to set up or update yabridge for all of your Lastly you can tell yabridgectl to set up or update yabridge for all of your
plugins at once using the commands below. Yabridgectl will warn you if it finds VST2 and VST3 plugins at the same time using the commands below. Yabridgectl
unrelated `.so` files that may have been left after uninstalling a plugin. You will warn you if it finds unrelated `.so` files that may have been left after
can rerun the sync command with the `--prune` option to delete those files. If uninstalling a plugin, or if it finds any unknown VST3 plugins in
you are using the default copy-based installation method, it will also verify `~/.vst3/yabridge`. You can rerun the sync command with the `--prune` option to
that your search `PATH` has been set up correctly so you can get up and running delete those files. If you are using the default copy-based installation method,
faster. it will also verify that your search `PATH` has been set up correctly so you can
get up and running faster.
```shell ```shell
# Set up or update yabridge for all plugins found under the plugin locations # Set up or update yabridge for all plugins found under the plugin locations
@@ -77,15 +82,15 @@ yabridgectl sync --force
## Alternatives ## Alternatives
TODO: This now only mentions how to do this for VST2 plugins. We should probably
just drop this section altogether since using yabridgectl is so much easier, and
if someone really wants to do this by hand then they'll be able to whip up their
own script based on the instructions in the main readme.
If you want to script your own installation behaviour and don't feel like using If you want to script your own installation behaviour and don't feel like using
yabridgectl, then you could use one of the below bash snippets instead. This yabridgectl, then you could use one of the below bash snippets instead to set up
approach is slightly less robust and does not perform any problem detection or yabridge for VST2 plugins. This approach is slightly less robust and does not
status reporting, but it will get you started. perform any problem detection or status reporting, but it will get you started.
Doing the same thing for VST3 plugins is much more complicated and it involves
[merged
bundle](https://steinbergmedia.github.io/vst3_doc/vstinterfaces/vst3loc.html#mergedbundles)
with the Windows VST3 module symlinked in, so it's recommended to have
yabridgectl do that for you.
```shell ```shell
# For use with symlinks # For use with symlinks