Vendor helgoboss/helgobox (ReaLearn) as basis for custom UI fork

Stripped upstream git history; starting point for replacing the native
SWELL/Win32 mapping UI with something more suited to bulk editing.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
Paul Lipscomb
2026-07-15 17:38:29 -04:00
parent 583ed77a67
commit e58f06d9fa
2232 changed files with 685575 additions and 1 deletions
@@ -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.
@@ -0,0 +1,9 @@
ifdef::pdf-theme[[[title-bar-close-window,Close window]]]
ifndef::pdf-theme[[[title-bar-close-window,Close window image:helgobox::generated/screenshots/elements/title-bar/close-window.png[width=50, pdfwidth=8mm]]]]
== Close window
image::helgobox::generated/screenshots/elements/title-bar/close-window.png[Close window, role="related thumb right", float=right]
Closes the app window.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-dim,Dim]]]
ifndef::pdf-theme[[[title-bar-dim,Dim image:helgobox::generated/screenshots/elements/title-bar/dim.png[width=50, pdfwidth=8mm]]]]
== Dim
image::helgobox::generated/screenshots/elements/title-bar/dim.png[Dim, role="related thumb right", float=right]
Toggles between a transparent and opaque window. Useful for quickly having a look what REAPER is doing under the hood ;)
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-full-screen,Full screen]]]
ifndef::pdf-theme[[[title-bar-full-screen,Full screen image:helgobox::generated/screenshots/elements/title-bar/full-screen.png[width=50, pdfwidth=8mm]]]]
== Full screen
image::helgobox::generated/screenshots/elements/title-bar/full-screen.png[Full screen, role="related thumb right", float=right]
Toggles between full-screen and windowed mode.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-helgobox-info,Helgobox Info]]]
ifndef::pdf-theme[[[title-bar-helgobox-info,Helgobox Info image:helgobox::generated/screenshots/elements/title-bar/helgobox-info.png[width=50, pdfwidth=8mm]]]]
== Helgobox Info
image::helgobox::generated/screenshots/elements/title-bar/helgobox-info.png[Helgobox Info, role="related thumb right", float=right]
Shows the version number of the controlled Helgobox plug-in as well as the numeric ID of the Helgobox instance to which this App window is connected.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-help,Help]]]
ifndef::pdf-theme[[[title-bar-help,Help image:helgobox::generated/screenshots/elements/title-bar/help.png[width=50, pdfwidth=8mm]]]]
== Help
image::helgobox::generated/screenshots/elements/title-bar/help.png[Help, role="related thumb right", float=right]
Shows a help menu
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-move-window,Move window]]]
ifndef::pdf-theme[[[title-bar-move-window,Move window image:helgobox::generated/screenshots/elements/title-bar/move-window.png[width=50, pdfwidth=8mm]]]]
== Move window
image::helgobox::generated/screenshots/elements/title-bar/move-window.png[Move window, role="related thumb right", float=right]
Drag this button to move the window. Useful when the window is very narrow, in which case the main drag area in the center will disappear.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-panic-midi,Panic]]]
ifndef::pdf-theme[[[title-bar-panic-midi,Panic image:helgobox::generated/screenshots/elements/title-bar/panic-midi.png[width=50, pdfwidth=8mm]]]]
== Panic
image::helgobox::generated/screenshots/elements/title-bar/panic-midi.png[Panic, role="related thumb right", float=right]
Attempts to stops all currently playing MIDI notes. Whenever you experience hanging notes, press this button.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-pause-arrangement,Pause arrangement]]]
ifndef::pdf-theme[[[title-bar-pause-arrangement,Pause arrangement image:helgobox::generated/screenshots/elements/title-bar/pause-arrangement.png[width=50, pdfwidth=8mm]]]]
== Pause arrangement
image::helgobox::generated/screenshots/elements/title-bar/pause-arrangement.png[Pause arrangement, role="related thumb right", float=right]
Pauses the REAPER arrangement
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-play-arrangement,Play arrangement]]]
ifndef::pdf-theme[[[title-bar-play-arrangement,Play arrangement image:helgobox::generated/screenshots/elements/title-bar/play-arrangement.png[width=50, pdfwidth=8mm]]]]
== Play arrangement
image::helgobox::generated/screenshots/elements/title-bar/play-arrangement.png[Play arrangement, role="related thumb right", float=right]
Starts playing the REAPER arrangement
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-redo,Redo]]]
ifndef::pdf-theme[[[title-bar-redo,Redo image:helgobox::generated/screenshots/elements/title-bar/redo.png[width=50, pdfwidth=8mm]]]]
== Redo
image::helgobox::generated/screenshots/elements/title-bar/redo.png[Redo, role="related thumb right", float=right]
Redoes the most recent operation that was undone within this Playtime matrix.
@@ -0,0 +1,10 @@
ifdef::pdf-theme[[[title-bar-refresh,Refresh]]]
ifndef::pdf-theme[[[title-bar-refresh,Refresh image:helgobox::generated/screenshots/elements/title-bar/refresh.png[width=50, pdfwidth=8mm]]]]
== Refresh
image::helgobox::generated/screenshots/elements/title-bar/refresh.png[Refresh, role="related thumb right", float=right]
Refreshes the displayed information.
Pressing this button is typically not required during normal operation. However, if there are any issues preventing Helgobox from displaying the latest information automatically, this button can help resolve the problem.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-save-project,Save project]]]
ifndef::pdf-theme[[[title-bar-save-project,Save project image:helgobox::generated/screenshots/elements/title-bar/save-project.png[width=50, pdfwidth=8mm]]]]
== Save project
image::helgobox::generated/screenshots/elements/title-bar/save-project.png[Save project, role="related thumb right", float=right]
Saves the current REAPER project
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-settings,Settings]]]
ifndef::pdf-theme[[[title-bar-settings,Settings image:helgobox::generated/screenshots/elements/title-bar/settings.png[width=50, pdfwidth=8mm]]]]
== Settings
image::helgobox::generated/screenshots/elements/title-bar/settings.png[Settings, role="related thumb right", float=right]
Opens the central settings dialog.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-stop-arrangement,Stop arrangement]]]
ifndef::pdf-theme[[[title-bar-stop-arrangement,Stop arrangement image:helgobox::generated/screenshots/elements/title-bar/stop-arrangement.png[width=50, pdfwidth=8mm]]]]
== Stop arrangement
image::helgobox::generated/screenshots/elements/title-bar/stop-arrangement.png[Stop arrangement, role="related thumb right", float=right]
Stops the REAPER arrangement
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-theme-mode,Theme mode]]]
ifndef::pdf-theme[[[title-bar-theme-mode,Theme mode image:helgobox::generated/screenshots/elements/title-bar/theme-mode.png[width=50, pdfwidth=8mm]]]]
== Theme mode
image::helgobox::generated/screenshots/elements/title-bar/theme-mode.png[Theme mode, role="related thumb right", float=right]
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[[[title-bar-theme-switcher,Quick theme switcher]]]
ifndef::pdf-theme[[[title-bar-theme-switcher,Quick theme switcher image:helgobox::generated/screenshots/elements/title-bar/theme-switcher.png[width=50, pdfwidth=8mm]]]]
== Quick theme switcher
image::helgobox::generated/screenshots/elements/title-bar/theme-switcher.png[Quick theme switcher, role="related thumb right", float=right]
Cycle through all available themes.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-toggle-nav-bar,Toggle navigation bar]]]
ifndef::pdf-theme[[[title-bar-toggle-nav-bar,Toggle navigation bar image:helgobox::generated/screenshots/elements/title-bar/toggle-nav-bar.png[width=50, pdfwidth=8mm]]]]
== Toggle navigation bar
image::helgobox::generated/screenshots/elements/title-bar/toggle-nav-bar.png[Toggle navigation bar, role="related thumb right", float=right]
Shows or hides the navigation bar on the left.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-undo,Undo]]]
ifndef::pdf-theme[[[title-bar-undo,Undo image:helgobox::generated/screenshots/elements/title-bar/undo.png[width=50, pdfwidth=8mm]]]]
== Undo
image::helgobox::generated/screenshots/elements/title-bar/undo.png[Undo, role="related thumb right", float=right]
Undoes the most recent operation performed within this Playtime matrix.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-about,About...]]]
ifndef::pdf-theme[[[title-bar-about,About...]]]
== About...
Shows the about screen for the Helgobox App.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-highlight-screen-areas,Highlight screen areas]]]
ifndef::pdf-theme[[[title-bar-highlight-screen-areas,Highlight screen areas]]]
== Highlight screen areas
Highlights the most important areas of the main screen.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-open-helgobox-reference,Open Helgobox reference]]]
ifndef::pdf-theme[[[title-bar-open-helgobox-reference,Open Helgobox reference]]]
== Open Helgobox reference
Opens the Helgobox Reference online.
@@ -0,0 +1,8 @@
ifdef::pdf-theme[[[title-bar-open-helgobox-website,Open Helgobox website]]]
ifndef::pdf-theme[[[title-bar-open-helgobox-website,Open Helgobox website]]]
== Open Helgobox website
Opens the Helgobox product page.
@@ -0,0 +1,6 @@
ifdef::pdf-theme[]
[TIP]
====
You are viewing the printable PDF version of the {page-component-title}. For a better and more interactive reading experience, visit the link:https://docs.helgoboss.org/{page-component-name}[online version]!
====
endif::[]
@@ -0,0 +1 @@
A VST instrument plug-in that deeply integrates with REAPER by using its link:https://www.reaper.fm/sdk/plugin/plugin.php[Plug-in Extensions] mechanism.
@@ -0,0 +1 @@
For product-specific information, please consult the link:https://docs.helgoboss.org/realearn[ReaLearn Reference] or link:https://docs.helgoboss.org/playtime[Playtime Reference].
@@ -0,0 +1,2 @@
NOTE: This section only describes the few general user interface elements that are _not_ specific to ReaLearn.
Refer to the xref:realearn::user-interface.adoc[ReaLearn user interface documentation] to learn more about all the other elements!