vanja/yabridge
1
0
Fork 0
mirror of https://github.com/robbert-vdh/yabridge.git synced 2026-05-10 04:30:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update yabridgectl readme

Browse Source
This commit is contained in:
Robbert van der Helm
2020-07-15 21:54:42 +02:00
parent 98f57b0793
commit ae0f4aa64e
2 changed files with 22 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tools/yabridgectl/README.md
+20 -21
View File
@@ -1,33 +1,32 @@
# yabridgectl # yabridgectl
A small, optional utility to set up A small, optional utility to help set up and update
[yabridge](https://github.com/robbert-vdh/yabridge) for several directories at [yabridge](https://github.com/robbert-vdh/yabridge) for several directories at
once and to keep them updated. once.
## Usage ## Usage
Yabridgectl can be downloaded from the GitHub releases section, and it can run Yabridgectl can be downloaded from the GitHub releases section and can run from
from anywhere. All of the information below can also be found by running anywhere. All of the information below can also be found through `yabridgectl --help`.
`yabridgectl --help`.
### Yabridge path ### Yabridge path
Yabrdgectl will need to know where it can find `libyabridge.so`. By default it Yabrdgectl will need to know where it can find `libyabridge.so`. By default it
will look for it in both `~/.local/share/yabridge` (the recommended installation will look for it in both `~/.local/share/yabridge` (the recommended installation
directory when using the prebuilt binaries) and in `/usr/lib` (used when using directory when using the prebuilt binaries) and in `/usr/lib`. You can use the
the AUR packages). You can use the command below to override this behaviour and command below to override this behaviour and to use a custom installation
to use a custom installation directory instead. directory instead.
```shell ```shell
yabridgectl set --path=<path/to/directory/containing/yabridge> yabridgectl set --path=<path/to/directory/containing/yabridge/files>
``` ```
### Installation methods ### Installation methods
By default, yabridgectl will use the copy-based installation method for yabridge By default, yabridgectl will use the copy-based installation method for yabridge
since this installation method works everywhere. If you are using a DAW that since this installation method works with any VST host. If you are using a DAW
supports individually sandboxed plugins, then you can choose between using that supports individually sandboxed plugins such as Bitwig Studio, then you can
copies and symlinks using the command below. choose between using copies and symlinks using the command below.
```shell ```shell
yabridgectl set --method=<copy|symlink> yabridgectl set --method=<copy|symlink>
@@ -40,23 +39,23 @@ and list directories, or to list the plugins currently installed inside one of
those directories, you can use the command below. those directories, you can use the command below.
```shell ```shell
# Add a directory to watch # Add a location containing plugins
# For instance, use the below command for the most common VST2 plugin directory # For instance, use the below command for 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"
yabridgectl add <path/to/plugins> yabridgectl add <path/to/plugins>
# No longer watch a directory, this will ask you if you want to remove any leftover yabridge files # Remove a plugin location, this will ask you if you want to remove any leftover yabridge files
yabridgectl rm <path/to/plugins> yabridgectl rm <path/to/plugins>
# List the currently watched directories # List the current plugin locations
yabridgectl list yabridgectl list
# Show the current settings and the installation status for all plugins in the watched directories # Show the current settings and the installation status for all plugins found
yabridgectl status yabridgectl status
``` ```
### Installing and updating ### Installing and updating
Finally you can set up or update yabridge for all of your plugins at once using Finally you can tell yabridgectl to set up or update yabridge for all of your
the command below. By default yabridgectl will warn you if it finds `.so` files plugins at once using the commands below. By default yabridgectl will warn you
without an accompanying `.dll` file, but it will only delete those when using if it finds leftover `.so` files, but it will only delete those when ran using
the `--prune` option. the `--prune` option.
```shell ```shell
@@ -95,8 +94,8 @@ find -L "$plugin_dir" -type f -iname '*.dll' -print0 |
## Building ## Building
After installing [Rust](https://rustup.rs/), simply run the below to compile and After installing [Rust](https://rustup.rs/), simply run the command below to
run: compile and run:
```shell ```shell
cargo run --release cargo run --release
tools/yabridgectl/src/main.rs
+2 -2
View File
@@ -329,10 +329,10 @@ fn do_sync(config: &Config, prune: bool, verbose: bool) {
// tries to load them // tries to load them
if !orphan_so_files.is_empty() { if !orphan_so_files.is_empty() {
if prune { if prune {
println!("Removing {} leftover '.so' file(s):", orphan_so_files.len()); println!("Removing {} leftover '.so' files:", orphan_so_files.len());
} else { } else {
println!( println!(
"Found {} leftover '.so' file(s), rerun with the '--prune' option to remove them:", "Found {} leftover '.so' files, rerun with the '--prune' option to remove them:",
orphan_so_files.len() orphan_so_files.len()
); );
} }