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,17 @@
+= Source "CC value"
+
+This source reacts to incoming MIDI control-change messages.
+
+== CC menu
+
+Optionally restricts this source to messages with a certain MIDI control-change controller number.
+
+== Character menu
+
+See xref:further-concepts/source.adoc#midi-source-character[].
+
+== 14-bit values checkbox
+
+If unchecked, this source reacts to MIDI control-change messages with 7-bit resolution (usually the case).
+If checked, it reacts to MIDI control-change messages with 14-bit resolution.
+This is not so common but sometimes used by controllers with high-precision faders.
@@ -0,0 +1,4 @@
+= Source "Channel after touch"
+
+This source reacts to incoming MIDI channel-pressure messages.
+The higher the pressure, the higher the absolute control value.
@@ -0,0 +1,33 @@
+= Source "Display"
+
+This is a feedback-only source used to display text on MIDI-controllable hardware displays (LCDs, OLED displays, 7-segment displays, ...).
+
+== Protocol menu
+
+Lets you choose the display protocol, which tells ReaLearn how it should communicate with the hardware display and which options it supports.
+
+Mackie LCD:: Use this for MCU-compatible LCDs.
+Depending on your particular control surface, there can be up to 8 LCDs, each of which has up to 2 lines.
+Mackie XT LCD:: Use this to control the displays of MCU XT devices (= control surface extenders, which provide additional faders and displays).
+X-Touch Mackie LCD:: Like _Mackie LCD_ but also supports colors on certain X-Touch devices.
+X-Touch Mackie XT LCD:: Like _Mackie LCD XT_ but also supports colors on certain X-Touch devices.
+Mackie 7-segment display:: Use this for MCU-compatible 7-segment displays (you know, the ones which only show digits).
+There's usually one small assignment display and a larger one for showing the time code.
+SiniCon E24:: Use this with the https://www.sinicon.io/[SiniCon E24 controller].
+Launchpad Pro - Scrolling text:: Displays looped scrolling text on a Novation Launchpad Pro.
+Only seems to work if you set _Output_ to `MIDIOUT2 (Launchpad Pro)`.
+Studiologic SL Keyboard display:: Displays text on the display of Studiologic SL keyboards (tested with SL88).
+
+== Display menu
+
+Choose the particular display or display portion to which you want to send text.
+
+== Line menu
+
+Choose the line number.
+
+CAUTION: For controllers with multiple displays and lines, ReaLearn allows you to spread your text over all available displays and lines.
+This is great if you need to display a lot of text but one display doesn't provide enough space.
+But be aware: xref:further-concepts/general.adoc#feedback-relay[] doesn't work nicely anymore if you make use of this feature.
+
+If you want to know how to define which text shall be sent to the displays, please see xref:further-concepts/glue.adoc#text-feedback[textual feedback] in the xref:user-interface/mapping-panel/glue-section.adoc[].
@@ -0,0 +1,14 @@
+= Source "MIDI clock tempo"
+
+This source reacts to incoming MIDI clock (MTC) tempo messages.
+These are metronome-beat-like messages which can be regularly transmitted by some DAWs and MIDI devices.
+The frequency with which this message is sent dictates the tempo.
+
+The higher the calculated tempo, the higher the absolute control value.
+A tempo of 1 bpm will be translated to a control value of 0%, a tempo of 960 bpm to 100% (this corresponds to REAPER's supported tempo range).
+
+This source can be used in combination with the xref:targets/project/set-tempo.adoc[] to obtain a "poor man's" tempo synchronization.
+
+Be aware: MIDI clock naturally suffers from certain inaccuracies and latencies - that's an issue inherent to the nature of the MIDI clock protocol itself.
+E.g. it's not really suitable if you need super accurate and instant tempo synchronization.
+Additionally, ReaLearn's algorithm for calculating the tempo could probably be improved (that's why this source is marked as experimental).
@@ -0,0 +1,8 @@
+= Source "MIDI clock transport"
+
+This source reacts to incoming MIDI clock (MTC) transport messages.
+These are simple start, continue and stop messages which can be sent by some DAWs and MIDI devices.
+
+== Message menu
+
+The specific transport message to which this source should react.
@@ -0,0 +1,23 @@
+= Source "MIDI Script"
+
+[[source-midi-script]]
+This source is feedback-only and exists for enabling more complex feedback use cases such as controlling LCDs that are not yet supported by the xref:sources/midi/display.adoc[].
+It lets you write an EEL or Luau script that will be executed whenever ReaLearn "feels" like it needs to send some feedback to the MIDI device.
+
+== Kind menu
+
+Whether to use the EEL or Luau language.
+
+== Script field
+
+The script.
+Is disabled if the script contains more than one line.
+
+See xref:further-concepts/source.adoc#midi-source-script[] for details.
+
+== More button (…)
+
+Opens the script in a separate window (for multi-line scripts).
+
+TIP: Prefer the xref:sources/midi/display.adoc[] over this one whenever possible.
+It's easier to use.
@@ -0,0 +1,6 @@
+= Source "Note number"
+
+This source reacts to incoming MIDI note-on messages.
+The higher the note number (= key on a MIDI keyboard), the higher the absolute control value.
+
+This essentially turns your MIDI keyboard into a "huge fader" with the advantage that you can jump to any value at any time.
@@ -0,0 +1,9 @@
+= Source "Note velocity"
+
+This source reacts to incoming MIDI note-on and note-off messages.
+The higher the velocity of the incoming note-on message, the higher the absolute control value.
+Note-off messages are always translated to 0%, even if there's a note-off velocity.
+
+== Note menu
+
+Optionally restricts this source to messages with a certain note number (note numbers represent keys on the MIDI keyboard, e.g. 60 corresponds to C4).
@@ -0,0 +1,28 @@
+= Source "(N)RPN value"
+
+This source reacts to incoming non-registered (NRPN) or registered (RPN) MIDI parameter-number messages.
+The higher the emitted value, the higher the absolute control value.
+
+(N)RPN messages are not widely used.
+If they are, then mostly to take advantage of their ability to transmit 14-bit values (up to 16384 different values instead of only 128), resulting in a higher resolution.
+
+== RPN checkbox
+
+If unchecked, this source reacts to unregistered parameter-number messages (NRPN).
+If checked, it reacts to registered ones (RPN).
+
+== Number field
+
+The number of the registered or unregistered parameter-number message.
+This is a value between 0 and 16383.
+
+== 14-bit values checkbox
+
+If unchecked, this source reacts to (N)RPN messages with 7-bit resolution, including increment/decrement messages.
+
+If checked, it reacts to those with 14-bit resolution.
+In practice, this if often checked.
+
+== Character menu
+
+See xref:further-concepts/source.adoc#midi-source-character[].
@@ -0,0 +1,5 @@
+= Source "Pitch wheel"
+
+This source reacts to incoming MIDI pitch-bend change messages.
+The higher the pitch-wheel position, the higher the absolute control value.
+The center position corresponds to an absolute control value of 50%.
@@ -0,0 +1,8 @@
+= Source "Polyphonic after touch"
+
+This source reacts to incoming MIDI polyphonic-key-pressure messages.
+The higher the pressure, the higher the absolute control value.
+
+== Note menu
+
+Optionally restricts this source to messages with a certain note number.
@@ -0,0 +1,4 @@
+= Source "Program change"
+
+This source reacts to a range of incoming MIDI program-change messages.
+The higher the program number, the higher the absolute control value.
@@ -0,0 +1,10 @@
+= Source "Raw MIDI / SysEx"
+
+[[source-midi-raw]]
+This source primarily deals with system-exclusive MIDI messages.
+It supports both control and feedback direction!
+
+== Pattern field
+
+Pattern describing the raw MIDI message.
+See xref:further-concepts/mapping.adoc#raw-midi-pattern[].
@@ -0,0 +1,5 @@
+
+= Source "Specific program change"
+
+This source reacts to MIDI program-change messages with a specific program.
+This is a trigger-only source, that means it always fires 100% (whenever the program number corresponds to the configured one).