Plugins

    Not to be confused with VST and VSTi.

    Overview

    A MuseScore plugin is a small piece of software that adds extra functionality to the program. Some plugins come pre-installed, you may also install other compatible plugins, or write your own plugin.

    Managing plugins

    Installing a new plugin

    1. Search for available plugins at, for example:
    2. Make sure it is compatibile with your Musescore version.
      ms4p_dlcompat.png
    3. Download the file:
      • for musescore.org hosted qml files, sometimes a web browser open it as plain text and refuses to download it as file, you might need to right click on a link and select Save link as...
      • for github.com unpackaged code, download the project as a zip file by clicking Code: Download ZIP
      • for github.com packaged release, click on an appropiate item under Assets
        ms4p_githubrelease.PNG
    4. (If it is a zip file) Extract it using an archive extraction software.
    5. Move the files to MuseScore's plugins folder, configurable at Preferences:General:Folders. The default directories are
      • Windows: C:/Users/[Your User Name]/Documents/MuseScore4/Plugins/
      • macOS: [work in progress, please provide missing info]
      • Linux: ~/Documents/MuseScore4/Plugins
        ms4pluginfolder1.PNG
        ms4pluginfolder2.PNG

    Updating an existing plugins

    Updating works the same way as installing, but remember to remove the files from the previous version to avoid duplicate plugins!

    Enabling and disabling plugins

    1. Click Home: Plugins or Plugins: Manage plugins...
    2. Select a plugin and click Enable or Disable

    Running a plugin

    1. Make sure you opened the Score tab.
    2. Select Plugins: [The plugin name]

    You can also set shortcuts to run specific plugins, inside Home: Plugins or Plugins: Manage plugins....

    Pre-installed plugins

    [work in progress, please provide missing info, write brief info on each]

    See https://github.com/musescore/MuseScore/tree/master/share/plugins
    * Add Courtesy Accidentals
    * Color Notes
    * Lilypond Lyrics
    * Mirror Intervals
    * Modal Temperaments
    * Modal Tuning
    * New Retrograde
    * Note Names
    * Remove Courtesy Accidentals
    * Tuning

    Create a plugin

    The plugin system of Musescore 4 is currently being redesigned and reimplemented.

    As of October 2023, Musescore 4.1.1 plugin system is mostly a somewhat restricted version of the Musescore 3 plugin system. Visit Developers' Handbook Plugins for 3.x Chapter for fundamentals, and Plugins for 4.x Chapter for info on the new parameters and porting a Musescore 3 plugin to MuseScore 4.

    See also