From 5b08823f83685d1e4c61a29c001ecc845f6dcd64 Mon Sep 17 00:00:00 2001 From: Robbert van der Helm Date: Wed, 25 Aug 2021 13:03:42 +0200 Subject: [PATCH] Rename issues section to Known issues and fixes Probably makes it a bit clearer that this section nowadays includes a bunch of fixes and workarounds for these issues. --- CHANGELOG.md | 4 ++-- README.md | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a07e5ce8..a61269e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -467,7 +467,7 @@ Versioning](https://semver.org/spec/v2.0.0.html). option](https://github.com/robbert-vdh/yabridge#compatibility-options) to hide the name of the DAW you're using. This can be useful with plugins that have undesirable or broken DAW-specific behaviour. See the [known - issues](https://github.com/robbert-vdh/yabridge#runtime-dependencies-and-known-issues) + issues](https://github.com/robbert-vdh/yabridge#known-issues-and-fixes) section of the readme for more information on when this may be useful. - Yabridge now uses a watchdog timer to prevent rare instances where Wine processes would be left running after the native host has crashed or when it @@ -1055,7 +1055,7 @@ Versioning](https://semver.org/spec/v2.0.0.html). doesn't expect it, see [#29](https://github.com/robbert-vdh/yabridge/issues/29) and [#32](https://github.com/robbert-vdh/yabridge/issues/32). The - [readme](https://github.com/robbert-vdh/yabridge#runtime-dependencies-and-known-issues) + [readme](https://github.com/robbert-vdh/yabridge#known-issues-and-fixes) contains instructions on how to enable this. ### Changed diff --git a/README.md b/README.md index ea502bf9..f8e66559 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ while also staying easy to debug and maintain. - [Plugin groups](#plugin-groups) - [Compatibility options](#compatibility-options) - [Example](#example) -- [**Runtime dependencies and known issues**](#runtime-dependencies-and-known-issues) +- [**Known issues and fixes**](#known-issues-and-fixes) - [**Troubleshooting common issues**](#troubleshooting-common-issues) - [**Performance tuning**](#performance-tuning) - [Environment configuration](#environment-configuration) @@ -341,17 +341,17 @@ plugin._ | Option | Values | Description | | ------------------------ | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `disable_pipes` | `{true,false,}` | When this option is enabled, yabridge will redirect the Wine plugin host's output streams to a file without any further processing. See the [known issues](#runtime-dependencies-and-known-issues) section for a list of plugins where this may be useful. This can be set to a boolean, in which case the output will be written to `$XDG_RUNTIME_DIR/yabridge-plugin-output.log`, or to an absolute path (with no expansion for tildes or environment variables). Defaults to `false`. | +| `disable_pipes` | `{true,false,}` | When this option is enabled, yabridge will redirect the Wine plugin host's output streams to a file without any further processing. See the [known issues](#known-issues-and-fixes) section for a list of plugins where this may be useful. This can be set to a boolean, in which case the output will be written to `$XDG_RUNTIME_DIR/yabridge-plugin-output.log`, or to an absolute path (with no expansion for tildes or environment variables). Defaults to `false`. | | `editor_coordinate_hack` | `{true,false}` | Compatibility option for plugins that rely on the absolute screen coordinates of the window they're embedded in. Since the Wine window gets embedded inside of a window provided by your DAW, these coordinates won't match up and the plugin would end up drawing in the wrong location without this option. Currently the only known plugins that require this option are _PSPaudioware E27_ and _Soundtoys Crystallizer_. Defaults to `false`. _In yabridge 3.5.2 there's a variation of this option called_ `editor_double_embed`_._ | | `editor_force_dnd` | `{true,false}` | This option forcefully enables drag-and-drop support in _REAPER_. Because REAPER's FX window supports drag-and-drop itself, dragging a file onto a plugin editor will cause the drop to be intercepted by the FX window. This makes it impossible to drag files onto plugins in REAPER under normal circumstances. Setting this option to `true` will strip drag-and-drop support from the FX window, thus allowing files to be dragged onto the plugin again. Defaults to `false`. | | `editor_xembed` | `{true,false}` | Use Wine's XEmbed implementation instead of yabridge's normal window embedding method. Some plugins will have redrawing issues when using XEmbed and editor resizing won't always work properly with it, but it could be useful in certain setups. You may need to use [this Wine patch](https://github.com/psycha0s/airwave/blob/master/fix-xembed-wine-windows.patch) if you're getting blank editor windows. Defaults to `false`. | | `frame_rate` | `` | The rate at which Win32 events are being handled and usually also the refresh rate of a plugin's editor GUI. When using plugin groups all plugins share the same event handling loop, so in those the last loaded plugin will set the refresh rate. Defaults to `60`. | -| `hide_daw` | `{true,false}` | Don't report the name of the actual DAW to the plugin. See the [known issues](#runtime-dependencies-and-known-issues) section for a list of situations where this may be useful. This affects both VST2 and VST3 plugins. Defaults to `false`. | +| `hide_daw` | `{true,false}` | Don't report the name of the actual DAW to the plugin. See the [known issues](#known-issues-and-fixes) section for a list of situations where this may be useful. This affects both VST2 and VST3 plugins. Defaults to `false`. | | `vst3_no_scaling` | `{true,false}` | Disable HiDPI scaling for VST3 plugins. Wine currently does not have proper fractional HiDPI support, so you might have to enable this option if you're using a HiDPI display. In most cases setting the font DPI in `winecfg`'s graphics tab to 192 will cause plugins to scale correctly at 200% size. Defaults to `false`. | | `vst3_prefer_32bit` | `{true,false}` | Use the 32-bit version of a VST3 plugin instead the 64-bit version if both are installed and they're in the same VST3 bundle inside of `~/.vst3/yabridge`. You likely won't need this. | These options are workarounds for issues mentioned in the [known -issues](#runtime-dependencies-and-known-issues) section. Depending on the hosts +issues](#known-issues-and-fixes) section. Depending on the hosts and plugins you use you might want to enable some of them. ### Example @@ -436,7 +436,7 @@ editor_force_dnd = true vst3_no_scaling = true ``` -## Runtime dependencies and known issues +## Known issues and fixes Any plugin should function out of the box, although some plugins will need some additional dependencies for their GUIs to work correctly. Notable examples