This documentation applies to plugins for 1.x only!
Documentation for 2.x+ is built into the Plugin Creator of Musescore.
( ⇒ In Musescore press Ctrl+Shift+P, then F1 to bring it up. )
Click here for Documentation for 3.x
Existing plugins can be found in the plugin directory . To discuss plugin development, announce your own plugin, or discuss the plugin API, you can join the dedicated forum .
- Quick reference - a provided list of objects and functions.
- Function overriding. If you see a set of functions in the Qt C++ docs with the same name, but different argument types then function overloading is being used and the Qt Script Generator might have chosen to support only one of them (generally the most complete function). Note that the Qt bindings should support different functions with the same name if they vary in the number of arguments.
- QList, use Array instead
- QString, use String instead
- QVariant, use Object instead
Access MuseScore objects
If you are writing a MuseScore plugin, there is a good chance you mainly want to manipulate and query MuseScore objects. Some objects are available to the plugin framework. The latest API is documented in other pages of this handbook. The README.scripts (1.1 version) is also available.
If you use the Qt Bindings, it seems you are legally obligated to release your script under the GPL v2 or v3 license, under the terms of Qt 4.6's Open Source licensing .
This documentation is based on the Amarok Scripting How to . Amarok is using the same technology to provide scripting of the music player