No internet connection
  1. Home
  2. How to

How can i run an installed plug-in in Sibelius

By Juan Arboleda @Juan_Arboleda
    2024-03-22 16:16:18.421Z2024-03-25 19:34:43.008Z

    Hi!

    I'm building my deck and I have a couple of custom plugins in Sibelius that I'd like to assign, but for the life of me, I don't know how. I'm sure it could be done using Java, but I'm not too familiar. I traced the plugin to get its name and tried running it on Java, but it doesn't work.

    Here's what I tried:

    sf.app.sibelius.invokeCommands({
        commandIds: ['RespellFlatsAsSharps'],
    });
    

    Any help would be greatly appreciated.

    Solved in post #12, click to view
    • 16 replies
    1. Hi Juan,

      Exciting to see you diving in :)

      I believe Sibelius doesn't support using invokeCommands for running plugins. We would instead need to add an action specifically for this - it'll likely be called "invokePlugin".

      I'll add an internal issue so we can track getting this added asap.

      1. JJuan Arboleda @Juan_Arboleda
          2024-03-22 17:24:14.406Z

          Hi Christian!
          Thank you, so far it's going good and I've been building some Decks. I'm still learning but it's all moving along.

          1. Nice! If our internal testing goes well, we should get the invokePlugin in SF 5.7.7.

            1. Hm I said this too fast. It appears that Sibelius handles plugins in a quite a bit more restrictive way unfortunately. What's the name of the plugin you want to run and where did you install it from?

              1. It turns out, Sibelius requires SoundFlow to tell Sibelius "ahead of time" which plugins we may want to use to control Sibelius later on, which makes it a bit tricky.

                If you can figure out the name of the ".plg" file in this directory, that would most likely be the first step to testing this:

                /Users/[YOURUSERNAME]/Library/Application Support/Avid/Sibelius/Plugins
                
                1. JJuan Arboleda @Juan_Arboleda
                    2024-03-22 22:07:48.666Z

                    Thats Awesome!
                    Here's the list of the plugins we use:

                    RespellFlatsAsSharps.plg -- this is the one we've been referring too.

                    but these we also use all the time:
                    CautionaryTimeSignatures-1.plg
                    ChordSymbolFractionsSingleObject.plg
                    CopyDoubleNoteValues.plg
                    CopyHalveNoteValues.plg
                    TimingForSelection.plg
                    CustomSlurGroups.plg
                    HSandTitles (FiLMS).plg
                    ImposeSketchontoTemplate.plg
                    ExchangeStaffContents.plg
                    ImposeSketchontoTemplate.plg
                    PasteRhythmtoPitches.plg
                    ResetSpacingInScoreAndParts.plg
                    SplitMultirests.plg
                    UseMusicFontForDynamics.plg

                    1. Thank you, Juan. And these are all in that folder I shared the link to, right?

                      1. In reply toJuan_Arboleda:

                        I have RespellFlatsAsSharps working internally now. I'll send you a preview build to test with asap.

                        1. JJuan Arboleda @Juan_Arboleda
                            2024-03-25 19:32:19.882Z

                            Thanks you!!!

                            1. No problem :)

                              Please use the following link to install the preview 1 build of SF 5.7.7 which includes the new invokePlugin action:

                              https://downloads.soundflowcdn.com/5.7/5.7.7-preview.1/b5337d36137826ff/SoundFlow_5.7.7-preview.1.pkg

                              You can then run a plugin like so:

                              sf.app.sibelius.invokePlugin({
                                  pluginName: 'RespellFlatsAsSharps',
                              });
                              

                              Note that invokePlugin also takes a methodName property (which defaults to 'Run' if nothing is specified), and an args property, which should be supplied as a JSON object in the event you want to pass custom arguments to the plugin function.

                              ReplySolution
                              1. JJuan Arboleda @Juan_Arboleda
                                  2024-03-25 20:23:16.024Z

                                  Awesome! the first one ran, when i tried using sharps to flats it stopped working, so i guess in need to invoke the args. how do you do that? the script you sent work wonderfully!

                                  1. Hm, that's odd, it works just fine for me on repeated use. Passing arguments to a plugin is not likely to be how these are intended to be used, so I don't think that's what you need to do here.

                                    Can you try sending a support ticket and try telling exactly what you're doing and which error(s) you might see?
                                    Steps here:

                                    https://soundflow.org/docs/help#help-issue

                                    1. JJuan Arboleda @Juan_Arboleda
                                        2024-03-25 21:10:19.784Z

                                        Now it is working when i restarted sibelius. weird. thank you for all your help! it's been invaluable!

                                        1. Awesome! Very happy to hear it :)

                  • S
                    In reply toJuan_Arboleda:
                    SoundFlow Bot @soundflowbot
                      2024-03-22 17:09:29.946Z

                      This issue is now tracked internally by SoundFlow as SF-1158

                      1. S
                        In reply toJuan_Arboleda:
                        SoundFlow Bot @soundflowbot
                          2024-03-25 22:40:21.569Z

                          The linked internal issue SF-1158 has been marked as Done