List Plug-ins

Version 01.51.00
Added 29 Aug 2005 (last updated 15 May 2020)

For use with Sibelius 4, Sibelius 4.1, Sibelius 5, Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

This plug-in writes a list of plugin names and numbers, sorted by name, to the trace window. If you have a lot of plug-ins, it makes it easier to find the plugin you want to assign a shortcut to, since the list on the Menus and Shortcuts page of File > Preferences is sorted by plug-in number.

Updated 17January2015. Added option to show full plugin path name for any loaded plugins so you can see if you will currently run a shipping or user version of a plugin. Sort by name is probably the useful option.

Updated 8 March 2019. Version 01.30,00. Sped up listing. Added ability to see all plugins, shipping plugins only, or user-installed plugins only.

Updated 20 March 2019. Version 01.40.00. Fixed plugin numbers when only shipping or only user plugins are listed.

Updated 15 May 2020. Version 01.51.00. Tidied up a bit, added option to not display plugin numbers, which are rarely useful.

Plug-in written by Bob Zawalich.

Convert Spaces To Units

Version 01.07.00
Added 06 Nov 2009 (last updated 14 Aug 2016)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

Convert Spaces To Units will convert fixed units like inches, mm, or points to or from "spaces" based units as used internally by Sibelius. (One "space" is defined as 1/4 of the staff height).

This plugin will probably only have niche uses, but if you are using wildcards that use space units, or are writing plugins, or are just trying to figure out how many x units in the General tab of the Properties window will make an inch, it can come in very handy.

This plugin requires Sibelius 6.1

Updated 8 September 2010 to correct invalid conversion of points.

Updated 14 August 2016 to prepare for multiple staff sizes.

Plug-in written by Bob Zawalich.

Backup Plug-in for Developers

Version 01.40.00
Added 09 Jun 2010 (last updated 27 Feb 2016)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

This plug-in allows plug-in authors to create multiple backup snapshots throughout the plug-in development process. Snapshots are useful to have when recent code changes impair/break your plug-in, and you can't or don't wish to spend time fixing the newly introduced errors.

Thanks to Bob Zawalich for use of some code, concepts and variable names from his Export Each Staff as Audio plug-in.

Thanks to Roman Molino Dunn for Mac testing and suggestions on how to make the plug-in more user-friendly.

Updated 20 June 2010.

The .zip file now also includes a copy of Restore Plugin for Developers, by Bob Zawalich, which can restore plugins which have been backed up by Backup Plug-in for Developers.

A number of bugs in Backup Plug-in for Developers have been fixed:

* Fixed bug whereas Comment was not being checked for illegal characters.

* Comment allowable characters are now platform specific and less restrictive.

* Added new Options button and dialog to allow user to select preferred date format, time format and delimiter character (space or tilde).

* Made dialog box wider to allow more path text to be shown.

* Made this Plug-in compatible with the Restore Plug-In.

* Fixed bug whereas after 1st session plug in path was not properly retrieved for some users.

* Added a validation to ensure "File backup location" ends with a legal path separator. If missing, it is automatically added.

* Fixed a bug whereas the "Filename for backup field" was not initially displaying the correct information.

Updated 8 August 2011 for Sib 7 user file location compatibility

Updated 26 February 2016 to speed up file copying.

Plug-in written by Ed Hirschman / Bob Zawalich.

Format ManuScript Comment For Developers

Version 01.01.00
Added 03 Aug 2010 (last updated 21 Feb 2020)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

This plug-in transforms free-form text into a nicely formatted comment box that can be pasted into other plug-ins. The plug-in handles comments of any length, and can be used for initial explanations that typically appear at the top of the "Run" method or for comments in other methods. The comment box width is user selectable, as are the horizontal and vertical borders characters. There are also several "signature line" type options available.

Any text pasted into the plug-in's input text box is truncated by Sibelius at the first encountered line break. As such, ensure there are no line breaks or carriage returns in your free-form text and then select an alternative line-break character such as the tilde (~) from the drop down menu, then type the selected line break character into your text to achieve multiple paragraphs. The formatted output is provided in the Trace window and can be pasted into your plug-in.

Updated 4 August 2010 with the following changes:

  • Added choice of left and right side border character
  • Right and/or Left borders can now be "None"
  • Right and/or Left borders can now be "//". Using // for the Left border ensures that line numbers are more accurate if syntax errors in your plug-in and that the cursor will jump to the correct error location.
  • Changed default left border to "//"
  • If options line is too wide, error message now suggests a minimum width
  • Added 110 and 120 as width choices

Plug-in written by Ed Hirschman.

Copy Plugin

Version 01.55.00
Added 02 Jan 2012 (last updated 28 Oct 2019)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

Make a clone copy of an existing plugin, with a new file name and a new menu name, in the same folder as the original plugin. This can be useful when making a variant plugin, or for creating multiple plugins that save data associated with the menu name.

It will remember the name of the last plugin you copied across Sibelius sessions, so you can set up your favorite template to reuse.

Updated 3 January 2011 to correct typos.

Updated 24 January 2012 to add default plugin names for easier cloning.

Updated 31 January 2012 to fix crashes on OSX in version 7.1.

Updated 26 February 2016 to greatly speed up file copy.

Updated 13 April 2016.By default it will increment plugin names that end in a number for default names. Also, it will allow you to create multiple copies in a single session. Now requires Sibelius 6 or later.

Updated 26 April 2016 to clarify error message that appears when the menu name is not defined using the _PluginMenuName variable.

Updated 20 October 2019. Version 01.52.00. Added ability to put copied plugin into any existing plugin subfolder. For shipping plugins a user subfolder can be created if it does not already exist.

Updated 23 October 2019. Version 01.54.00. Added ability to create new plugin subfolders that are not existing categories.

Updated 27 October 2019. Version 01.55.00.Plugin file was being created without a plg extension. Fixed.

Plug-in written by Bob Zawalich.

Minimum Plugin

Version 01.11.00
Added 02 Jan 2012 (last updated 14 Nov 2020)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

A public-domain plugin that provides a basic framework for a plugin that processes objects in a score.

This plugin may be used as a template, and may be adapted, modified and distributed without attribution (and you use it at your own risk!)

Updated 3 January 2011 to correct typos.

Updated 11 February 2012 to update comments - no code changes.

Updated 12 May 2018 to tweak some text.

Updated 6 November 2020. Version 01.08.00. More cleanup. Added IsValidObject routine.

Updated 10 November 2020. Version 01.10.00.

Cleanup and internal documentation changes to support a document on using this plugin.

Updated 13 November 2020. Version 01.11.00.Added code to handle DoNotDisplayDialog.

Plug-in written by Bob Zawalich.

Restore Edited Shipping Files

Version 01.15.00
Added 05 Jan 2012 (last updated 06 Aug 2015)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

Lists user copies of shipping plugins, house styles, and manuscript papers and offers to delete them or move them to a folder outside of the user subfolder.

This can be useful if you edit shipping plugins to see how they work, especially after a Sibelius update, when you cannot remember which ones you have edited, and want to enable the most recent versions.

Updated 3 August 2015. Renamed from Restore Shipping Edited Plugins to Restore Shipping Edited Files. Added tracking for edited House Style and Manuscript papers as well as plugins.

Updated 6 August 2015. Fixes Mac hanging bug.

Plug-in written by Bob Zawalich.

Pitch Values

Version 01.07.00
Added 12 Apr 2012 (last updated 29 Jan 2020)

For use with Sibelius 5, Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

This plugin displays the all possible MIDI values for note names, or all possible names for MIDI pitches, including double accidentals or quartertones. This can be helpful when writing plugins. It is pretty geeky.

Updated 5 September 2017. Added ability to trace pitches by accidental type, including triple accidentals, which can be produced only by plugins, convertors or other processes, but which sometimes appear. Now you can see all the possible sharp,or flat, or double/triple accidentals in one place. Still pretty geeky.

Updated 29 September 2017 Fixes to triple accidental display.

Updated 4 January 2018. Added accidental value for traces, chiefly for use with quartertones.

Updated 29 January 2020. Version 01.07.00. Reworked most of the code to fix problems with Cb and B# and their variants. Added triple accidentals to some listings and added a new option to trace note values in all pitches in a specific octave.

Plug-in written by Bob Zawalich.

Offtonic Note Info

Version 0.1
Added 26 Jul 2012 (last updated 07 Mar 2014)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

Note Info simply displays basic information about a specific note in a computer-readable format. I wrote it as a tool to help me understand how Sibelius internally represents notes, but I can imagine others wanting the same thing. Note that Sibelius's representation of a Note object is as an object inside a NoteRest object, so Note Info does not display duration or velocity, for example.

Plug-in written by Mauro Braunstein.

Edit Text File

Version 01.80.00
Added 28 Sep 2012 (last updated 22 Aug 2019)

For use with Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

For Sibelius 7.1.3 and later only.

Launches an application that will edit a text file. You specify both the application and the text file, and these files will be remembered over Sibelius sessions.

This could be be useful for plugins that create log files and text files, or even html files, and would like to display them from within Sibelius.

For plugin developers, please note that the mechanism to launching apps is rather different in Windows and OSX.

This plugin is dedicated to Mary Elizabeth, for her invaluable testing assistance.

Updated 13Feb2015 to fix a typ0 and add entry points for calling from other plugins

Updated 22 August 2019. Version 01.80.00. Corrected some bugs when called from other plugins.

Plug-in written by Bob Zawalich.

Align Notes

Version 01.09.00
Added 23 Dec 2014 (last updated 17 Jun 2015)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

This plugin aligns notes in selected bars by removing any rests that follow the last (right-align) or precede the first (left-align) chord, or tuplet in the bar.

It does not delete any rests; it shifts the note data and adds rests to the front or back of the bar. The size of the bar does not change.

Entire bars are always processed; if any part of a bar is selected, the entire bar is processed. All voices in selected bars will be processed.

The plugin can be run by a user, or other plugins can call RightAlign(score, bar) or LeftAlign(score, bar) to accomplish note alignment.

Plug-in written by Bob Zawalich.

Plugin Info

Version 01.10.01
Added 30 Jan 2015 (last updated 19 Feb 2019)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

This plugin displays a list of all the plugins currently installed on your machine. Selecting a plugin in the list will display its full file pathname, Category (on the current machine), User or shipping plugin status, Version if available, Plugin number, and Date Installed. The dialog will also display the number of plugin installed on the current machine.

The can be useful for seeing if you are running a modified version of a shipping plugin, or to compare the version number with the one on the download page, so as to see if you have the most recent version of a plugin.

Updated 24 November 2015 to add a trace button.

Updated 8 February 2016 to add Locate All Copies to find copies of shipping plugins in all languages.

Updated 18 October 2017. Added ability to list only user or shipping plugins, and ability to trace plugin info for all plugins in list, so you can get a list of all installed shipping plugins.

Updated 1 February 2018. Added Find box so it can find plugins bases on any bits of a word in the name. Also added plugin menu name to the data list so you don't need to look back and forth to the list box to see everything.

Updated 4 January 2019. Version 01.10.01. Disabled Locate All Copies for Mac because it was crashing.

Updated 18 February 2019. Version 01.10.01. Updated version number in plugin file to match download page.

Plug-in written by Bob Zawalich.

Custom Simple Plugin

Version 01.50.00
Added 13 Oct 2019 (last updated 13 Oct 2019)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

This is a template plugin meant to be copied and modified by users. It is in the public domain, and the code can be reused or modified at your own risk without need of attribution. The first published version is 01.50.00.

It is a model for a plugin that processes selected objects.

The default code, which is intended to be replaced, will select any Line objects in the original selection.

This is minimal code, with no error checking or warning messages. Use it for quick and dirty plugins.

Plug-in written by Bob Zawalich.

Trace Fonts For Text Styles

Version 01.07.00
Added 20 Aug 2020 (last updated 06 Sep 2020)

For use with Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

Original version 20 August 2020. Version 01.06.00. Writes, to the plugin Trace window, the initial font name and font size for a set of built-in text styles in the current score.

A plugin can call API_TraceTextStyleFonts(score, fTraceFonts), and will get back an array of the strings that would be traced, with blank lines and header lines removed. Setting fTraceFont False will keep the plugin from writing the data to the trace window.

This plugin is only possible because Daniel Spreadbury added some ManuScript calls at the very end of 7.1.2. They did not get into the build, and were forgotten until I recently checked to see if they were built into later versions, and they did get added into Sibelius 7.5 and later.

Thanks to Daniel and to the Sib developers who made the code changes go through.

Updated 5 September 2020. Version 01.07.00. Added the ability to trace user-defined Text Styles that are used in objects created in the current score, as well as built-in styles from a list.

Plug-in written by Bob Zawalich.

Minimum Plugin Preferences

Version 01.05.00
Added 29 Dec 2020 (last updated )

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

Added 29 December 2020, though written in 2011. Original version 01.05.00.

This is a plugin template for use by plugin developers, containing code that can be used to make it easier to save plugin preferences to the Preferences database.

The PDF file "Preferences plugin to save plugin preferences.pdf" is included in the zip file as well, and is also available at bobzawalich.com.

This plugin is in the public domain, and is available to be used and modified freely with no need for attribution. It is for use at your own risk, and no support is available.

Plug-in written by Bob Zawalich.

Add Plugin Preferences Lib

Version 01.07.00
Added 30 Dec 2020 (last updated )

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

Added 12/29/2000. Original version 01.07.00

This is a library plugin designed to be called by other plugins in order to more easily add calls to the Preferences database to save and restore dialog settings across Sibelius sessions.

See Minimum Plugin Add Plug Pref for an example of this in use. There is also a PDF file available explaining its use.

Plug-in written by Bob Zawalich.

Minimum Plugin Add Plug Pref

Version 01.07.00
Added 30 Dec 2020 (last updated 30 Dec 2020)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

Original version 01.07.00

This is a template plugin used to show how to call into the plugin Add Plugin Preferences Lib to more easily save plugin dialog preferences to the Preferences database.

This plugin is in the public domain, and is available to be used and modified freely with no need for attribution. It is for use at your own risk, and no support is available.

Plug-in written by Bob Zawalich.

Minimum Plugin Parent

Version 01.07.00
Added 06 Sep 2021 (last updated )

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

Added 6 September 2021. Version 01.07.00. This zip file contains both MinimumPluginParent.plg and MinimumPluginChild.plg.

The Parent-Child plugin model creates a main, full-featured Parent plugin, and any number of smaller-featured, dialog-free, Child plugins, which call the parent to perform a subset of its features.

In the Parent plugin, the dialog variables and other globals are isolated from the main processing routine. Any data required by the proceesing routine (called in this template API_ProcessSelection), are passed in a specially formatted Dictionary object. Any child plugin can similarly set up an appropriately formatted dictionary with the desired dialog settings made, and run API_ProcessSelection without needing to bring up a dialog.

The 2 plugins presented here are templates which are intended to be copied, perhaps with the Copy Plugin plugin, and modified appropriately. The code in these plugins is in the public domain and may be modified and used freely with no need to permission or attribution. They will be used at your own risk.

Each of these plugins has a routine called AA_How_To_Modify_This_Plugin, and there is a document called Parent-Child Plugins on Bob Zawalich's website that discusses the plugins in more detail.

The command RunPluginEntryPoint_cu, available in Execute Commands, can serve as a universal child plugin for calling any properly set up parent plugin

Plug-in written by Bob Zawalich.

Edit Formatted Text

Version 01.06.00
Added 22 Oct 2021 (last updated 22 Oct 2021)

For use with Sibelius 6, Sibelius 7.1, Sibelius 7.5, Sibelius 8.x, Sibelius 18.x, Sibelius 19.x, Sibelius 20.x and Sibelius 21.x

Version 01.06.00. This plugin displays the formatted text string for the first selected Text or System Text object. It does not process Lyrics. If the text is very long it will be split into multiple edit boxes, which will be joined together before being used to update the selected text object.

You can make changes to the text, and update the Text object with the updated text, but this plugin will not validate the changes you make. Use it carefully and at your own risk. You might use it on a copy of the text you want to change.

Valid formatting wildcards can be found in the ManuScript Language Reference in the section Expressions_string. Editing formatted text is similar to editing HTML code. This plugin lets you change formatted text when you cannot do it directly by pasting a formatted string into a Text object.

A PDF file explaining how to use the plugin is included in the zip file.

Plug-in written by Bob Zawalich.