Published on MuseScore (https://musescore.org)

Plugins

    What are Plugins?

    Plugins are small pieces of software that add a particular feature to MuseScore. By enabling a plugin, a new menu option is appended to the Plugins menu: subsequently, when this option is selected, the plugin performs a particular task in the score.

    Some plugins come pre-installed with MuseScore—see Plugins installed by default (below). You can find many more plugins in the plugin repository: some work with MuseScore 3, others only with older versions of MuseScore, and some work with either. To tell one from the other: MuseScore 3.x and 2.x plugin code files have an extension of .qml; for older versions, it is .js.

    Warning: Plugins can potentially contain bad or malicious code, which can compromise or damage your scores or system. Plugins are entirely unvetted (except for those that are installed by default). You either need to trust the author or check the code yourself.

    Installation

    Note: Some plugins may require the installation of other components (fonts, e.g.) to work. Check the plugin's documentation for more information.

    Most plugins are provided as ZIP archives: download the plugin's .zip file and uncompress (unzip) it to one of the directories mentioned below (depending on your OS). If the plugin is provided directly as an uncompressed .qml file, simply download it and place into one of the same directories.

    Once a plugin is installed, it needs to be enabled in the Plugin Manager in order to use it—see Enable/disable Plugins.

    Windows

    On Windows, new plugins should be installed into %HOMEPATH%\Documents\MuseScore3\Plugins. Alternatively, specify a different folder in MuseScore's Preferences.

    Note: That above mentioned directory name ("Plugins") might be translated according to your language settings! When in doubt, check your Preferences settings.

    Pre-installed plugins can be found in %ProgramFiles%\MuseScore 3\Plugins (or %ProgramFiles(x86)%\MuseScore 3\Plugins for the 32-bit versions) and in %LOCALAPPDATA%\MuseScore\MuseScore 3\plugins on Windows 7 and later. These folders should not be modified.

    macOS

    On macOS, new plugins should be installed into ~/Documents/MuseScore3/Plugins. Alternatively, specify a different folder in MuseScore's Preferences.

    Note: That above mentioned directory name ("Plugins") might be translated according to your language settings! When in doubt, check your Preferences settings.

    Pre-installed plugins can be found in the MuseScore bundle in /Applications/MuseScore 3.app/Contents/Resources/plugins (to reveal files in the app bundle, right-click on MuseScore 3.app and choose "Show package contents"), and in ~/Library/Application Support/MuseScore/MuseScore 3/plugins. These folders should not be modified.

    Linux

    On Linux, new plugins should be installed into ~/Documents/MuseScore3/Plugins. Alternatively, specify a different folder in MuseScore's Preferences.

    Note: That above mentioned directory name ("Plugins") might be translated according to your language settings! When in doubt, check your Preferences settings.

    Pre-installed plugins can be found in /usr/share/mscore-3.x/plugins and in ~/.local/share/data/MuseScore/MuseScore3/plugins. These folders should not be modified.

    The directory names might be slightly different, depending on your operating system's language.

    Enable/disable plugins

    To be able to access the installed plugins from the Plugins menu, they need to be enabled in the Plugin Manager:

    Plugin manager

    You do this simply by checking the appropriate tick box. This adds the name of the plugin to the list in the Plugins menu.

    Create/edit/run plugins

    It is possible to create new or edit existing plugins and run them via the Plugin Creator:

    Plugin creator

    Documentation of all available elements can also be found here.

    Plugins installed by default

    Some plugins come pre-installed with MuseScore, but they are not enabled by default. See Enable/disable plugins (above) to enable plugins.

    ABC Import

    This plugin imports ABC text from a file or the clipboard and converts it to MusicXML. Internet connection is required, because it uses an external web-service for the conversion.

    Notes → Color Notes

    This demo plugin colors notes in the selected range (or the entire score), depending on their pitch. It colors the note head of all notes in all staves and voices according to the Boomwhackers convention. Each pitch has a different color. C and C♯ have a different color. C♯ and D♭ have the same color.
    To color all the notes in black, just run that plugin again (on the same selection). You could also use the 'Remove Notes Color' plugin for this.

    Create Score

    This demo plugin creates a new score. It creates a new piano score with 4 quarter notes: C, D, E, F. It's a good start to learn how to make a new score and add notes from a plugin.

    helloQml

    This demo plugin demonstrates some basic tasks.

    Notes → Note Names

    This plugin names notes in a selected range or for the entire score. It displays the names of the notes (as staff text) according to MuseScore's language settings: voices 1 and 3 notes above the staff; voices 2 and 4 notes below the staff; and chord notes in a comma separated list, starting with the top note.

    Panel

    This demo plugin creates a GUI panel.

    random/random2

    Creates a random score.

    run

    This demo plugin runs an external command. Probably this will only work on Linux.

    scorelist

    This test plugin iterates through the score list.

    ScoreView

    Demo plugin to demonstrate the use of a ScoreView

    Walk

    This test plugin walks through all elements in a score

    See also

    • Tools

    External links

    • Plugins for 3.x

    Preferences

      You can customize many of MuseScore's default behaviors via the menu: Edit→Preferences... (Mac: MuseScore→Preferences...).

      The Preferences dialog has multiple tabs:

      Tabs in Preferences dialog

      Reset All Preferences to Default will reset all preferences to the ones MuseScore had when you installed it. Ok will save the settings and close the dialog. Cancel will close the dialog without applying changes. Apply will make changes take effect without closing the dialog.

      General

      General Preferences

      Here you can define:

      • Program Start: Specify whether to start the session empty or to display a score. The options are one of the following: Start empty (no score) / Continue last session / Start with new score (i.e. New Score Wizard automatically opens) / Start with score (the program default, or one of your own choosing).
        You can also choose which panels to display. This can be any combination of: Splash screen, Play Panel, Navigator, or Start Center. Also select if Tours will be active.
      • Folders: Specify the default folders for score files, style files, custom score templates, plugins, additional SoundFonts, images, and extensions.
      • Language: Choose the language used by the program. Translations may be updated from here too. Note that language translation updates can also be done via the menu: Help→Resource Manager.
      • Telemetry: Tick/untick to authorize MuseScore to collect usage data. The type of data collected is listed, and updated as needed, in telemetry.
      • Appearance: Specify a dark or light theme, and the width and height of icons. Set display "Font face" and "Font size".
      • Auto Save: How frequently the program autosaves.
      • OSC Remote Control

      Canvas

      Canvas Preferences

      Use Canvas to set your preferred color and wallpaper for the score background and paper. The default "Background" is dark blue (RGB 20, 36, 51; Alpha 255) and the default "Paper," white.

      • Background: Use this to set the color or background around the score pages. Select "Color" then click on the bar to the right and make a choice from the color picker; or select "Wallpaper," click on the file icon and set a background image.
      • Paper: Sets the color or background of the score pages. Controls identical to "Background" (above). You can also tick/untick "Use the same color in palettes".
      • Zoom: This defines the Default zoom level and keyboard/mouse zoom precion.
      • Scroll Pages: This defines the way that the pages are laid out in the score. Choose "Horizontally" for a row layout, or "Vertically" for a column layout. To limit scrolling, tick "Limit scroll area to page borders".
      • Miscellaneous: "Draw antialiased" (the default option) makes diagonal lines and edges of shapes look smoother. "Proximity for selecting elements" controls the distance the mouse may be from an object and still act on it. Smaller numbers require more precision, making it harder to click on small objects. Larger numbers are less precise, making it harder not to click on nearby objects unintentionally. Choose a comfortable working value.

      Note input

      Note Input Preferences

      On this tab there are note input and MIDI remote control preferences. Here the following can be set:

      Note Input

      • Enable MIDI Input: Leave checked to allow MIDI input of notes.
      • Color notes outside of usable pitch range: For details, see Coloring of notes outside an instrument's range and Usable pitch range (Staff properties: all staves).
      • Delay between notes in automatic real-time mode: See Real-time (automatic).
      • Play notes when editing: When ticked, MuseScore sounds the note when it is entered or selected. Tick "Play whole chord when adding note," if you want to hear all the notes of a chord when it is added to. You can also edit the "Default duration".

      MIDI Remote Control

      Midi Remote Control allows you to use certain keys on your MIDI keyboard to enter notes and rests and to select note durations, without involving the computer mouse or (computer) keyboard. The default setting is off.

      To assign a command to a MIDI key:

      1. Ensure that "MIDI Remote Control" is checked (your MIDI keyboard should be connected before opening the program).
      2. Click the red button next to the option you wish to assign a MIDI key to: the red button now lights up.
      3. Press a MIDI keyboard key. The red button becomes unlit and the green button lights up instead. The MIDI key has now been assigned to the desired option.
      4. Repeat "2" and "3" to assign other keys.

      Once you have defined your key settings you can use the MIDI keyboard to control note input operations. You can verify your key settings by observing the MuseScore Note Input toolbar while pressing the MIDI keys.

      To temporarily deactivate Midi Remote Control: uncheck "Midi Remote Control": all MIDI input key action buttons are now greyed out. Note: Your key assignments are always saved between MuseScore sessions and are not affected by deactivation.

      Notes: (1) The "Clear" option turns off all the green buttons for the current MuseScore session but all the user-recorded MIDI key settings are retained and will be reloaded on the next session. (2) A MIDI key setting that is activated cannot afterwards be turned off, and the green button will always remain lit: however it can be overwritten with a different MIDI key by using the red button again. (3) If the same MIDI key is accidentally assigned to more than one option, then all the associated green buttons remain lit although only one will work. To fix, see "(2)".

      Score

      Score Preferences

      Score preferences include:

      Default Files

      • Instrument list 1: Default instrument list file one
      • Instrument list 2: Default instrument list file two
      • Score order list 1: Default score order list file one (used for instrument ordering)
      • Score order list 2: Default score order list file two
      • Style: Default style for score
      • Style for part: Default style for parts

      See also Load/Save Style

      View

      • Show MIDI controls in mixer: Enable this option to show MIDI controls by default in the mixer.

      I/O

      I/O Preferences

      PortAudio (API / Device)

      This enables you to set the audio interface (API) and specify the device to be used for audio playback: e.g. built-in speakers/headphones, USB headset, wireless, etc.

      MIDI Input/Output/Output Latency

      When an external MIDI input device is connected, its identifier appears in MIDI Input. When the device is connected for the first time, you also need to select the correct MIDI Output option in order to enable note input and correct audio playback (e.g. in Windows, this might be "MMS<device name>"): then close and reopen the program to confirm the changes.

      Jack Audio Server

      Check these options as required if using the JACK Audio Connection Kit.

      Audio Engine

      In case of lost communication between your audio device or your MIDI keyboard and MuseScore (no sound output or MIDI action), click on Restart Audio and MIDI Devices to restore them.

      Import

      Import Preferences

      These settings determine how files from other sources are imported:

      • Style Used for Import: Use either the built in MuseScore style or a style you choose (see Load/Save Style)
      • MusicXML: Set the MusicXML import options
      • Character Set Used When Importing Binary Files: Character Set used for Binary Files (Guitar Pro and Overture character sets)
      • MIDI: Define the shortest note when importing MIDI files
      • When opening scores from older MuserScore versions: When enabled, you will be prompted if you want to apply the new default engraving and style settings or not when opening a score created with a version before 3.6.

      Export

      Export Preferences

      These settings determine how various files are exported from MuseScore:

      • PNG: PNG/SVG image resolution (in DPI) and whether to use transparent background.
      • MIDI: Whether to expand repeats in exported MIDI files.
      • PDF: PDF resolution (in DPI).
      • Audio: Set audio sample rate, MP3 bitrate, and whether to "normalize" exported audio.
      • MusicXML: Whether to export the layout and how to export system and page breaks to MusicXML.

      Shortcuts

      Shortcuts Preferences

      This tab lists all the commands in MuseScore and any keyboard shortcuts associated with them. Shortcuts listed in preferences also appear next to their associated commands in the menus.

      • To search for a particular command: Enter its name in the "Search" box near the bottom of the window.

      • To create a new shortcut for a command:

        1. Select an existing entry in the list.
        2. Click Define...; or just double-click the entry.
        3. Enter the new shortcut using up to four keys. Press Clear if you need to re-enter the shortcut.
        4. Press Replace to change the existing shortcut; or Add, to keep the old shortcut and add the new one.
          Note: Some shortcuts, including default ones, may not work with some keyboards.
      • To reset a shortcut to its system default: Select a command in the list and press Reset Shortcut to Default.

      • To save the shortcuts list: Press Save and save to a file name of your choice.

      • To load a saved shortcut list: Press Load etc.

      • To clear all shortcuts for an entry: Select the entry and press Clear.

      • To print out the shortcuts list (incl. export to pdf): Press Print etc.

      Update

      Update Preferences

      This sets whether MuseScore will check for updates and extensions at startup.

      Updates may be checked manually in Help→Check for updates.

      Advanced

      Advanced Preferences

      Allows you to control specific settings for "application, "export", "i/o" and "user interface", as well as color settings.

      See also

      • Keyboard shortcuts
      • Language settings and translation updates
      • Update checking