Is there documentation for Musescore 2 plugin development?
I just started learning plugin development and I realised the example plugins provided in Musescore 2 don't really follow the documentation in musescore.org/en/plugins. Where can I find tutorials and documentation on Musescore 2 plugin development?
Comments
There is the API documentation build into MuseScore, available in the Plugin Creator's Help.
In reply to There is the API by Jojo-Schmitz
Yeah but it uses a lot of Musescore dev lingo which I don't really get XD Managed to figure out some stuff by looking at the examples though... Will the plugin development page update as well? (And should I start adding v2.0 related documentation to it?)
In reply to Yeah but it uses a lot of by matt28
Yes, I guess we'd need an updated 2.0 Plugin Development page, but probably a new set (just like for the MuseScore 2.0 Handbook), not as additions to the old 1.x one.
@Thomas, @lasconic?
In reply to Yes, I guess we'd need an by Jojo-Schmitz
I see. Btw, where does Cursor.rewind(2) bring the cursor to? Would it go all the way to the last element of the highest numbered track?
In reply to There is the API by Jojo-Schmitz
I am looking for this plugin creator, which is mentioned in https://musescore.org/en/development. Asking google with the phrase "musescore Plugincreator" lead me to this page.
Where Do I find this plugin creator?
In reply to I am looking for this plugin by hasenfuss
Its built-in to MuseScore itself, accessible via the 2nd item in the Plugins menu (default shortcut Ctrl+Shift+P). Once that is open, you can open the built-in documentation under Help > Manual
Note that this documentation is far from a user-friendly manual at this point. It is merely a listing of the available Objects and their methods. It contains no examples at this point in time.
In reply to There is the API by Jojo-Schmitz
Is there any getting started guide? I found the plugin creator (which requires you to have a score open BTW), and the "manual" is mostly empty, with some class definitions, but no information about what a plugin can do, how it does it, how it is invoked etc.
There really needs to be separate documentation for this with overview section etc
In reply to Is there any getting started by Adrien de Croy
The usual advice is to look at some of the sample plugins provided to get an idea of how to write them. As for "information about what a plugin can do, how it does it" - that is indeed the purpose of the class definitions. A plugin can do whatever those classes allow, and it does it by invoking the appropriate methods. Not sure what other information you'd be expecting. As for "how it is invoked", that is covered in the Handbook, but the the short answer is, you use the Plugin Manager to enable it and then you will find it listed in the Plugins menu.
I Downloaded a velocity plugin listed in the Musescore online plugin page that is in Javascript format, and Musescore 2.0.1 only reads qml files. What must I do to get this file to work? I hope this will resolve a number of playback issues that I now have since I uploaded 2.0.1. VERY important as I have a number of commissions riding on it.
In reply to I Downloaded a velocity by pubbys
You'd need to rewrite that plugin.
But what playback issues do you have? MuseScore 2.0 should be interpreting hairpins, so the real need for that plugin should have vanished.
In reply to I Downloaded a velocity by pubbys
Indeed, the velocity plugin would only have been needed in 1.3; it is no longer needed in 2.0 as hairpins playback automatically. If you are having issues, you should start a new thread in the support forum, attaching the score you are having problems and describing as precisely as you can what the problem is.
I just installed MuseScore on Ubuntu 16.04 and tried to get a look at the plugin development handbook, which is completely empty. Tried to switch from Swedish (my native language) to English-US to find out if that was the problem but it didn't help. How do I get to look at the plugin development procedure? Is there nowhere online where the handbook is replicated? That would be sufficient for my needs at the moment. For now I'm mostly curious how to develop plugins...
In reply to I just installed MuseScore on by Håkan Lidén
You mean Plugins/Plugin Editor/Help come up empty? If so I guess this is a mistake of the packagers for Ubuntu?
You shpould be able to download and run an AppImage, maybe even for 2.1 niglly builds, and see whether it is in there. Other than that look at existong plugins, and have a look at the 1.x plugin docs online (https://musescore.org/en/plugin-development), parts of them still apply