Flexible keyswitch router for Kontakt (multiscript)

README.md

FlexRouter

Quick link: get the compiled script for the latest version

What is it?

FlexRouter is a highly customizable Kontakt 5 Multiscript designed for managing and unifying keyswitches across instruments from many different developers.

Some features include:

  • support for note, program change, or CC-based keyswitches
    • FlexRouter refers to all these MIDI events as "keyswitches" even though they're not all strictly "keys"
  • arbitrary translation between notes, CCs, and program changes
    • one "keyswitch" input event can be translated to multiple configurable output events
  • can route events to instruments on ports A-D (64 separate channels)
  • multiple note-based keyswitches can be activated simultaneously (useful for e.g. layering articulations)
  • one keyswitch note/CC/PC can trigger routing to multiple target channels
  • note-based keyswitches can have configurable velocity ranges
  • one instance of FlexRouter supports 16 rules
  • each rule supports up to 128 independently configured keyswitches
  • Optional anti-hanging for notes and sustain pedal when jumping between keyswitches
  • Optional CC chasing per rule
  • probably a few bugs :)

Since a picture is worth a thousand words:

Here are just a few random use-cases that can be solved using FlexRouter:

  • Put each articulation patch on different channels (up to 64) and control with keyswitches from a single channel
  • Route to different patches based on keyswitch velocity
  • Assign different instruments on channels 1 through 16, each with multiple patches for articulations, and control each instrument independently
  • Use UACC to control conventional note-keyswitched libraries
  • Use UACC with Spitfire libraries, but cherry-pick certain articulations from other libraries on other channels
  • Use standard notes on channel 16 to control Spitfire via UACC on channel 1

There's also a walkthrough video that shows how to implement some of these use-cases. (Note, the video shows version 1, but all the examples still work with version 2.)

How do I install it?

Follow these steps:

  1. Click this link for the latest compiled script
  2. Copy the contents to clipboard
  3. In your Kontakt instance, click the script button in the toolbar to open the multiscript pane
  4. Select the desired slot for the script, and click the edit button
  5. Paste the clipboard contents into the newly opened text area
  6. Click the Apply button
  7. Click the Edit button again to close the edit text area

How do I contribute or make my own customizations?

Reporting bugs

Create an account on GitHub and open an issue.

Hacking code

First download and install Sublime Text 3, and then download and install the SublimeKSP plugin for ST3.

While you're at it, visit Nils Liberg's page for the original SublimeKSP and click the donate button to buy Nils a coffee for his original work because there's no way I'd have avoided gouging out my eyes at the abomination that is KSP were it not for Nils' KSP extensions.

Clone the FlexRouter repository, and open the KSP scripts under src/ within ST3.

Use SublimeKSP to compile flexrouter.ksp (F5 by default -- see SublimeKSP's README.md for details) and paste the contents of the clipboard (which gets automagically populated by SublimeKSP) into Kontakt as per the installations steps above.

If you want to contribute changes back to FlexRouter, please use the usual GitHub workflow: fork this repository and send me a pull request. Please don't be offended by scrutiny and nitpicking on any contributed code. :)