Getting Started

Checklist

To get started, perform these steps in order:

1. Make sure you have Visual Studio Code installed.

We highly recommend using Visual Studio Code for writing MIDI Remote API Scripts. We provide a JSDoc based auto-completion setup. You will not have to look up types and methods in a separate documentation. Visual Studio Code will help you write scripts intuitively.

2. Make sure the folder containing the Visual Studio Code executable is in your PATH environment variable.

3. Make sure you have a current Cubase / Nuendo version installed.

4. Start Cubase / Nuendo.

5. Create a project with audio and/or instrument tracks.

6. Open the Remote tab in the lower zone.

7. Open the MIDI Remote Driver Scripts folder for your host application.

If this folder does not exist yet, launch Cubase/Nuendo once and open the MIDI Remote panel. The host will create the default folder structure.

Windows

C:\Users\<Username>\Documents\Steinberg\<Cubase or Nuendo>\MIDI Remote\Driver Scripts

macOS

/Users/<Username>/Documents/Steinberg/<Cubase or Nuendo>/MIDI Remote/Driver Scripts

8. Open a console (Windows: cmd or PowerShell, macOS: Terminal) and change to the MIDI Remote Driver Scripts folder.

9. Open Visual Studio Code from the command line like this:

code .

10. Create a script file.

The MIDI Remote API script file follows this structure:

<Driver Scripts Folder>/Local/<vendor>/<device>/<vendor>_<device>.js

Example:

<Driver Scripts Folder>/Local/Nektar/Impact_LX49Plus/Nektar_Impact_LX49Plus.js

11. Connect your MIDI hardware controller.

12. Open the Script Console.

The Script Console appears like this:

After modifying a script file, press the 'Reload Scripts' button for the changes to apply.