Skip to content

Commit 9d4a38f

Browse files
committed
Adjust user guide
1 parent d82c1b4 commit 9d4a38f

File tree

1 file changed

+28
-7
lines changed

1 file changed

+28
-7
lines changed

doc/user-guide.adoc

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= ReaLearn user guide
2+
:experimental:
23
:toc:
34
:toclevels: 5
45
:sectnums:
@@ -10,7 +11,7 @@
1011
:osc_preset_content: There are no ReaLearn controller presets for OSC layouts yet. Although technically possible in exactly the same way as with controller presets for MIDI devices, OSC layouts are very custom, so I'm not sure if it would make much sense to create presets. Time will show.
1112

1213
|===
13-
|Last update of text: |`2023-01-13 (v2.14.2)`
14+
|Last update of text: |`2023-02-28 (v2.15.0-pre.1)`
1415
|Last update of relevant screenshots: |`2021-04-27 (v2.8.0)`
1516
|===
1617

@@ -2497,11 +2498,14 @@ A target is a thing that is supposed to be controlled.
24972498

24982499
Starts or stops learning the target of this mapping.
24992500

2500-
====== Go there
2501+
====== Menu
2502+
2503+
Opens a small menu related to the target section:
2504+
2505+
- *Pick recently touched target (by type):* Gives you a list of recently touched parameters or executed actions in REAPER. When you click one of it, the target will be populated accordingly. It's an alternative to "Learn". Please note that not all targets can be picked that way, some have to be configured manually.
2506+
- *Go there (if supported):* If applicable, this makes the target of this mapping visible in REAPER. E.g. if the target is a track FX parameter, the corresponding track FX window will be displayed.
2507+
25012508

2502-
If applicable, pressing this button makes the target of this mapping visible in
2503-
REAPER. E.g. if the target is a track FX parameter, the corresponding track FX window will be
2504-
displayed.
25052509

25062510
====== Type
25072511

@@ -2883,9 +2887,13 @@ In the probably rare case that the polling causes performance issues, you can un
28832887
This will control whatever target has been last touched in REAPER. It's similar to the built-in REAPER action
28842888
"Adjust last touched FX parameter" but provides the following benefits:
28852889

2886-
. It's applicable to all ReaLearn targets that are learnable (except actions and transport), not just FX parameters.
2890+
. It's applicable to all ReaLearn targets that are learnable, not just FX parameters.
28872891
. It offers feedback.
28882892

2893+
- *Targets:* This opens a window that lets you pick all included target types (only macOS and Windows so far). Last-touched targets not checked in this window will be ignored.
2894+
2895+
TIP: Don't forget to choose the included target types, otherwise this target will do nothing.
2896+
28892897
====== Global: Mouse
28902898

28912899
This will control the mouse.
@@ -3580,6 +3588,18 @@ Please note:
35803588
* Some targets don't report values and therefore don't participate in snapshotting.
35813589
* Feedback of this target indicates whether the desired snapshot is the one which has last been loaded (for the given tags).
35823590

3591+
====== ReaLearn: Modify mapping
3592+
3593+
Triggers a modification of another ReaLearn mapping.
3594+
3595+
* *Kind:* The kind of modification.
3596+
** *Learn target:* Switches "Learn target" on or off for the destination mapping. You need to use button kbd:[...] to pick the list of target types to be included in the learning process.
3597+
** *Set target to last touched:* Sets the target of the destination mapping to the last-touched target. You need to use button kbd:[...] to pick the list of target types to be included.
3598+
* *Instance:* Allows you to pick another ReaLearn instance.
3599+
* *Mapping:* Allows you to pick the destination mapping.
3600+
3601+
TIP: This target is great to "pin" targets to certain control elements on demand.
3602+
35833603
[#realearn-take-mapping-snapshot]
35843604
====== ReaLearn: Take mapping snapshot
35853605

@@ -3727,6 +3747,7 @@ TIP: If you want to control _other_ mappings only and not _this_ mapping, just p
37273747
latter, _Inverse target value_ allows for exclusivity between completely different target types and completely
37283748
custom groupings - independent of e.g. organization of tracks into folders.
37293749
* *Inverse target value (on only):* Variation of _Inverse target value_ that applies the inverse only when the target value is > 0%.
3750+
* *Inverse target value (off only):* Variation of _Inverse target value_ that applies the inverse only when the target value is 0%.
37303751

37313752
===== Feedback type
37323753

@@ -3996,7 +4017,7 @@ This feature allows you to write a formula that transforms incoming control valu
39964017
While very powerful because it allows for arbitrary transformations (velocity curves,
39974018
random values - you name it), it's not everybody's cup of tea to write something like that. The formula must be written in the language https://www.cockos.com/EEL2/[EEL2]. Some REAPER power users might be familiar with it because REAPER's JSFX uses the same language.
39984019

3999-
Luckily, ReaLearn has a fancy editor which visualizes the formula and has some predefined templates built-in (available on Windows and macOS only at the moment). Press the "*...*" button to open the editor.
4020+
Luckily, ReaLearn has a fancy editor which visualizes the formula and has some predefined templates built-in (available on Windows and macOS only at the moment). Press the "*...*" button to open the editor. Code changes are applied immediately.
40004021

40014022
The most simple
40024023
formula is `y = x`, which means there will be no transformation at all. `y = x / 2` means that

0 commit comments

Comments
 (0)