From d4787fc1203e4165afef98b6116ae5d60d7d9f01 Mon Sep 17 00:00:00 2001
From: Robbert van der Helm <mail@robbertvanderhelm.nl>
Date: Tue, 29 Sep 2020 18:13:39 +0200
Subject: [PATCH] Clarify libSwell message and mention workaround

---
 CHANGELOG.md                 |  9 +++++++++
 src/plugin/plugin-bridge.cpp | 35 +++++++++++++++++++++++++++++++++--
 2 files changed, 42 insertions(+), 2 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 82df0786..3e91bc75 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic
 Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+### Changed
+
+- Added a note to the message saying that libSwell GUI support has been disabled
+  that his is perfectly normal when using REAPER. The message now also contains
+  the suggestion to enable the `hack_reaper_update_display` workaround for
+  REAPER when it is not already enabled.
+
 ## [1.6.1] - 2020-09-28
 
 ### Fixed
diff --git a/src/plugin/plugin-bridge.cpp b/src/plugin/plugin-bridge.cpp
index 88977bbb..d1e0ce2b 100644
--- a/src/plugin/plugin-bridge.cpp
+++ b/src/plugin/plugin-bridge.cpp
@@ -493,9 +493,40 @@ intptr_t PluginBridge::dispatch(AEffect* /*plugin*/,
             if (query == "hasCockosViewAsConfig") {
                 logger.log_event(true, opcode, index, value, query, option,
                                  std::nullopt);
+
+                logger.log("");
                 logger.log(
-                    "   The host requests libSwell GUI support which is not "
-                    "supported using Wine, ignoring the request.");
+                    "   The host has requested libSwell GUI support which is ");
+                logger.log(
+                    "   not supported when using Wine, ignoring the request.");
+                logger.log(
+                    "   You can safely ignore this message. This is normal");
+                logger.log("   when using REAPER.");
+                logger.log("");
+
+                // Since the user is using REAPER, also show a reminder that the
+                // REAPER workaround should be enabled when it is not yet
+                // enabled since it may be easy to miss
+                if (!config.hack_reaper_update_display) {
+                    logger.log(
+                        "   With using REAPER you will have to enable the");
+                    logger.log(
+                        "   'hack_reaper_update_display' option to prevent");
+                    logger.log(
+                        "   certain plugins from crashing. To do so, create a");
+                    logger.log(
+                        "   new file named 'yabridge.toml' next to your");
+                    logger.log("   plugins with the following contents:");
+                    logger.log("");
+                    logger.log(
+                        "   # "
+                        "https://github.com/robbert-vdh/"
+                        "yabridge#runtime-dependencies-and-known-issues");
+                    logger.log("   [\"*\"]");
+                    logger.log("   hack_reaper_update_display = true");
+                    logger.log("");
+                }
+
                 logger.log_event_response(true, opcode, -1, nullptr,
                                           std::nullopt);
                 return -1;