README.adoc

ReaLearn

Sophisticated REAPER MIDI/MCU/OSC-learn VST instrument plug-in for controlling REAPER with feedback.

Table of Contents

• Installation
  • Install for the first time
  • Update to the latest stable version
  • Test new features and improvements
  • Install manually
• Usage
  • User guide
  • Video
  • Quick start
• Architecture
• Contributing
• Links

Installation

The easiest and preferred way of installing ReaLearn is via ReaPack, a sort of "app store" for REAPER. It allows you to keep your installation of ReaLearn up-to-date very easily.

Install for the first time

If you previously installed ReaLearn manually, please uninstall it first!

1. Install ReaPack if not done so already

2. Extensions → ReaPack → Import repositories…

3. Copy and paste the following repository URL:

   https://github.com/helgoboss/reaper-packages/raw/master/index.xml

4. Extensions → ReaPack → Browse packages…

5. Search for realearn

6. Right mouse click on the ReaLearn package → Install…

7. OK or Apply

8. Restart REAPER

Update to the latest stable version

ReaLearn development moves fast. In order to take advantage of new features, improvements and fixes, you should check for updates from time to time.

1. Extensions → ReaPack → Synchronize packages

   • It will tell you if a new version has been installed.

2. Restart REAPER

Test new features and improvements

If you want to get access to cutting-edge but untested versions of ReaLearn, you have two options:

Install a specific pre-release:

1. Right mouse click on the ReaLearn package → Versions

2. Select any version ending on -pre. or -rc.

3. OK or Apply

4. Restart REAPER

Enable pre-releases globally:

1. Extensions → ReaPack → Manage repositories → Options… → Enable pre-releases globally (bleeding edge)

2. After that, whenever you synchronize packages, you will get the latest stuff.

Install manually

If you are more the download type of person, you can find the latest dll, dylib and so files here at GitHub on the releases page for manual installation. You also must install ReaLearn manually if you plan to use ReaLearn 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.

Please note that it’s impossible to run ReaLearn as a bridged plug-in. If you have "Preferences → Plug-ins → Compatibility → VST bridging/firewalling" set to "In separate plug-in process" or "In dedicated process per plug-in", you will need to add an exception for ReaLearn by setting "Run as" to "Native only"!

Usage

User guide

The user guide of the latest not-yet-released version is available as HTML (GitHub) (preferred, best readability).

A complete user guide for the latest release is available as PDF and HTML (website).

Video

We also have an introduction video. Watch 2 minutes to get a first impression and stay tuned if you are interested in the details.

Quick start

ReaLearn is fired up just like any other VST instrument in REAPER: By adding it to an FX chain.

Figure 1. Main panel (containing the list of mappings)

Figure 2. Mapping panel (for editing one particular mapping)

Architecture

See architecture documentation.

Contributing

See contributing documentation.

Links

• Website

• Forum (dedicated thread in REAPER forum)

• Issue tracker

• Old issue tracker (for ReaLearn < v1.10.0)

• ReaLearn Companion app