Reorganize top-level directories with clearer naming convention

app -> app-desktop-macos, presets -> app-presets, server -> remote-server, daw-config-reaper -> osc-config-daw, plugin-reaper-realearn -> plugin-reaper-relearn. Updated run.py and presets.py path references accordingly. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-15 17:51:05 -04:00
parent e58f06d9fa
commit 7ecc718f5d
2256 changed files with 11 additions and 5 deletions
@@ -0,0 +1,6 @@
+= Helgobox Reference
+:experimental:
+
+This reference is written in AsciiDoc and follows the directory conventions of the documentation site generator link:https://antora.org/[Antora].
+
+A good place to start is link:modules/ROOT/pages/introduction.adoc[].
@@ -0,0 +1,10 @@
+name: helgobox
+title: Helgobox Reference
+version: ~
+nav:
+  - modules/ROOT/nav.adoc
+start_page: introduction.adoc
+asciidoc:
+  attributes:
+    # For making menu and button macros work
+    experimental: true
@@ -0,0 +1,18 @@
+* xref:introduction.adoc[]
+* xref:products.adoc[]
+* xref:installation.adoc[]
+* xref:key-concepts.adoc[]
+* xref:plug-in.adoc[]
+** xref:plug-in/user-interface.adoc[]
+*** xref:plug-in/user-interface/welcome-dialog.adoc[]
+*** xref:plug-in/user-interface/menu-bar.adoc[]
+* xref:app.adoc[]
+** xref:app/user-interface.adoc[]
+*** xref:app/user-interface/general.adoc[]
+*** xref:app/user-interface/title-bar.adoc[]
+*** xref:app/user-interface/navigation-bar.adoc[]
+*** xref:app/user-interface/settings-dialog.adoc[]
+*** xref:app/user-interface/keyboard-shortcuts.adoc[]
+*** xref:app/user-interface/cli.adoc[]
+* xref:reaper-actions.adoc[]
+* xref:configuration-files.adoc[]
@@ -0,0 +1,88 @@
+= Helgobox App
+
+.What is the Helgobox App?
+____
+include::partial$app-desc.adoc[]
+____
+
+Have you created an xref:key-concepts.adoc#instance[] of the xref:plug-in.adoc[] already? Good. Then you can connect to it with the _Helgobox App_.
+
+You can run the app in two ways: *Embedded* or *Remote*
+
+[[app-embedded-mode]]
+== Embedded mode
+
+Each Helgobox xref:key-concepts.adoc#instance[] can display its own xref:app.adoc[] window, directly embedded into REAPER:
+
+. Open the desired xref:plug-in.adoc[] instance
+. Press menu:Menu[Show App]
+
+Embedded mode is the recommended way to run the app. It offers seamless integration with REAPER.
+
+[[app-remote-mode]]
+== Remote mode
+
+There's an additional way to use the app: To run it as a separate program that connects with REAPER over a network connection.
+
+=== Use cases
+
+Running the app in remote mode opens up interesting possibilities.
+
+Crash protection::
+You can start the app on the same machine, but outside of REAPER.
+If it crashes for some reason, only the app itself will crash.
+REAPER and the xref:plug-in.adoc[] will continue running. It's similar to running plug-ins in REAPER in bridged mode. This could be interesting for live scenarios.
+
+Additional views::
+You can open additional app windows on the same machine and connect them to the same xref:key-concepts.adoc#instance[]. This gives you multiple views on the same instance.
+
+Performance optimization::
+You can run the app on an extra computer and connect it to REAPER on the main machine. This way, you can be sure that the app doesn't take any valuable processing power away from REAPER and the xref:plug-in.adoc[].
+
+Touch screen operation::
+Maybe your main machine is a powerful Mac mini standing somewhere further away from you. You could take a Windows tablet (and in the future an iOS or Android tablet) and run the app there, connecting to your main machine.
+
+Running Playtime on Linux (temporarily)::
+Playtime's Linux support is currently limited to remote mode. Embedded mode is still in the works.
+
+=== How to do it
+
+Here's what you need to do to run the app in remote mode.
+
+==== Starting the server
+
+To allow connections to Helgobox from computers in the same network, you need to start the xref:plug-in/user-interface/menu-bar.adoc#server[Helgobox Server].
+
+. Open the xref:plug-in.adoc[]
+. Press menu:Menu[Server > Enable and start!]
+
+You need to do this only once. Next time you start REAPER and Helgobox, the server will start automatically!
+
+==== Starting the app
+
+Just like the plug-in, the app is part of the Helgobox installation and is located in your REAPER resource directory:
+
+. Open an arbitrary instance of the xref:plug-in.adoc[]
+
+.Hello, Playtime for Linux testers!
+TIP: If you are here because you want to try Playtime for Linux *Stage 1*, pressing the image:playtime::screenshots/playtime-toolbar-icon.png[Playtime,width=50, pdfwidth=8mm] button should already have created a "Playtime" track for you, along with a xref:plug-in.adoc[] instance. Simply open that existing one!
+. Press menu:Menu[Server > Open app folder]
+. Start the app executable:
+[horizontal]
+Windows:: `helgobox.exe`
+macOS:: `Contents/MacOS/helgobox`
+Linux:: `helgobox`
+
+By default, the app connects to the REAPER process running on the _same machine_ (to the xref:plug-in/user-interface/menu-bar.adoc#server[Helgobox Server] running in that process, to be accurate). You can change that by running the app with special xref:app/user-interface/cli.adoc[command line arguments].
+
+Also by default, the app connects to the first xref:key-concepts.adoc#instance[] running in that REAPER process. You can switch to another instance (within the same process) by pressing  the xref:app/user-interface/navigation-bar.adoc#navbar-pick-instance[] button or by running the app with special xref:app/user-interface/cli.adoc[command line arguments].
+
+.Copying the app directory somewhere else
+[CAUTION]
+====
+You may copy the app directory to another location or even to another computer. However, you should renew your copy whenever you update Helgobox! An update often contains both a new version of the xref:plug-in.adoc[] **and** a new version of the xref:app.adoc[].
+
+If you connect the app to a plug-in and the versions don't match, you will see the following error message:
+
+> Host API version doesn't match
+====
@@ -0,0 +1,8 @@
+= User interface
+
+Unlike the xref:plug-in.adoc[], the App offers a modern and fancy user interface.
+At the moment, it primarily provides the user interface for xref:playtime::introduction.adoc[Playtime], but it will contain more stuff in the future.
+
+.App window
+image::generated/screenshots/main/home-screen.png[]
+
@@ -0,0 +1,9 @@
+= About dialog
+
+This dialog appears when you click the xref:app/user-interface/help-menu.adoc#title-bar-about[] button in the help menu.
+
+image::generated/screenshots/main/about.png[]
+
+The version number displayed here is the version of the xref:app.adoc[], not the one of the controlled xref:plug-in.adoc[]! _App_ and _plug-in_ are often updated together, but that's not always the case. They can evolve independently.
+
+The app version number is most relevant when running the app in xref:app.adoc#app-remote-mode[].
@@ -0,0 +1,58 @@
+= Command line interface
+
+When running in xref:app.adoc#app-remote-mode[], the app session can optionally be configured using command line arguments.
+
+== Synopsis
+
+*helgobox* [_OPTIONS_]
+
+== Options
+
+--connection=<URL>::
+URL that decides how the app connects to the xref:plug-in.adoc[].
+
+
+.Connection examples
+[cols="1,2"]
+|===
+|
+`grpc:://localhost:39051` +
+`grpc:://127.0.0.1:39051`
+|
+Connects to the plug-in running on the same machine, assuming a xref:configuration-files.adoc#realearn-ini[standard server configuration] (`server_grpc_port=39051`).
+
+This is the default if the connection option is omitted.
+
+|
+`grpc:://winpc:39051` +
+`grpc:://192.168.1.47:39051`
+|
+Connects to the plug-in running on the machine with the host name `winpc` or the IP address 192.168.1.47.
+|===
+
+--location::
+Path that decides which page is shown initially.
+
+This is not a file system path. It's comparable to the path of a URL that you would see in a web browser's address bar.
+
+
+.Location examples
+[cols="1,2"]
+|===
+|
+`/instance/apc/projection`
+|
+Opens the xref:realearn::user-interface/projection.adoc[projection page] for the xref:key-concepts.adoc#instance[] with xref:key-concepts.adoc#instance-key[] `apc`.
+
+|
+`/instance/3/playtime`
+|
+Opens the xref:playtime::user-interface.adoc[Playtime] page for the xref:key-concepts.adoc#instance[] with xref:key-concepts.adoc#instance-id[] *3*.
+
+Numbers are always interpreted as instance IDs and strings as instance keys. Normally, you want to use an xref:key-concepts.adoc#instance-key[instance key] to refer to the desired instance, because instance IDs are likely to change after restarting REAPER.
+
+
+|===
+
+--help::
+Displays an overview of all supported command line options.
@@ -0,0 +1,59 @@
+= General usage
+
+This page describes the basic usage of common user interface elements in the Helgobox app.
+
+[[drag-field]]
+== Drag field
+
+image::playtime::generated/screenshots/elements/toolbar/tempo.png[]
+
+A drag field allows you to adjust numeric values in various ways.
+
+include::partial$app/user-interface/interactions/mouse-dragging.adoc[]
+include::partial$app/user-interface/interactions/mouse-wheel-scrolling.adoc[]
+include::partial$app/user-interface/interactions/touchpad-panning.adoc[]
+include::partial$app/user-interface/interactions/text-entry.adoc[]
+include::partial$app/user-interface/interactions/reset-to-default.adoc[]
+include::partial$app/user-interface/interactions/fine-adjustment.adoc[]
+
+== Knob
+
+image::playtime::generated/screenshots/elements/toolbar/play-rate.png[]
+
+A knob allows you to adjust numeric values in various ways.
+
+include::partial$app/user-interface/interactions/mouse-dragging.adoc[]
+include::partial$app/user-interface/interactions/mouse-wheel-scrolling.adoc[]
+include::partial$app/user-interface/interactions/touchpad-panning.adoc[]
+include::partial$app/user-interface/interactions/text-entry.adoc[]
+include::partial$app/user-interface/interactions/reset-to-default.adoc[]
+include::partial$app/user-interface/interactions/fine-adjustment.adoc[]
+
+== Slider
+
+image::playtime::generated/screenshots/elements/track-panel/volume.png[]
+
+A slider allows you to adjust numeric values in various ways.
+
+include::partial$app/user-interface/interactions/mouse-dragging.adoc[]
+include::partial$app/user-interface/interactions/mouse-wheel-scrolling.adoc[]
+include::partial$app/user-interface/interactions/touchpad-panning.adoc[]
+include::partial$app/user-interface/interactions/reset-to-default.adoc[]
+
+== Search list
+
+image::playtime::generated/screenshots/main/sequences.png[]
+
+Search lists allow you to pick an item from a potentially large list.
+
+icon:search[] Search::
+Simply enter text to drill the list down to items matching your search text.
+
+icon:keyboard-o[] Navigate::
+Press kbd:[↑] or kbd:[↓] to navigate within the list of items.
+
+↕ Scroll::
+Scroll within the list using the scrollbar on the right or using the mousewheel.
+
+icon:mouse-pointer[] Select::
+Click the item or press kbd:[Enter] to select it.
@@ -0,0 +1,13 @@
+= Help menu
+
+This menu appears when clicking the xref:app/user-interface/title-bar.adoc#title-bar-help[] button in the window title bar.
+
+include::partial$generated/menus/help/open-helgobox-reference.adoc[]
+
+include::partial$generated/menus/help/open-helgobox-website.adoc[]
+
+include::partial$generated/menus/help/highlight-screen-areas.adoc[]
+
+include::partial$generated/menus/help/about.adoc[]
+
+See xref:app/user-interface/about-dialog.adoc[].
@@ -0,0 +1,44 @@
+= Keyboard shortcuts
+
+Within the app, you can use the following keyboard shortcuts.
+
+|===
+|Shortcut |Purpose
+
+|[[esc,Esc]] kbd:[Esc]
+|Hides the app window.
+
+Hiding the window doesn't completely unload the app, it really just hides the window.
+
+|kbd:[F]
+|Toggles full-screen mode.
+
+|kbd:[F1]
+|Opens online help for the element that is currently under the mouse cursor.
+
+|kbd:[Shift+Cmd/Ctrl+H]
+|Executes the REAPER action xref:helgobox::reaper-actions.adoc#toggle-app-focus[].
+
+|===
+
+Depending on the currently selected page, more keyboard shortcuts are available:
+
+- xref:playtime::user-interface/keyboard-shortcuts.adoc[Playtime shortcuts]
+
+[TIP]
+====
+**Normal REAPER's keyboard shortcuts are generally disabled when the app is focused!**
+
+This prevents conflicts and ensures flexibility for adding more app shortcuts in the future.
+
+If you want to use a certain REAPER shortcut while the app is focused, you must make it global:
+
+. Open menu:Actions[Show action list...]
+. Press btn:[Find shortcut...]
+. Press the shortcut key
+
+The action list should jump to the action mapped to that key.
+. Double-click the desired shortcut in the "Shortcuts for selected action" list
+. Change the property "Scope" to **Global**
+. Press btn:[OK]
+====
@@ -0,0 +1,22 @@
+= Navigation bar
+
+The bar on the left is the _Navigation bar_.
+
+Its main purpose is to switch between different pages.
+You can show or hide it using the xref:app/user-interface/title-bar.adoc#title-bar-toggle-nav-bar[] button in the xref:app/user-interface/title-bar.adoc[].
+
+include::partial$generated/elements/navbar/home.adoc[]
+
+include::partial$generated/elements/navbar/projection.adoc[]
+
+include::partial$generated/elements/navbar/playtime.adoc[]
+
+include::partial$generated/elements/navbar/enable-disable-global-control.adoc[]
+
+See xref:realearn::further-concepts/instance.adoc#auto-units[].
+
+include::partial$generated/elements/navbar/show-helgobox-plugin.adoc[]
+
+include::partial$generated/elements/navbar/pick-instance.adoc[]
+
+This is only displayed if you run the app in xref:app.adoc#app-remote-mode[].
@@ -0,0 +1,50 @@
+= Settings dialog
+
+The dialog allows you to adjust the majority of global settings for Helgobox and its contained products.
+You can open it by pressing the xref:app/user-interface/title-bar.adoc#title-bar-settings[] button in the xref:app/user-interface/title-bar.adoc[].
+
+image::generated/screenshots/main/settings.png[]
+
+For a description of the product-specific settings, see:
+
+* xref:realearn::user-interface/settings-dialog.adoc[ReaLearn settings]
+* xref:playtime:ROOT:user-interface/dialogs/settings-dialog.adoc[Playtime settings]
+
+== Appearance
+
+include::partial$generated/elements/settings/overall-size.adoc[]
+
+include::partial$generated/elements/settings/roundness.adoc[]
+
+.For Playtime users
+TIP: If you want slot cells with rounded corners, play with the xref:playtime:ROOT:user-interface/dialogs/settings-dialog.adoc#settings-cell-color-position[] setting!
+
+include::partial$generated/elements/settings/prefer-tidy-appearance.adoc[]
+
+include::partial$generated/elements/settings/display-development-status-hints.adoc[]
+
+include::partial$generated/elements/settings/display-tooltip-if-help-panel-hidden.adoc[]
+
+include::partial$generated/elements/settings/display-license-info.adoc[]
+
+include::partial$generated/elements/settings/prefer-native-popup-menus.adoc[]
+
+include::partial$generated/elements/settings/theme-mode.adoc[]
+
+include::partial$generated/elements/settings/use-context-coloring.adoc[]
+
+include::partial$generated/elements/settings/use-host-colors.adoc[]
+
+include::partial$generated/elements/settings/contrast.adoc[]
+
+include::partial$generated/elements/settings/custom-color-rendering.adoc[]
+
+include::partial$generated/elements/settings/color-scheme.adoc[]
+
+== Title bar
+
+include::partial$generated/elements/settings/dim-opacity.adoc[]
+
+== Shortcuts
+
+include::partial$generated/elements/settings/hide-window-when-escape-pressed.adoc[]
@@ -0,0 +1,55 @@
+= Title bar
+
+The bar on the top of the app window is the _Title bar_.
+It primarily provides general functions, such as window controls, access to settings, and quick access to the REAPER transport.
+
+image::generated/screenshots/elements/area/window-title-bar-0.png[]
+
+include::partial$generated/elements/title-bar/close-window.adoc[]
+
+This has the same effect as pressing xref:helgobox::plug-in/user-interface/menu-bar.adoc#close-app[].
+
+include::partial$generated/elements/title-bar/full-screen.adoc[]
+
+include::partial$generated/elements/title-bar/move-window.adoc[]
+
+include::partial$generated/elements/title-bar/toggle-nav-bar.adoc[]
+
+include::partial$generated/elements/title-bar/theme-mode.adoc[]
+
+include::partial$generated/elements/title-bar/dim.adoc[]
+
+The opacity of the opaque window can be adjusted via xref:app/user-interface/settings-dialog.adoc#settings-dim-opacity[].
+
+include::partial$generated/elements/title-bar/settings.adoc[]
+
+See xref:app/user-interface/settings-dialog.adoc[].
+
+include::partial$generated/elements/title-bar/refresh.adoc[]
+
+include::partial$generated/elements/title-bar/undo.adoc[]
+
+include::partial$generated/elements/title-bar/redo.adoc[]
+
+include::partial$generated/elements/title-bar/theme-switcher.adoc[]
+
+Themes are simply pre-selected combinations of various appearance settings.
+Once you’ve selected a theme, you can further customize it by adjusting the settings.
+
+include::partial$generated/elements/title-bar/panic-midi.adoc[]
+
+include::partial$generated/elements/title-bar/save-project.adoc[]
+
+include::partial$generated/elements/title-bar/play-arrangement.adoc[]
+
+include::partial$generated/elements/title-bar/stop-arrangement.adoc[]
+
+include::partial$generated/elements/title-bar/pause-arrangement.adoc[]
+
+include::partial$generated/elements/title-bar/help.adoc[]
+
+See xref:app/user-interface/help-menu.adoc[].
+
+include::partial$generated/elements/title-bar/helgobox-info.adoc[]
+
+See xref:key-concepts.adoc#instance-id[].
@@ -0,0 +1,34 @@
+= Configuration files
+
+Helgobox creates and/or reads a few files in REAPER's resource directory.
+
+For product-specific configuration files, please refer to:
+
+* xref:realearn::configuration-files.adoc[ReaLearn configuration files]
+* xref:playtime::configuration-files.adoc[Playtime configuration files]
+
+Helgobox itself maintains the following files:
+
+`Data/helgoboss`:: Directory which contains data such as presets or resources that need to be distributed via ReaPack
+
+`Data/helgoboss/archives`:: Directory which contains archives e.g. the compressed app, distributed via ReaPack
+
+`Data/helgoboss/doc`:: Contains offline documentation as PDFs
+
+`Helgoboss`:: Directory which contains user-specific or device-specific data, not touched via ReaPack
+
+`licensing.json`:: Contains license keys
+
+`Helgoboss/App/bin`:: Contains the uncompressed xref:app.adoc[], if installed
+
+`Helgoboss/App/etc/settings.json`:: Contains the global settings for Helgobox and all of its contained products
+
+`Helgoboss/Pot/previews`:: Directory which contains previews recorded by xref:products.adoc#pot-browser[Pot Browser]
+
+`Helgoboss/Server/certificates`:: Contains a list of certificates and corresponding private keys in order to allow encrypted communication with ReaLearn Companion and App.
+
+[[realearn-ini]] `Helgoboss/ReaLearn/realearn.ini`:: Very basic global configuration.
+The reference to ReaLearn is there just for historical reasons.
+Most properties in here affect Helgobox as a whole.
+
+Currently supported properties: `server_enabled`, `server_http_port`, `server_https_port`, `server_grpc_port`, `companion_web_app_url`, `showed_welcome_screen`, `background_colors_enabled`
@@ -0,0 +1,186 @@
+= Installation
+:plugin-name: "VSTi: Helgobox - ReaLearn & Playtime (Helgoboss)"
+:package-name: "Helgobox: ReaLearn & Playtime"
+
+Helgobox is provided as https://reapack.com/[ReaPack] package.
+ReaPack is a popular 3rd-party package manager for REAPER that makes installing add-ons easy and keeps your installation up to date effortlessly.
+
+== System requirements
+
+Please check below system requirements before attempting to install Helgobox!
+
+=== REAPER
+
+* Playtime needs REAPER 7.23 or later
+* ReaLearn works acceptably with older REAPER versions, but it works better with REAPER 7.23 or later
+
+[[windows]]
+=== Windows
+
+* xref:plug-in.adoc[] needs Windows 7 or later
+* xref:app.adoc[] needs Windows 8 or later
+
+[[macos]]
+=== macOS
+
+* xref:plug-in.adoc[] needs macOS 10.12 or later
+* xref:app.adoc[] needs macOS 10.15 or later
+* For macOS 10.14 or later, all below-mentioned installation options should work
+* **For macOS 10.13 or earlier, installation via installer is not supported.
+You need to install via ReaPack!**
+
+[[linux]]
+=== Linux
+
+* On x64 architecture: Needs at least glibc v2.31 (for example, Ubuntu 20+, Debian 11+)
+* On arm64 architecture: Needs at least glibc v2.35 (for example, Ubuntu 22+, Debian 12+)
+* **Installation via installer is not supported.
+You need to install via ReaPack!**
+* Needs libxdo.
+You can install it like this:
+
+[source,shell]
+.Debian, Ubuntu
+----
+sudo apt-get install -y libxdo-dev
+----
+
+[source,shell]
+.openSUSE
+----
+sudo zypper install xdotool
+----
+* Other dependencies that you might need to install manually, depending on your Linux distribution: `libx11`, `libstdc++`, `libudev`
+* If {plugin-name} isn't available after installation, REAPER failed to scan it. And that is most likely due to a missing dependency. In that case, please link:https://github.com/helgoboss/helgobox/issues/503#issuecomment-1320964181[try this to analyze the issue] and send the result to info@helgoboss.org.
+
+IMPORTANT: If you want to use a _Stream Deck_ controller with ReaLearn on Linux, xref:realearn::sources/stream-deck.adoc#linux[more setup] is necessary.
+
+NOTE: A more detailed system compatibility table can be found link:https://www.helgoboss.org/projects/helgobox#requirements[here].
+
+== Installing Helgobox
+
+Please choose:
+
+[loweralpha]
+. <<installer>>
+. <<i-have-reapack>>
+. <<i-want-to-install-reapack>>
+. <<install-without-reapack>>
+
+[[installer]]
+=== I want an installer 👍
+
+For users who don't have ReaPack installed already, there's a **convenient installer** that automatically installs both ReaPack and Helgobox.
+It gets you up and running in no time, supporting even portable REAPER installations!
+
+You can use it if you have Windows 7+ or macOS 10.14+.
+
+Simply press the following link and follow the instructions: link:https://reaboot.com/install/https%3A%2F%2Fraw.githubusercontent.com%2Fhelgoboss%2Fhelgobox%2Fmaster%2Freaboot.json[Install Helgobox]
+
+[[i-have-reapack]]
+=== I have ReaPack and want to use it to install Helgobox
+
+Here's how you can install Helgobox via ReaPack:
+
+. In REAPER, select menu:Extensions[ReaPack > Import repositories…]
+. Copy and paste the following repository URL into the text area:
+
+ https://github.com/helgoboss/reaper-packages/raw/master/index.xml
+
+. Select menu:Extensions[ReaPack > Browse packages…]
+. Search for `helgobox`
+. Right mouse click on the package {package-name} and choose menu:Install…[]
+. Press btn:[OK] or btn:[Apply]
+. Restart REAPER
+
+[[i-want-to-install-reapack]]
+=== I don't have ReaPack but want to use it to install Helgobox
+
+. Install ReaPack, following the link:https://reapack.com/user-guide[installation section of its user guide]
+. Restart REAPER
+. Follow the instructions in <<i-have-reapack>>
+
+[[install-without-reapack]]
+=== I want to install Helgobox manually, without ReaPack
+
+If you are more the download type of person, you can find the latest `dll`, `dylib` and `so` files here at GitHub on the https://github.com/helgoboss/helgobox/releases[releases page] for manual installation.
+
+You also must install Helgobox manually if you plan to use it in both REAPER for Windows 32-bit and REAPER for Windows 64-bit because then it's important to use two separate VST plug-in directories.
+
+== Validating the installation
+
+You know that Helgobox is installed successfully if you see the menu menu:Extensions[Helgobox].
+
+In addition, you should see a plug-in entry {plugin-name} after right-clicking the empty area of REAPER's track panel and choosing menu:Insert virtual instrument on new track...[].
+
+NOTE: On Helgobox for Linux, the extension menu entry doesn't exist yet.
+But the plug-in should be there.
+
+== Troubleshooting
+
+=== Helgobox plug-in doesn't appear in the list of plug-ins
+
+If the plug-in {plugin-name} doesn't appear in the list of plug-ins, please proceed as follows:
+
+. If you are on Linux, make sure to follow the <<linux, installation instructions for Linux>>!
+
+. Make sure that Helgobox runs as native plug-in!
+** By default, each plug-in runs as native plug-in.
+If not, you probably changed the configuration at some point.
+** You can fix that by right-clicking {plugin-name} in the plug-in list and select menu:Run as[Native only (prevent bridging)].
+** It's technically impossible to run Helgobox as a bridged plug-in!
+
+TIP: If none of these suggestions help, link:https://github.com/helgoboss/helgobox/issues/new/choose[please report a bug]!
+
+[[updating-helgobox]]
+== Updating Helgobox
+
+Helgobox development moves fast!
+To take advantage of the latest features, improvements and fixes, you should check the link:https://www.helgoboss.org/projects/helgobox[Helgobox homepage] for updates from time to time.
+
+Here's how you can install the latest stable Helgobox version:
+
+. Run menu:Extensions[ReaPack > Synchronize packages]
+** ReaPack will show you a summary at the end, which tells you whether a new Helgobox version has been installed.
+. Restart REAPER
+
+If <<installer,supported on your system>>, you can alternatively just run the link:https://www.helgoboss.org/projects/helgobox#download[Helgobox installer app] again.
+
+[[downgrading-helgobox]]
+== Downgrading Helgobox
+
+Downgrading is easily possible via ReaPack as well.
+
+.Be careful when saving projects after updates or downgrades!
+[CAUTION]
+====
+It is not guaranteed that projects saved with newer versions can still be opened with older versions of Helgobox! Even if it works, saving a project with that older version might overwrite changes that you made in the newer version. That's why Helgobox will warn you in this case.
+
+If your project is crucial, it is recommended to make a backup before re-saving it with another version.
+====
+
+. menu:Extensions[ReaPack > Browse packages...]
+. Right-click the package {package-name} and navigate to the submenu menu:Versions[]
+. Select the desired old version
+. Press btn:[OK] or btn:[Apply]
+. Restart REAPER
+
+
+[[pre-releases]]
+== Testing new features and improvements
+
+If you want to get access to cutting-edge but untested versions of Helgobox, you can install Helgobox pre-releases.
+
+=== Install a specific pre-release of Helgobox
+
+. menu:Extensions[ReaPack > Browse packages...]
+. Right-click the package {package-name} and navigate to the submenu menu:Versions[]
+. Select the desired pre-release version (versions containing `-pre` or `-rc`)
+. Press btn:[OK] or btn:[Apply]
+. Restart REAPER
+
+=== Enable pre-releases globally
+
+. menu:Extensions[ReaPack > Manage repositories]
+. menu:Options…[Enable pre-releases globally (bleeding edge)]
+. After that, whenever you synchronize packages, you will get the latest stuff.
@@ -0,0 +1,19 @@
+= Introduction
+
+include::helgobox::partial$intro-header.adoc[]
+
+|===
+|Last update of text: |`2025-03-15 (v2.18.0)`
+|Last update of screenshots: |`2025-03-15 (v2.18.0)`
+|===
+
+link:https://www.helgoboss.org/projects/helgobox[Helgobox] is an add-on for link:https://www.reaper.fm[REAPER] that unites xref:products.adoc[a few creative tools] under one roof, most importantly link:https://www.helgoboss.org/projects/realearn[ReaLearn] and link:https://www.helgoboss.org/projects/playtime[Playtime].
+
+It consists of two technical components:
+
+xref:plug-in.adoc[]::
+include::partial$plug-in-desc.adoc[]
+xref:app.adoc[]::
+include::partial$app-desc.adoc[]
+
+include::partial$product-specific-info.adoc[]
@@ -0,0 +1,27 @@
+= Key concepts
+
+[[instance]]
+== Instance
+
+Helgobox is an instrument plug-in.
+That means you can add multiple instances of it, just as you would add multiple instances of a synth or effect.
+For example, you could place one instance on the monitoring FX chain and two instances somewhere in your project.
+
+[[instance-id]]
+== Instance ID
+
+A *randomly assigned*, *non-persistent* identifier that identifies a particular <<instance>> and is *guaranteed to be unique* within one REAPER session.
+
+CAUTION: This ID can change after a restart of REAPER! If you are looking for something that doesn't change, use the <<instance-key>>.
+
+[[instance-key]]
+== Instance key
+
+A *user-defined*, *persistent* identifier that identifies a particular <<instance>>.
+The instance key gets relevant if you want to connect to an instance from an xref:app.adoc[] running in xref:app.adoc#app-remote-mode[].
+
+You can change the instance key of an instance by changing the xref:realearn::further-concepts/unit.adoc#unit-key[] of the instance's xref:realearn::key-concepts.adoc#unit[main unit] -- they are the same.
+
+
+.Make your instance keys unique!
+CAUTION: Because the instance key is user-defined, uniqueness can't be guaranteed. For example, if you just copy and paste a Helgobox FX instance, you end up with two instances that have the same key. You should avoid this.
@@ -0,0 +1,27 @@
+= Helgobox Plug-In
+
+.What is the Helgobox Plug-In?
+____
+include::partial$plug-in-desc.adoc[]
+It is complemented by the xref:app.adoc[].
+____
+
+== Adding a new plug-in instance
+
+The plug-in is fired up just like any other VST instrument in REAPER: By adding an instance of it to an FX chain:
+
+. Right-click the empty space in REAPER's track control panel
+. Select menu:Insert virtual instrument on new track...[]
+. Double-click entry "VSTi: Helgobox - ReaLearn & Playtime (Helgoboss)"
+
+Initially, you see the xref:plug-in/user-interface.adoc[plug-in window].
+
+== Opening an existing plug-in instance
+
+To open an existing plug-in instance:
+
+1. Scroll to the REAPER track which contains the instance.
+2. Press the btn:[FX] button of that track. This opens the track's FX chain.
+3. Click on the Helgobox FX instance.
+
+You will see the xref:plug-in/user-interface.adoc[plug-in window] again.
@@ -0,0 +1,9 @@
+= User interface
+
+The plug-in's native user interface features a plain and simple design.
+It mainly hosts link:https://www.helgoboss.org/projects/realearn[ReaLearn], the controller integration tool of Helgobox.
+
+include::partial$realearn-specific-ui-elements.adoc[]
+
+.Plug-in window
+image::screenshots/plugin-window.png[]
@@ -0,0 +1,58 @@
+= Menu bar
+
+include::partial$realearn-specific-ui-elements.adoc[]
+
+== Menu button
+
+This opens the main menu of Helgobox/ReaLearn.
+The same menu opens when you right-click an empty area.
+
+It provides the following general entries.
+
+[[open-pot-browser]] Open Pot Browser::
+This will open Pot Browser.
+See xref:products.adoc#pot-browser[] for details.
+
+[[show-app]] Show App::
+Shows the xref:helgobox::app.adoc[] associated with this xref:helgobox::key-concepts.adoc#instance[].
+
+[[close-app]] Close App::
+Closes the xref:helgobox::app.adoc[] associated with this xref:helgobox::key-concepts.adoc#instance[].
+
+[[server]] Server::
+Helgobox features a built-in server which allows the xref:app.adoc[] (and the old ReaLearn Companion App) to connect to Helgobox.
+The server runs globally, not per instance!
+
+[[enable-and-start-server]] Enable and start!::: This starts the server and makes sure it will automatically be started next time you use Helgobox.
+
+Disable and stop!::: This stops the server and makes sure it will not be started next time you use Helgobox.
+
+Add firewall rule::: Attempts to add a firewall rule for making the server accessible from other devices or displays instructions on how to do it.
+
+Open app folder::: Opens the folder which contains the xref:app.adoc[] (in case you want to run it in xref:app.adoc#app-remote-mode[]).
+
+[[export-to-clipboard]]
+== Export to clipboard button
+
+Pressing the export button allows you to copy Helgobox settings to the clipboard so you can import them in another instance or edit them in a link:https://en.wikipedia.org/wiki/Text_editor[text editor].
+
+--
+The following list only describes the general-purpose menu entries. For the rest, see:
+
+* xref:realearn::user-interface/main-panel/menu-bar.adoc#export-to-clipboard-button[ReaLearn entries]
+* xref:playtime::user-interface/menus/export-to-clipboard-menu.adoc[Playtime entries]
+--
+
+Export instance as JSON::
+Copies a _complete_ dump of this xref:key-concepts.adoc#instance[] to the clipboard in JSON format.
+
+[[import-from-clipboard]]
+== Import from clipboard button
+
+Pressing the import button does the opposite: It restores whatever Helgobox dump is currently in the clipboard.
+It supports JSON or Luau.
+
+[[help]]
+== Help button (?)
+
+Provides links to the reference and other documentation.
@@ -0,0 +1,63 @@
+= Welcome dialog
+
+This dialog appears once after installing Helgobox and whenever you start the action xref:reaper-actions.adoc#show-welcome-screen[].
+
+image::helgobox::screenshots/welcome-dialog.png[width=500]
+
+== Checkbox "Add Playtime button to main toolbar"
+
+Lets you enable or disable a button in the main toolbar that starts xref:playtime::introduction.adoc[Playtime].
+
+== Error checkboxes
+
+Like any other complex piece of software, Helgobox might have link:https://en.wikipedia.org/wiki/Software_bug[bugs]. There are roughly two types of bugs: _Subtle_ bugs and _detectable_ bugs. Subtle bugs are very hard to investigate. Detectable bugs, however, are "great" because they contain an error message and give me (the developer) a clue of what went wrong. This clue is crucial because I need it to fix the bug.
+
+The error checkboxes let you decide what Helgobox does if it detects a _detectable_ bug. Let's say the bug occurs. Here's what happens, depending on your configuration:
+
+[cols="1,1,4"]
+|===
+|Send errors |Show errors | Effect
+
+|Off
+|Off
+|
+A small btn:[ERR] notification will show up in the REAPER title bar (easy to miss!). When you click it, you will see only very basic information about the error.
+
+|Off
+|On
+|
+A console window will appear with detailed information about the error and a plea to send this information to the developer manually.
+
+|On
+|Off
+|
+If you are online, Helgobox will send detailed information about the error to the developer (using the third-party error tracking service https://sentry.io[Sentry], see our https://www.helgoboss.org/privacy-statement[privacy statement]). In addition, a small btn:[ERR] notification will show up in the REAPER title bar. Clicking it will reveal further instructions.
+
+If you are offline, a console window will appear with detailed information about the error and a plea to send this information to the developer manually.
+
+|On
+|On
+|
+If you are online, Helgobox will send detailed information about the error to the developer and show a console window with further instructions.
+
+If you are offline, a console window will appear with detailed information about the error and a plea to send this information to the developer manually.
+|===
+
+.Recommendation
+[TIP]
+====
+I recommend enabling both checkboxes!
+
+Sending the error automatically makes sure that I learn about the error as soon as possible, even without your manual notification (I know that you are busy with other things than reporting errors icon:smile-o[]). It also means that the error message shown in the console gets much smaller, as Helgobox then only shows an error ID instead of the full info.
+
+Showing the error in the console in addition makes sure that you don't miss that something went wrong and offers you ways how to deal with the situation. In many cases, it helps if I get further information from you, such as instructions how to reproduce the error.
+====
+
+
+IMPORTANT: Unless you have a live situation (in which case it might make sense to ignore errors), please tick at least one of the checkboxes. I can't fix bugs if I don't know about them! Thanks.
+
+== Checkbox "Notify about updates"
+
+By default, Helgobox checks on startup for available updates. If a more recent version is available, you will see a notification somewhere in the xref:helgobox::plug-in/user-interface.adoc[plug-in window] and the xref:app/user-interface.adoc[app window].
+
+If you don't want ReaLearn to check for updates, you can disable it here.
@@ -0,0 +1,39 @@
+= Contained products
+
+Helgobox provides the framework for the following products.
+
+[[realearn]]
+== ReaLearn
+
+link:https://www.helgoboss.org/projects/realearn[ReaLearn] is a versatile controller integration tool for REAPER.
+It lies at the very core of Helgobox, as controller integration is a key aspect of all the other products it contains.
+
+xref:realearn::introduction.adoc[→ Read more about ReaLearn]
+
+[[playtime]]
+== Playtime
+
+link:https://www.helgoboss.org/projects/playtime[Playtime] is a modern session view / clip launcher for REAPER, built straight into Helgobox.
+Each xref:key-concepts.adoc#instance[Helgobox Instance] may contain one xref:playtime::key-concepts.adoc#matrix[] (by default not loaded).
+
+xref:playtime::introduction.adoc[→ Read more about Playtime]
+
+[[pot-browser]]
+== Pot Browser
+
+Pot Browser is an experimental modern preset browser built straight into Helgobox.
+It's just a prototype so far.
+It will probably look quite different in the future.
+You can open it via menu action xref:plug-in/user-interface/menu-bar.adoc#open-pot-browser[].
+
+It's recommended to use Pot Browser from a ReaLearn instance on the monitoring FX chain, that way you have the browser accessible from any project.
+
+TIP: Add a toolbar button which triggers the REAPER action "ReaLearn: Open first Pot Browser" to get quick and convenient access to the browser.
+
+Remarks:
+
+- Pot Browser is in an experimental stage, it doesn't save any of your settings!
+- Each Helgobox instance can have one _Pot Unit_ (by default not loaded).
+Each Pot Unit has its own filter and preset state.
+When you open the Pot Browser from an instance, it connects to the Pot Unit of that instance.
+- ReaLearn's "Pot" targets such as xref:realearn::targets/pot/browse-presets.adoc[] can be used to control the Pot Unit from any controller.
@@ -0,0 +1,23 @@
+= REAPER actions
+
+== General actions
+
+Helgobox provides a few global REAPER actions.
+
+You can find those actions directly in the menu menu:Extensions[Helgobox].
+Alternatively, search for "helgobox" in REAPER's action list (menu:Actions[Show action list...]).
+
+[[show-welcome-screen]] Helgobox/General: Show welcome screen::
+Shows the xref:plug-in/user-interface/welcome-dialog.adoc[] that was displayed after the first installation of Helgobox.
+
+[[toggle-app-focus]] Helgobox/General: Toggle app focus::
+Switches focus between REAPER and the xref:app.adoc[].
+
+The default shortcut is kbd:[Shift+Cmd/Ctrl+H].
+
+== Product-specific actions
+
+The products contained in Helgobox provide additional actions:
+
+- xref:realearn::reaper-actions.adoc[ReaLearn actions]
+- xref:playtime::reaper-actions.adoc[Playtime actions]
@@ -0,0 +1,2 @@
+A complement to the xref:plug-in.adoc[] which provides a modern user interface.
+It runs embedded in REAPER or as a separate program that connects to REAPER. Mobile versions for iOS and Android are planned.
@@ -0,0 +1,2 @@
+Fine adjustments::
+Hold the kbd:[Cmd/Ctrl] key while dragging, scrolling or panning in order to do fine adjustments.
@@ -0,0 +1,4 @@
+icon:mouse-pointer[] Mouse dragging::
+Click and hold the left mouse button, then drag the mouse up or down to increase or decrease the value.
+Release the button when finished.
+Most elements update the value in real-time as you drag, while others apply the change only after you release the mouse button.
@@ -0,0 +1,3 @@
+↕ Mouse wheel scrolling::
+Move the mouse wheel up or down to increase or decrease the value. footnote:wheel-direction[Depending on your operating system settings, the mouse wheel directions might be reversed.]
+The new value will be applied immediately.
@@ -0,0 +1,2 @@
+Reset to default::
+Double-click the element to restore the default value.
@@ -0,0 +1,3 @@
+icon:keyboard-o[] Enter text::
+Right-click the element and enter the value via keyboard.
+Press kbd:[Enter] or click somewhere else to apply the value.
@@ -0,0 +1,2 @@
+icon:hand-peace-o[] Touchpad panning::
+If you have a touchpad, place the cursor over the element and slide up or down with two fingers to increase or decrease the value.
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[area-nav-bar-0,Navigation bar]]]
+ifndef::pdf-theme[[[area-nav-bar-0,Navigation bar image:helgobox::generated/screenshots/elements/area/nav-bar-0.png[width=50, pdfwidth=8mm]]]]
+== Navigation bar
+
+image::helgobox::generated/screenshots/elements/area/nav-bar-0.png[Navigation bar, role="related thumb right", float=right]
+
+
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[area-window-title-bar-0,Title bar]]]
+ifndef::pdf-theme[[[area-window-title-bar-0,Title bar image:helgobox::generated/screenshots/elements/area/window-title-bar-0.png[width=50, pdfwidth=8mm]]]]
+== Title bar
+
+image::helgobox::generated/screenshots/elements/area/window-title-bar-0.png[Title bar, role="related thumb right", float=right]
+
+
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[navbar-enable-disable-global-control,Enable/disable global control]]]
+ifndef::pdf-theme[[[navbar-enable-disable-global-control,Enable/disable global control image:helgobox::generated/screenshots/elements/navbar/enable-disable-global-control.png[width=50, pdfwidth=8mm]]]]
+== Enable/disable global control
+
+image::helgobox::generated/screenshots/elements/navbar/enable-disable-global-control.png[Enable/disable global control, role="related thumb right", float=right]
+
+Enables or disables the usage of global controllers for this Helgobox instance.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[navbar-home,Home]]]
+ifndef::pdf-theme[[[navbar-home,Home image:helgobox::generated/screenshots/elements/navbar/home.png[width=50, pdfwidth=8mm]]]]
+== Home
+
+image::helgobox::generated/screenshots/elements/navbar/home.png[Home, role="related thumb right", float=right]
+
+Shows the Helgobox welcome page.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[navbar-pick-instance,Pick another instance]]]
+ifndef::pdf-theme[[[navbar-pick-instance,Pick another instance image:helgobox::generated/screenshots/elements/navbar/pick-instance.png[width=50, pdfwidth=8mm]]]]
+== Pick another instance
+
+image::helgobox::generated/screenshots/elements/navbar/pick-instance.png[Pick another instance, role="related thumb right", float=right]
+
+Lets you pick another Helgobox instance.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[navbar-playtime,Playtime]]]
+ifndef::pdf-theme[[[navbar-playtime,Playtime image:helgobox::generated/screenshots/elements/navbar/playtime.png[width=50, pdfwidth=8mm]]]]
+== Playtime
+
+image::helgobox::generated/screenshots/elements/navbar/playtime.png[Playtime, role="related thumb right", float=right]
+
+Shows the Playtime Matrix associated with this Helgobox instance.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[navbar-projection,ReaLearn Projection]]]
+ifndef::pdf-theme[[[navbar-projection,ReaLearn Projection image:helgobox::generated/screenshots/elements/navbar/projection.png[width=50, pdfwidth=8mm]]]]
+== ReaLearn Projection
+
+image::helgobox::generated/screenshots/elements/navbar/projection.png[ReaLearn Projection, role="related thumb right", float=right]
+
+Shows the ReaLearn Projection page for this Helgobox instance.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[navbar-show-helgobox-plugin,Show Helgobox plug-in]]]
+ifndef::pdf-theme[[[navbar-show-helgobox-plugin,Show Helgobox plug-in image:helgobox::generated/screenshots/elements/navbar/show-helgobox-plugin.png[width=50, pdfwidth=8mm]]]]
+== Show Helgobox plug-in
+
+image::helgobox::generated/screenshots/elements/navbar/show-helgobox-plugin.png[Show Helgobox plug-in, role="related thumb right", float=right]
+
+Opens the Helgobox plug-in which is controlled by this app.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-color-scheme,Color scheme]]]
+ifndef::pdf-theme[[[settings-color-scheme,Color scheme]]]
+=== Color scheme
+
+image::helgobox::generated/screenshots/elements/settings/color-scheme.png[Color scheme]
+
+Choose the prominent color for the user interface.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-contrast,Contrast]]]
+ifndef::pdf-theme[[[settings-contrast,Contrast]]]
+=== Contrast
+
+image::helgobox::generated/screenshots/elements/settings/contrast.png[Contrast]
+
+Choose between multiple color variations that influence the perceived contrast of the app's appearance.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-custom-color-rendering,Custom color rendering]]]
+ifndef::pdf-theme[[[settings-custom-color-rendering,Custom color rendering]]]
+=== Custom color rendering
+
+image::helgobox::generated/screenshots/elements/settings/custom-color-rendering.png[Custom color rendering]
+
+Choose how to render user-defined colors, such as for tracks and clips.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-dim-opacity,Dim opacity]]]
+ifndef::pdf-theme[[[settings-dim-opacity,Dim opacity image:helgobox::generated/screenshots/elements/settings/dim-opacity.png[width=50, pdfwidth=8mm]]]]
+=== Dim opacity
+
+image::helgobox::generated/screenshots/elements/settings/dim-opacity.png[Dim opacity, role="related thumb right", float=right]
+
+Adjust how much to dim the Helgobox app window when pressing the dim button.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-display-development-status-hints,Display development status hints]]]
+ifndef::pdf-theme[[[settings-display-development-status-hints,Display development status hints]]]
+=== Display development status hints
+
+image::helgobox::generated/screenshots/elements/settings/display-development-status-hints.png[Display development status hints]
+
+If enabled, the inspector will display even settings that are not available yet and it will show small annotations about the development state of a feature.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-display-license-info,Display license info]]]
+ifndef::pdf-theme[[[settings-display-license-info,Display license info]]]
+=== Display license info
+
+image::helgobox::generated/screenshots/elements/settings/display-license-info.png[Display license info]
+
+If enabled, the licensee name will be displayed in the window title bar. This only affects commercial Helgobox products, such as Playtime.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-display-tooltip-if-help-panel-hidden,Display tooltip if help panel hidden]]]
+ifndef::pdf-theme[[[settings-display-tooltip-if-help-panel-hidden,Display tooltip if help panel hidden]]]
+=== Display tooltip if help panel hidden
+
+image::helgobox::generated/screenshots/elements/settings/display-tooltip-if-help-panel-hidden.png[Display tooltip if help panel hidden]
+
+If enabled and the help panel in the bottom right corner is not visible, a tooltip will be showed instead.
+
@@ -0,0 +1,10 @@
+ifdef::pdf-theme[[[settings-hide-window-when-escape-pressed,Hide window when escape pressed]]]
+ifndef::pdf-theme[[[settings-hide-window-when-escape-pressed,Hide window when escape pressed]]]
+=== Hide window when escape pressed
+
+image::helgobox::generated/screenshots/elements/settings/hide-window-when-escape-pressed.png[Hide window when escape pressed]
+
+If enabled, pressing escape if no dialog is open will hide the window.
+
+This will only have an effect when running embedded within REAPER.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-overall-size,Overall size]]]
+ifndef::pdf-theme[[[settings-overall-size,Overall size]]]
+=== Overall size
+
+image::helgobox::generated/screenshots/elements/settings/overall-size.png[Overall size]
+
+Adjust the overall size of the user interface, including the font size.
+
@@ -0,0 +1,13 @@
+ifdef::pdf-theme[[[settings-prefer-native-popup-menus,Prefer native popup menus (experimental)]]]
+ifndef::pdf-theme[[[settings-prefer-native-popup-menus,Prefer native popup menus (experimental)]]]
+=== Prefer native popup menus (experimental)
+
+image::helgobox::generated/screenshots/elements/settings/prefer-native-popup-menus.png[Prefer native popup menus (experimental)]
+
+If enabled, dropdown and right-click menus will be rendered using your system's native user interface component.
+[NOTE]
+.Development status: Feedback wanted!
+====
+This doesn't work particular well at the moment. On Windows, it has caused crashes in the past.
+====      
+
@@ -0,0 +1,10 @@
+ifdef::pdf-theme[[[settings-prefer-tidy-appearance,Prefer tidy appearance]]]
+ifndef::pdf-theme[[[settings-prefer-tidy-appearance,Prefer tidy appearance]]]
+=== Prefer tidy appearance
+
+image::helgobox::generated/screenshots/elements/settings/prefer-tidy-appearance.png[Prefer tidy appearance]
+
+If enabled, the inspector will show dropdown menus even if if they present just a handful of options. This looks more tidy but you will need two mouse clicks to choose an option.
+
+If disabled, it will show all options as buttons instead.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-roundness,Roundness]]]
+ifndef::pdf-theme[[[settings-roundness,Roundness]]]
+=== Roundness
+
+image::helgobox::generated/screenshots/elements/settings/roundness.png[Roundness]
+
+Choose whether to round off corners of various user interface elements and how much.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-theme-mode,Theme mode]]]
+ifndef::pdf-theme[[[settings-theme-mode,Theme mode]]]
+=== Theme mode
+
+image::helgobox::generated/screenshots/elements/settings/theme-mode.png[Theme mode]
+
+Switches between dark, light, and automatic theme modes. In automatic mode, the app will follow your system's theme settings.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-use-context-coloring,Use context coloring]]]
+ifndef::pdf-theme[[[settings-use-context-coloring,Use context coloring]]]
+=== Use context coloring
+
+image::helgobox::generated/screenshots/elements/settings/use-context-coloring.png[Use context coloring]
+
+If enabled, some inspector panels will get a special background color that reflects their purpose, such as red for recording and green for playback. This makes it easier to distinguish between the purpose of different settings but it may not go so well with the color design of your theme.
+
@@ -0,0 +1,8 @@
+ifdef::pdf-theme[[[settings-use-host-colors,Use host colors (experimental)]]]
+ifndef::pdf-theme[[[settings-use-host-colors,Use host colors (experimental)]]]
+=== Use host colors (experimental)
+
+image::helgobox::generated/screenshots/elements/settings/use-host-colors.png[Use host colors (experimental)]
+
+Borrows some color from the REAPER theme.
+
--- a/Show More
+++ b/Show More