# Plugins

*Not to be confused with* [*VST and VSTi*](https://musescore.org/en/handbook/4/working-vst-and-vsti)*. VST support is added in Musescore 4, Musescore 3 does not support VST.*\
\&#xNAN;*Visit Developers' Handbook* [*Plugins for 3.x*](https://musescore.org/en/handbook/developers-handbook/plugins-3x) *Chapter for step by step guide to write a new plugin or edit a current one.*

## Overview

A MuseScore plugin is a small piece of software that adds extra functionality to the program. A plugin need to be [enabled first](#enabling-and-disabling-plugins), and then [executed by using the Plugins menu](#running-a-plugin). Some plugins come [pre-installed](#pre-installed-plugins), they are disabled by default. There are also plugins [created and shared](#creating-a-plugin) by other musicians, anyone can [download and use them](#installing-a-new-plugin).

## Installing a new plugin

1. Search for available plugins at, for example:
   * <https://musescore.org/en/plugins?category=All&compatibility=432> \[musescore.org→Download→Plugins]\
     **Warning**: Plugins can potentially contain bad or malicious codes, which damage scores and compromise the machine. All plugins shared on musescore.org's plugin repository are **unvetted**. No warranty of any kind is provided. Users should download from a trusted author or double-check the code themselves. Seek advice on the [Plugins forum](https://musescore.org/en/forum/443).
   * <https://github.com/topics/musescore-plugin>
   * <https://github.com/topics/musescore-plugins>
2. Make sure it is compatible with version of Musescore used.\\

   <figure><img src="https://1928698062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5NUiVQIqbPkgQim8AxPy%2Fuploads%2Fgit-blob-02e17befc7dceb0be75c64e7aeb479afc3912666%2Fms4p_dlcompat.png?alt=media" alt="Ms4p dlcompat"><figcaption></figcaption></figure>
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. In this case, 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**\\

     <figure><img src="https://1928698062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5NUiVQIqbPkgQim8AxPy%2Fuploads%2Fgit-blob-e4ed62218ca5fc39761beecf9f22917ab9a03025%2Fms4p_githubzip.gif?alt=media" alt="Ms4p githubzip"><figcaption></figcaption></figure>
   * for github.com packaged release, click on an appropriate item under **Assets**\\

     <figure><img src="https://1928698062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5NUiVQIqbPkgQim8AxPy%2Fuploads%2Fgit-blob-cda1c3a74edc47a836c04e198978dbf23c537836%2Fms4p_githubrelease.png?alt=media" alt="Ms4p githubrelease"><figcaption></figcaption></figure>
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 **Edit → Preferences:General tab** window, see [Preferences](https://handbook.musescore.org/3/advanced-topics/preferences) chapter. The default directories are
   * Windows: `%HOMEPATH%\Documents\MuseScore3\Plugins`
   * macOS: `~/Documents/MuseScore3/Plugins`
   * Linux:`~/Documents/MuseScore3/Plugins`

**Note**: (1) The folder name "Plugins" is translated according to Musescore's language setting, see [Preferences:General](https://handbook.musescore.org/3/preferences#general) chapter. (2) Some plugins require installing other components such as a specialized Font file.

## Enabling and disabling plugins

1. Click **Plugins: Plugin Manager**
2. Tick a plugin to enable it.

   <figure><img src="https://1928698062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5NUiVQIqbPkgQim8AxPy%2Fuploads%2Fgit-blob-f0364dd608cc72f70f0cfae0ade6ffa246581468%2FPlugin_Manager_en_3.png?alt=media" alt="Plugin manager"><figcaption></figcaption></figure>

## Running a plugin

Select **Plugins → \[The plugin name]**

<figure><img src="https://1928698062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5NUiVQIqbPkgQim8AxPy%2Fuploads%2Fgit-blob-88f739dcf7339e4e5710618a2055c4b8d146c73a%2Fms3p_run.gif?alt=media" alt="Ms3p run"><figcaption></figcaption></figure>

To assign a keyboard shortcut to a plugin, use the [Plugin Manager](#enabling-and-disabling-plugins).

## Creating a plugin

One way to create and edit a plugin is using Musescore's Plugin Creator window, but see the developers' handbook [Plugin documentation](https://musescore.org/en/handbook/developers-handbook/plugins-3x) chapter. That chapter contains coding tutorials and code boilerplates.

* Click **Plugins → Plugin Creator**.

<figure><img src="https://1928698062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5NUiVQIqbPkgQim8AxPy%2Fuploads%2Fgit-blob-f0e0441a2788d64464d82dfe4f08ceea296438e4%2FPlugin_Creator_en.png?alt=media" alt="Plugin creator"><figcaption></figcaption></figure>

## Pre-installed plugins

Some plugins come pre-installed with MuseScore. They are not enabled by default, see ["Enabling and disabling plugins"](#enable-disable-plugins) section. They are available at MuseScore repository <https://github.com/fp22june/MuseScoreTag362/tree/master/share/plugins>.

* **ABC Import** :\
  This plugin imports [ABC](http://abcnotation.com/) text from a file or the clipboard and converts it to [MusicXML](https://handbook.musescore.org/3/file-formats#musicxml-musicxml-xml) with [Wim Vree's abc2xml Python script](https://wim.vree.org/svgParse/abc2xml.html). Internet connection is required, because it uses an external web-service at <https://abc2xml.appspot.com/> for the conversion. **As of June 2023, the pre-installed ABC Import plugin does not work anymore** due to expiration of web domain. Working alternatives:
  * [ABC Import/Export](https://musescore.org/en/project/abc-importexport) plugin: Works offline, need to download and install python, abc2xml and xml2abc. Depending on python version, editing out the incompatible hash symbol (python comment token) at LINE 1 may be needed.
  * [ABC Import](https://musescore.org/en/project/abc-import) and [ABC Export](https://musescore.org/en/project/abc-export) plugin: Connects to <https://musescore.jeetee.net/abc/>
* **Color Notes**: **Notes → Color Notes** .\
  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), or use [Remove Notes Color](https://musescore.org/en/project/remove-notes-color) plugin.
* **Create Score** :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** : Demonstrates some basic tasks.
* **Note Names** : **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](https://handbook.musescore.org/3/text/text-styles-and-properties)) according to MuseScore's [language settings](https://handbook.musescore.org/3/getting-started/language-translations-and-extensions): 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

Pre-installed plugins are in the folder:

* Windows: `%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
* macOS: `/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`.
* Linux: `/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 different depending on language setting of the operating system.

## See also

* [Tools](https://handbook.musescore.org/3/advanced-topics/tools)

## External links

* Developers' Handbook [Plugins for 3.x](https://musescore.org/en/handbook/developers-handbook/plugins-3x)
