Skip to content
/ musescore-xen-tuner Public

full xenharmonic & microtonal support for musescore! just intonation, regular temperaments, chromatic staves, bohlen pierce, anything at all

License

GPL-3.0 license
35 stars 2 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

euwbah/musescore-xen-tuner

BranchesTags

Repository files navigation

Xen Tuner: Microtonal MuseScore Plugin Suite

A MuseScore 3.6 plugin to give first-class support for microtonal/alternative notation systems. MuseScore 4 support needs testing.

GitHub Sponsors

Features/Goals

  • Infinitely many tuning systems with customizable SMuFL/text-based accidentals. HEJI, HEWM, Sagittal, Johnston JI, Rank 2/3/+ tunings, very large edos, ... (SMuFL symbols data entry help needed! Currently at 77%)

  • Automated tuning & placement of multiple accidentals.

  • Every accidental/note is accessible with up/down operations and 'J' to cycle through enharmonics, no matter how large the tuning.

  • Configurable auxiliary up/down operations to transpose by selected accidentals/nominals.

  • Accidental ligatures where multiple accidentals can combine and be represented as a single symbol (e.g. HEJI & Sagittal)

  • Use of fingerings for text-based input of accidentals

  • Specifying JI ratios and cent offsets in fingerings.

  • Proper transposition by any interval of choice for all regular mappings.

  • MIDI/MPE export with channel pitch bend support. (WIP. MIDI files containing MPE data are generated, but no workflow exists to import these directly to a DAW)

Quick Start

⚠️ This project is very experimental. Please check Caveats

1. Download & activate plugin

Download the project as .zip (the green "Code" button on top right of the project page).

Extract files to plugins folder and activate all the following plugins (see this guide if you don't know how):

2. Remove MuseScore default shortcuts

🔴 You must remove the following default keyboard shortcuts in MuseScore's shortcut preferences. (This plugin is designed to replace MuseScore's default shortcuts.)

  • Pitch up/down or move text/articulation up/down (Up/Down arrow keys)
  • Change enharmonic spelling (J)
  • Diatonic up/down (Shift+Alt+Up/Down)
  • Go to higher/lower pitched note in chord (Alt+Up/Down)
  • Go to top/bottom note in chord (Ctrl+Alt+Up/Down)

Also, if you're going to use the fingering accidentals/tuning feature a lot, it's recommended to change Ctrl+F to "Add fingering" instead of "Find / Go to".

🟢 If you still want access to the old MuseScore keyboard operations, you can also remap them to unused keystrokes.

3. Start Xen Tuner

start tuner

Once you have activated the plugins & replaced the shortcuts, you can start the plugin in Plugins > Xen Tuner > Start Xen Tuner.

⚠️ You only need to run this once! Starting the plugin will open a small docked panel on the bottom left. If you close this panel, you will need to restart Xen Tuner.

The first time you start Xen Tuner after opening MuseScore, MuseScore will freeze for about 5 seconds while it loads. This is normal.

🔴 If you wish to close the plugin, use the "Quit" button. Do not close the plugin window directly using the window's 'X' button.

4a. Select tuning configuration

specify tuning config

Tunings configurations are .txt (text) files located inside the tunings/ folder of the project which describe a particular tuning and notation system to the plugin.

In the image above,

To activate a tuning configuration to all staves, insert a System Text to the score at the start of any bar, which will apply the referenced tuning configuration .txt file from that bar onwards, you can change between tunings/notation systems in different bars.

To apply a configuration to only one staff, use a Staff Text instead of System Text.

These Staff/System Texts can be made invisible (you can select them and press V to toggle visibility).

🟢 For a start, try out heji/5 limit, which references the ./tunings/heji/5 limit.txt tuning system configuration file.

You can browse tunings in the tunings/ folder to find notations that are already supported.

Continue reading to learn how to create your own tuning configurations, or submit a tuning config request issue.

🟡 For power users: Sometimes, a tuning config file has a .json file type instead of the usual .txt. This is used for very large tunings which have precomputed tuning configuration files. Modifying the .txt file alone will not affect the tuning configuration, instead, you will have to delete the .json file, and use the web tool (https://euwbah.github.io/musescore-xen-tuner/) to create a new .json precomputed tuning configuration file.

🟠 While it is not recommended, you can also input the tuning configuration text directly into System/Staff texts, which may be helpful when you are creating your own custom tuning configs and want to test them out. Newlines/enter/return can be entered into System/Staff Text using Shift + Enter/Return. This feature saves the need for going back and forth between the text editor and MuseScore. Remember to save it into a .txt file once you're done!

4b. Annotate key signatures

All key signatures, both standard and custom/microtonal, must be annotated in order for the plugin can read them, otherwise they will be ignored by the plugin.

Read how to annotate key signatures here

These Staff/System Texts don't have to be visible (you can press V to toggle visibility).

5. Entering notes & accidentals

  • Enter notes as per normal.
  • Press Alt+R after entering new notes to update the tuning. (⚠️ Do not confuse with Ctrl + R, which will undo the plugin's autoplacement of the accidentals)
  • The up and down arrow keys will cycle through pitches defined in the tuning configuration.
    • 🟡 In large tuning configurations (e.g. hewm/540edo), not all pitches can be accessed using up/down arrow keys alone. Instead, you will need to input the accidentals manually using fingerings or by other means. These manual-input accidentals are called secondary accidentals, as opposed to the primary accidentals which are declared in the tuning configuration as primary accidental chains.

You can use Alt/Ctrl/Shift modifiers to control the pitch modification performed by arrow keys:

  • Up/Down: Move note up/down to the next nearest step
  • J: Cycle through enharmonics of the note
  • Alt+Up/Down: auxiliary operation 1 (usually for moving up/down diatonically)
  • Ctrl+Alt+Up/Down: auxiliary operation 2 (usually for sharps/flats - first accidental chain)
  • Alt+Shift+Up/Down: auxiliary operation 3 (usually 5-limit accidentals - or second accidental chain)
  • Ctrl+Alt+Shift+Up/Down: auxiliary operation 4 (usually 7-limit accidentals - or third accidental chain)

These shortcuts can all be modified, and more auxiliary operations can be added, with a simple edit made to the main .qml plugin file. Read how to configure shortcuts here.

Entering accidentals directly using fingerings

The next best way to enter accidentals is by entering fingerings containing the text-representation of accidentals. This feature can be used when text representations of accidentals are declared in the tuning config. The plugin matches strings of text and converts them into accidental symbols (which can either be SMuFL or text-based). Refer to the tuning config .txt files to lookup which characters represent which accidental symbols.

🟢 When using this feature, it is recommended to map the default Ctrl+F shortcut to "Add fingering" instead of "Find / Go to".

Select a note, hit Ctrl+F, then enter the text representation of the accidental(s) you need on that note. You can press space or shift+space to apply fingerings on next/previous notes.

Once fingerings are entered, hit Alt+R and the accidentals will render themselves.

Manually adding accidentals

The most primitive method: dragging SMuFL symbols in from the Master Palette, then hitting Alt+R.

⚠️ A word of caution if you are using this method: the plugin does not recognize the standard accidentals that MuseScore normally uses from the Accidentals palette. You must use SMuFL symbols from the 'Symbols' category in the Master Palette (shortcut: Z).

6. Change reference pitch

You can change the reference pitch of a score by adding a System Text or Staff Text element with the text <midi note name>: <frequency>.

🟡 For example, A4: 440 will set the written note A4 to sound at 440hz.

You can use math/javascript expressions to calculate the frequency:

🟡 e.g.:

  • C4: 16/27 * 440 will set the written note C4 to sound at a 3-limit major 6th below A4=440
  • C4: 440 * Math.pow(2, -17/22) will set the written note C4 to sound at 17 steps of 22edo below A4=440.

🟢 You can also not specify a frequency (e.g. C4:). This will only change the tuning note without changing the tuning, which is useful if you're making use of just intonation ratios on notes or want the Display Cents/Steps plugins to use a different reference note as the root note (1/1, step 0).

🟠 Advanced feature: when you change the MIDI reference pitch, the plugin will preserve the mode of the nominals, but you can override the starting note of the nominals by prefixing a `!`, e.g. `!C4: 263`.

🟡 E.g. Let's say the tuning config declares A4: 440 and nominals according the "white keys" (A aeolian mode ABCDEFG). If we change the reference pitch to C4: 256, it will still preserve the nominal's mode such that ABCDEFG will be LsLLsLL (W-H-W-W-H-W-W), preserving the 'white keys'

However, if we use !C4: 256, it will override the starting note of the nominals to C, and the nominals will be CDEFGABC (W-H-W-W-H-W-W), which means the written 'white keys' now sound like C minor.

This is rarely ever useful though, and only provided as an advanced feature for esoteric notation systems/notating changing alternate clefs.

🔴 If you intended to use a custom key signature, declare a key signature instead.

7. Implement your own tunings/notation systems!

Continue reading the rest of the guide to learn how to create custom tuning configurations.

Alternatively, dive straight in to the tunings/ folder for examples. heji/5 limit showcases all the main features of this plugin, so it's a good place to start.

If you require assistance with implementing any particular notation system, or want to contribute a tuning config but don't know how to use Git, feel free to file an issue under Request/contribute tuning config.

Tuning config web tool

You can use the tuning configuration compiler/debugger web tool to check for syntax errors. You can also use it 'compile' your tuning config into a .json file so that large tuning files can be pre-computed for faster loading.

If you're facing a bug or need help, file an issue.

8. Display Steps & Display Cents

Display steps/cents

You can automatically generate text to display the cent offsets and edo/neji-steps of notes in the score/selection. Use the Display Steps and Display Cents plugins to do this.

Display Steps will attach fingerings to notes to display how many steps the note is away from the reference tuning note.

🟠 To get Display Steps to work, the tuning configuration being used must have it enabled with the displaysteps() declaration. The tuning config files of EDOs & NEJIs that come with the plugin already have it declared.

Display Cents will attach fingerings to notes to display the cent offset of the note relative to its nominal tuning (nominal mode). However, you can also configure the Display Cents to use absolute or semitone mode, and adjust how many decimal places are displayed in the displaycents() declaration.

🟡 You don't need to delete previously generated text before running Display Cents/Steps again to update the cents/steps information. Simply run Display Cents/Steps again, and it will override the old text values.

List of Supported Symbols

This is still a work in progress. Free for all to edit, and in need of community contribution!

Full documentation

Introduction

🟢 This section introduces important terminology. It is recommended to read this section before the rest of the guide.

Nominals & Equave

The nominals are the 'musical alphabet'. In 12edo terms, we call them the 'white keys'. That is, the notes without any accidentals attached to them.

Normally there are only 7 nominals (letters A to G), and the distance between two of the same nominals is called an octave.

However, in Xen Tuner, you're free to declare as many nominals as you want, tuned to whatever you want, as long as you have at least 2 nominals. The distance between two of the same nominals is called an equave. You can set the equave to whatever interval you want.

This means, you can construct notation systems like the chromatic staff, where all nominals are the same size, or Bohlen-Pierce with 9 nominals. For whatever reason, you can even write using the negative treble clef (negative harmony) by setting the equave to negative -1200c. Then, notes that are visually going up will sound like they're going down.

Symbol codes, text codes, text-based accidental symbols

A symbol code represents a single visually/semantically unique symbol which can either be a SMuFL symbol ID or one or more characters of text (ASCII).

This plugin only uses SMuFL symbols from the 'Symbols' category in the Master Palette (shortcut 'Z'). Do not use accidentals from the 'Accidentals' palette.

symbols palette

To refer to a SMuFL symbol when setting up a tuning/key signature, you can either use the Symbol Code number (the Symbol Code column of the spreadsheet), or by the Text Code representation of the symbol (Text Code column of the spreadsheet).

Spreadsheet lookup

🟡 E.g. both # and 5 can be used to refer to the sharp symbol.

Code 100 doesn't have a Text Code attributed to it (at this time of writing), so you can only refer to it by entering 100.

You can also use text-based accidentals by referring to them in single quotes, as long as the text does not contain a space.

🟡 E.g. 'abc' represents the literal text abc as a single accidental symbol.

Escape codes

When referring to Text Codes or Text-based accidentals in the tuning configuration, certain special charcters need to be escaped with a backslash:

  • Write ' as \' unless you intend to create a text-based accidental
  • Write \ as \\ unless you intend to start an escape sequence.
  • Write // as \/\/ unless you intend to write a comment.

This applies to both text codes and quoted text accidentals.

For example, the down arrow symbol (SymbolCode 43) must be referred to as \\ even though the text code for it is \.

Constructing an accidental

Multiple symbols can combine to form a single logical accidental that represents a single pitch adjustment in an accidental chain. Separate each symbol code/quoted text with a period to combine them.

🟡 E.g. x./.'hi' refers to a single accidental comprised of the double sharp symbol, up arrow symbol and the text 'hi', left to right order.

Accidental chains & degrees

Now, when we say "sharps and flats", these accidentals represents a chain of accidentals along a spectrum. For the purpose of this plugin, let's call it the accidental chain. Each successive item in this chain of sharps and flats refer to a constant-sized pitch increment. The number of increments of the unit interval is called the degree of the chain. # (sharp) is "degree 1", and bb (double flat) is "degree -2" of the sharps-flats chain.

In 12edo, each degree along the sharps/flats chain represents a 100 cent increment, so degree -2 would be -200 cents. We can theoretically extend this chain indefinitely to include as many sharps and flats as we want.

You can't attach two accidental degrees from the same accidental chain on to a single note (like how it wouldn't make sense to call a note "C-sharp-double-flat-triple-natural").

To combine and permute different accidentals, declare multiple accidental chains. E.g. C#/ can signify +1 degree sharp, and +1 degree syntonic comma.

Accidental vectors

You can combine different accidental degrees from different accidental chains. The degrees of each accidental chain forms a list of numbers called the accidental vector. This is a unique representation of all the accidentals attached to one notehead.

🟡 E.g. in 5-limit Helmholtz-Ellis Just Intonation (HEJI) notation, we need to define two accidental chains.

First, the chain of sharps and flats, where each step in the 'sharp' direction corresponds to the apotome interval (2187/2048). These accidentals allow us to access 3-limit just intonation.

Next, the chain of syntonic commas, where each step up is equal to the syntonic comma (81/80). These accidentals give access to 5-limit just intonation.

Now, we can notate the classic major third (5/4) of D as F#v (F-sharp-down). F#v is 1 step up in the 'sharp' direction, and 1 step down in the 'syntonic comma' direction. Thus, we can represent this note as having the accidental vector of 1, -1.

Main tuning space

In this plugin, there are two ways accidentals can be declared. The primary accidentals are declared using Accidental Chains, but there are also secondary accidentals which allow you to declare how non-primary symbols are interpreted.

Notes with accidentals declared via accidental chains form the main tuning space, which is the 'fully supported' set of notes that the plugin recognizes. You can think of these fully supported notes as 'Tonal Pitch Classes', but for XenNotes instead of normal 12edo notes.

In large tunings like high-limit JIs and very large edos, it's common to use notes that are not in the main tuning space, as it wouldn't be feasible to declare as many accidental chains as there are ranks in the tuning. However, these notes will not be accessible via the up/down arrow keys, and also not supported by the Display Steps feature.

How to: tuning configuration

To declare a tuning system, we need to enter the Tuning Configuration into the score. These can be entered as text in System Text or Staff Text elements.

System Text elements will apply to all staves, whereas Staff Text will only apply to the staff it is attached to. Configurations will only apply from its own bar onwards.

You do not need to write the entire tuning configuration within a staff text. E.g. if you frequently use a tuning with rather lengthy configuration text, you can create a .txt file (or pre-computed .json file) inside the included tunings/ folder.

🟡 E.g. to refer to the 5-limit HEJI tuning config in tunings/heji/5 limit.txt, simply write heji/5 limit in the Staff/System Text.

🟢 Recommended: have a look at the provided tuning configs in the tunings/ folder to see how notation/tuning systems are configured.

🔴 Beware: if you find two files with the same name where one is a .txt and the other a .json file, this means that the tuning configuration is pre-computed. Read more about it in this section.

The plugin will opt to look for pre-computed .json tuning configurations first, so changing the .txt file will not affect the tuning config. Instead, you will need to use this web tool: https://euwbah.github.io/musescore-xen-tuner/ to generate a new .json file to replace the old one.

Now lets dive into how we can create our own tuning/notation systems.

Tuning configuration overview

A tuning/notation system configuration is specified in plaintext, and consists of the following parts:

  1. Reference note e.g. A4: 440
  2. Nominals & equave size
  3. Accidental chains (optional)
  4. Optional declarations:
    • Ligatures allow you to declare how different symbols combine into other symbols. Advanced ligatures can control which enharmonic spellings/accidentals are present in a tuning.
    • Auxiliary operations define what the other keyboard shortcuts (e.g. Alt+Up/Down) do. You can control which accidental chains will be affected, and whether or not the nominal is allowed to change when using those auxiliary up/down operations.
    • Secondary accidentals define additional symbols that are not part of the main set of notes accessible by up/down operations, but will still act like accidentals. You can access these by declaring text representations of the accidentals and entering the accidentals as fingerings.
  5. Preference settings:

Tuning configuration syntax overview

You can try to make sense of this yourself to fast-forward the learning process, otherwise, the rest of the guide will explain this is greater detail.

// This is a comment. Comments are ignored by the plugin.

// 1. Reference note

C4: 440 * 16/27 // set frequency reference note (must be without accidental)

// Intervals/frequencies can be specified as math/JavaScript expressions.

// 2. Nominals

// Nominals start from the above specified reference note
// Cents must end with c, otherwise the number is treated as a JI ratio.
// Last number specifies the interval of the equave.
0c 200c 34/27 Math.pow(11/10, 3) Math.sqrt(49000)c 27/16 1101.1c 2/1

// 3. Accidental chains

// each accidental must be separated by a space.

// chain 1: the usual 100c semitone accidentals
bbb.b bbb bb b (100c) # x #x x.x

// chain 2: text based accidentals
'-'.'-' '-' (81/80) '+' '+'.'+'

// chain 3: combination accidentals & irregular accidental sizes
'hello'.68(-31.7c) (0) 'bye'.67(Math.sqrt(28/21))

// chains 4-6: certain characters must be escaped with a backslash.
// Applies to both text-based accidentals and Text Codes

b\/\/ (0) // the double slash (//) of the 'b//' (Buyuk Mucenneb)
          // must be escaped to prevent it from being treated as a comment.

\'\' \' '\'' (0)  // single quote must be escaped.
\\ '\\' (0)  // backslash must be escaped

// After declaring accidental chains, we declare other
// configurations: ligatures, auxiliary operations, and
// secondary accidentals. 
//
// These declarations can be done in any order.

// 4a. Ligatures

lig(1,2) // signifies declaring a ligature that apply to chains 1 and 2
1 -1 #v // sharp and minus (#.'-') becomes sharp arrow down symbol
1 1 #^ // sharp and plus (#.'+') becomes sharp arrow up symbol

lig(x, y, z, ...) // create ligature that applies to chains x, y, z, ...
etc...

// question mark denotes a weak ligature (opposite of weak is 'strong')
lig(1)?
etc...

// Exclamation mark denotes an important ligature (opposite is 'non-important')
lig(2)!

// This is a weak & important ligature (order of '?!' doesn't matter)
lig(1,2)!?

// 4b. Auxiliary operations

aux(0) // 1st aux up/down adjusts note diatonically
aux(1) // 2nd aux up/down modifies first accidental chain (flat/sharps)
aux(2,3) // 3rd aux up/down modifies 2nd and 3rd accidental chains

// 4c. Secondary accidentals & text representations

sec() // signifies start of secondary accidental declaration.

't' + 50c // quarter sharp symbol raises note by 50c.
// This symbol can be entered via fingering using the "t" text representation

'#' # 100c // additional sharp symbols raise note by 100c
'b' b -100c // additional flat symbols lower note by 100c

'+++' #+ 150c // triple plus converts into sesquisharp symbol.
// This must be declared before '+', otherwise, when entering
// accidentals using text representation fingerings, a triple-plus
// will match as 3 separate plus symbols ('+'.'+'.'+')

// Text representations' matching precedence is determined by
// the order of declaration.

'+' 81/80 // additional plus symbols raise note by syntonic comma
// because '+' is a single-symbol text-based accidental, "+" is
// automatically set as the text representation for this accidental.

'abc' 0.01c // this is also a single-symbol text-based accidental
'a'.'b'.'c' 0 // this isn't single-symbol.

// 4d. nobold
nobold() // declaring this will make text-based accidentals not bold by default

// 4e. explicit
explicit() // declaring this will make every note use explicit accidentals

// 4f. configure display cents/steps
displaycents(absolute, 2, above)
displaysteps(1337, below)

Reference tuning frequency, nominals and accidental chains must be specified in fixed order. After those are the secondary declarations (aux, lig, sec, etc..) and they can be specified in any order.

Apart from the reference note and nominals, all the other declarations are optional.

Full example

See heji/5 limit.txt for a fully annotated example of implementing the tuning configuration for the extended Helmholtz-Ellis just intonation notation (2020 edition). All the features of the plugin is featured in that tuning config. the up/down operations are implemented for up to the 5 limit, but higher limit accidentals are available as secondary accidentals, and can be entered via fingerings with the accidentals' text representations.

Most of this section revolves around the heji/5 limit.txt tuning config. Continue reading for a detailed explanation on how you would go about creating tuning configs like this:

Simple example

Let's start of with the simplest example: Just the white keys of the piano:

A4: 440
0c 200c 300c 500c 700c 800c 1000c 1200c

A4: 440 specifies the reference note and tuning in Hertz, which sets the note A4 to 440hz.

0c 200c 300c 500c 700c 800c 1000c specifies, in cents, the tunings of each of the 7 nominals starting from the reference note of choice, A4. This means that B4 will be 200c higher than A4, C5 will be 300c higher than A4, etc... Each entry must be separated by a space.

The last interval size, 1200c, specifies the equave size. The equaves are referenced in terms of the nominals defined, rather than the standard 12edo octave. E.g., if you only declare 2 nominals, then the next equave up from A4 will start at C5 instead of A5.

Adding accidentals

Now let's add the usual 12edo accidentals to complete the 12edo tuning system.

A4: 440
0c 200c 300c 500c 700c 800c 1000c 1200c
bb b (100c) # x

The last line adds a chain of accidentals ranging from double flat to double sharp. You can specify the accidental symbols as Symbol Codes or Text Codes, each degree of the accidental chain must be separated by space, and the (100c) in the middle means that increasing the degree on this chain by 1 will result in a 100 cent pitch increase.

Adding too many accidentals

Sometimes, scores call for triple sharps and flats. Why not go all the way and add 6?

A4: 440
0c 200c 300c 500c 700c 800c 1000c 1200c
bbb.bbb bb.bbb bb.bb bbb bb b (100c) # x #x x.x #x.x #x.#x

As shown above, a single degree on an accidental chain can be composed of multiple symbols. To combine symbols, join Symbol Codes/Text Codes with a period. E.g. bb.bbb means that degree -5 of the chain is notated as a double flat followed by a triple flat.

Now's a good time to play with enharmonic cycling (J key).

Just Intonation (JI)

Now, let's convert what we have into 3-limit just intonation (and also tone down on the accidentals)

C4: 440 * 16/27
0 9/8 81/64 4/3 3/2 27/16 243/128 2
bbb bb b (2187/2048) # x #x

🟢 Every ratio/cents interval can be specified as a math/JavaScript expression.

To differentiate ratios from cents, cents must end with a 'c'.

We're now setting the reference note C4 to a just-intonated 3-limit major sixth below A4. Because of that, we can now specify our nominals starting from C, which makes it a little easier to calculate the ratios.

Our nominals are now all 3-limit ratios built off a chain of pure fifths from F to B, which are the standard nominals used in JI notations (unless you're writing in Ben Johnston's system).

More accidental chains: 5-limit JI

C4: 440 * 16/27
0 9/8 81/64 4/3 3/2 27/16 243/128 2
bbb bb b (2187/2048) # x #x
\.\ \ (81/80) / /./

We can add more accidental chains by appending each one on a new line.

Here, we use the up and down arrow symbols to represent the syntonic comma. To get 2 arrows we combine the symbols with a period.

We now have access to those 'sweeter' 5:4 major thirds like C-E\ instead of C-E.

Accidental ligatures: "Real" HEJI

If we want to notate in HEJI proper, those arrows aren't the right symbol for the syntonic comma.

In HEJI, the first two accidental chains (syntonic commas & sharps/flats) are represented by a single ligatured accidental with the up/down arrows being attached to the sharp/flat symbol.

To add support for notation systems where a particular accidental can represent multiple accidental chains at once, we can declare a ligature set. You can think of it as a list of "search-and-replace" conditions that ligatures (joins/connects/substitutes) different symbols into a different unique symbol. A ligatured accidental is part of the main tuning space, and functions just as the original accidentals it represents, differing only in visual appearance.

Think of them like font ligatures where multiple characters conjoin into a unique shape.

C4: 440 * 16/27
0 9/8 81/64 4/3 3/2 27/16 243/128 2
bbb bb b (2187/2048) # x #x
v3 v2 v (81/80) ^ ^2 ^3
lig(1,2)?
-2 -2 bbv2
-2 -1 bbv
-2 1 bb^
-2 2 bb^2
-1 -2 bv2
-1 -1 bv
-1 1 b^
-1 2 b^2
0 -2 v2
0 -1 v
0 1 ^
0 2 ^2
1 -2 #v2
1 -1 #v
1 1 #^
1 2 #^2
2 -2 xv2
2 -1 xv
2 1 x^
2 2 x^2

We start declaring a ligature with lig(1,2)?. The numbers 1,2 mean that this ligature applies to only the 1st and 2nd accidental chains — meaning that it will only replace symbols that are part of the 1st and 2nd accidental chains, leaving other chain's symbols untouched. The ? signifies that this is a weak ligature (don't worry too much about that for now).

After that, we declare each search-and-replace condition on a new line.

-2 -1 bbv means that if the 1st accidental chain is on degree -2 (double flat), and the second accidental chain is on degree -1 (down arrow), then we replace it with the single symbol bbv (double flat with single down arrow).

⚠️ IMPORTANT: The degrees -2 -1 must be specified in the same order as the ligature's chain declaration.

🟡 For example, if we declared lig(2,1) instead, with the second accidental chain on the left, then you would need to write the search-and-replace condition as -1 -2 bbv, since now the left number refers to the second accidental chain.

The ligatured accidentals can be constructed with multiple symbols. As per usual, you join multiple symbols with periods.

🟠For basic ligature usage, ligatured symbols should not contain symbols that are already used as part of an accidental chain, and ligature declarations should always be weak (suffixed with ?). However, more intricate behaviors/notation systems can be configured with advanced ligature usage.

🟢 A ligature definition can be made weak (?), important (!), or weak and important (!?). If no modifiers are specified, it is by default a strong ligature (opposite of weak).

Read more about advanced ligature usage here.

You can also declare more than one ligature set, regarding different chains. Though special care must be taken when deciding the order of declaration of the ligatures.

Auxiliary operations

Auxiliary up/down operations give more control when transposing a note. You can define whether the nominal can move, and exactly which accidental chains can change degree.

C4: 440 * 16/27
0 9/8 81/64 4/3 3/2 27/16 243/128 2

// chain 1: sharps-flats
bbb bb b (2187/2048) # x #x

// chain 2: up/down arrow
\ (81/80) /

// Auxiliary operation declarations:
aux(0)
aux(1)
aux(2)
aux(0,1)

Each auxiliary operation is declared on a new line. The first declaration corresponds to the first aux operation, the second declaration to the second aux operation etc...

The numbers in the parenthesis denote what can change during the operation:

  • 0 allows the nominal of the note to change
  • 1 allows the first accidental chain to change
  • 2 allows the second accidental chain to change
  • etc...

The above example specifies that:

  1. The first auxiliary operation (Alt+Up/Down) changes only the note's nominal, similar to MuseScore's diatonic pitch up/down function.

  2. The second auxiliary operation (Ctrl+Alt+Up/Down) changes the first accidental chain's degree, allowing you to adjust the number of flats and sharps on the note directly.

  3. The third auxiliary operation (Shift+Alt+Up/Down) changes the second accidental chain's degree, allowing you to adjust the number of up/down arrows on the note directly.

  4. The fourth auxiliary operation (Ctrl+Shift+Alt+Up/Down) changes both the nominal and the sharps-flats chain, which allows you to navigate the 'chromatic scale'.

You can specify whichever combinations of numbers from 0 to N (number of accidental chains) that you may find useful for your tuning/notation system. The order of the numbers in the parentheses do not matter.

If you require more than 4 auxiliary operations, you can set up more keyboard shortcuts. You can also change the default keyboard shortcuts for these operations.

Configuring display steps

🟠 In order to use the Display Steps plugin, the tuning configuration needs to configure the steps display using the displaysteps() declaration.

// Syntax: displaysteps(<steps per equave>, <placement>)

displaysteps(31, below) // E.g. 31 step tuning, place text below note

<steps per equave> denotes the total number of distinctly tuned steps this tuning uses within an equave

🟡 This generally corresponds to edos - arbitrarily large edos are supported.

You also can get this working for NEJIs/temperaments and other step-based tunings as long as you ensure that all the notes in the score are in the main tuning space.

<placement>:

  • above - text displayed above the note
  • below - text displayed below the note

Configuring display cents

You can configure how cents offsets are being displayed, and how cent offsets are calculated.

// Syntax: displaycents(<calculation mode>, <precision>, <placement>)
displaycents(nominal, 0, above)

<calculation mode>:

  • nominal (Default) - cent offsets are calculated relative to the nominal of the note
  • absolute - cent offsets are calculated relative to the specified tuning note modulo the equave. (E.g. if A4: 440 is used in a 7-nominal tuning, then it will display number of cents above the nearest A)
  • semitone - Same as absolute, but modulo 100 cents instead, to give the cent offset from the nearest 12-edo semitone. (A bit janky at this point, not recommended)

<precision>: The number of decimal places in the cents display.

<placement>:

  • above - text displayed above the note
  • below - text displayed below the note

Advanced: Irregularly sized accidental chains

Within an accidental chain, you can specify additional offsets to be applied to each accidental degree like so:

A4: 440
0c 200c 300c 500c 700c 800c 1000c 1200c
bb b(15c) (100c) #(-3c) x(8/9)

The additional offset on the degree is written in parentheses right after the accidental symbol code(s), without a space between the symbol and the parentheses.

  • b(15c) will make degree -1 (flat) equal to -85c instead of -100c
  • #(-3c) will make degree 1 (sharp) equal to 97c instead of 100c
  • x(8/9) will make degree 2 flatter by the 9/8 Just Intonation interval, making it only ≈3.9c

If you have very irregular interval sizes between accidentals, it might be better to set the accidental size to 0 and specify the offset of each degree individually. For example:

bb(8/9) b(15/16) (0) #(17/16) x(8/7)

Advanced: advanced ligature use, weak & important ligatures

🟠 Make sure you understand the basics of ligatures before reading this section.

If you've tried out the simple ligature example tuning config for HEJI, you may have noticed that you can press J (enharmonic respell) on accidentals like #^ (sharp with one arrow up) which turns it into ^.# (natural with one arrow up & sharp). While the tuning is technically correct, it is improper use of the symbols according to the HEJI standard.

🟠 In the simple HEJI ligature example, you may also notice that some enharmonic spelling choices are suboptimal, e.g. sharps and flats with arrows are spelt weird.

This seems like a small matter as most people don't bother with enharmonics in JI anyway. However, this same issue also affects tempered tunings notated with HEJI, plus, exact enharmonic substitutions via the ~ (tilde accidental: schisma alteration) are defined in the HEJI spec, such that C#v~ = Db, and Db^~ = C#.

We can modify how ligatures behave to improve the user experience for more intricate notation systems like HEJI/Sagittal.

Ligatures can be used to:

  • Limit the plugin to use only certain accidental spellings so that "technically correct but wrong" spellings don't show up after up/down/enharmonic cycle operations.
  • Emulate support for symbols that can change their meaning depending on the context.

But first, to use ligatures effectively, we need to understand how the plugin reads & breaks down accidental symbols into actual note information.

Understanding how the plugin parses & reads accidentals

SMuFL & text-based accidental symbols attached to a note are tokenized into an unordered list of Symbol Codes. These symbols are 'eaten up' one-by-one, according to the order specified in the tuning config declarations. Once a symbol is matched, it cannot be reused as a symbol in another ligature/accidental chain/secondary accidental. There are 3 different sources of accidental symbols, and the reading/parsing/matching/eating of the symbols happens in this order:

  1. The plugin attempts to match ligatures, set-by-set, testing for matches in the order the ligature sets were declared in the tuning config. In each ligature set, the ligatured accidental with the most symbol matches will be chosen. E.g. if some ligature set contains bb.bb and bb, and bb.bb.bb is attached to the note, bb.bb will be 'eaten up' and matched by that ligature, leaving bb to be matched by the other declarations
  2. The plugin attempts to match main accidentals in accidental chains, testing for matches in the order the chains were declared. Just like the ligatures, the accidental with the most symbol matches will be chosen.
  3. Finally, the plugin matches remaining leftover symbols as secondary accidentals. It checks for secondary accidentals in the order they were declared, matching repeated secondary accidentals all at once.
  4. Any other left over symbols will be ignored. In some cases, if the tuning config is specified incorrectly and matches symbols in the wrong order, the plugin will not work.

This symbol-parsing process is how the plugin understands the accidental symbols attached on to notes, and it will base its operations on this information.

⚠️ IMPORTANT: Note that because the plugin always tries to read the most number of symbols for each ligature set/accidental chain at a time, it's important that if the same symbol appears across different ligature sets/accidental chains, they should be declared in an order such that it is not ambiguous which ligature/accidental chain the symbol belongs to.

🟡 For example, let's say that the symbol b^ is in ligature set 1, but we have ~.b^ in ligature set 2. Now let's say the plugin encounters a note with the symbols ~.b^. It will first look to ligature set 1 to 'eat up' the b^, leaving ~ remaining. This means that ~.b^ in ligature set 2 will never get matched because the b^ symbol will get eaten up by the first ligature.

To solve this, we just need to flip the order the ligature sets are declared.

Now that's out of the way:

What exactly are ligatures?

A note with a ligatured accidental is treated as a unique 'Xen Tonal Pitch Class' (XenNote in the code) that is enharmonically equivalent to the same note with the original accidental it 'substitutes'.

In other words, notes with ligatures will (by default) be accessible as enharmonics of the non-ligatured note. Ligatured spellings will (by default) show up as possible note spelling choices for up/down/enharmonic operations.

Once ligatured accidentals are declared, it affects how the plugin parses symbols. As mentioned above, accidental symbols are tested to match against ligatures first, before the primary accidentals that are part of the tuning config.

This means that we can use ligatures to affect how the plugin reads symbols, and we can intentionally reuse the same symbols between ligature sets & accidental chains to affect how the plugin reads symbols and create an intricate layered accidental system, if need be.

Weak & important attributes on a ligature set

A ligature set is defined with two attributes: weak/strong, and important/non-important.

By default, all ligature sets are strong and non-important. We can suffix ! and/or ? to our lig(...) declaration to change these attributes.

  • lig(...)? makes a weak ligature
  • lig(...)! makes an important ligature
  • lig(...)!? makes a weak and important ligature.

The point of having these attributes is to have fine-grained control for when to prefer using some ligatures over other ligatures, or whether other primary accidental symbols can be accessible from up/down/enharmonic operations at all.

Here's a table summarizing the effect of these attributes, in increasing order of precedence:
lig(...)? Weak Non-important Same priority as standard accidentals. These note spellings are treated exactly like standard enharmonic equivalent spellings declared in accidental chains
lig(...) Strong Non-important Prefered over standard accidentals during up/down operations only. Allows cycling between ligatured & non-ligatured spellings as long as all enharmonic equivalents of this note doesn't contain important ligature symbols
lig(...)!? Weak Important Prefered over standard accidentals & non-important ligatures. Prevents non-important/standard spellings from showing up in enharmonic cycling
lig(...)! Strong Important Highest priority of all. Prevents non-important/standard spellings from showing up in enharmonic cycling

Strong vs weak ligatures

During the up/down operations, whenever the plugin has to decide between choosing to spell note with a strong ligature vs without, it will always prefer the strong ligatured spelling over a weak-ligatured spelling or non-ligatured spelling (i.e. primary accidental symbols from the accidental chains).

Setting a ligature to weak means that the ligatured spelling will be considered on equal-footing with other non-ligature/weak-ligatured spellings. Thus, enharmonic spellings are picked based on the other usual factors (such as transposition direction, number of symbols, etc...).

Important vs non-important ligatures

If a tuning config has an enharmonically equivalent set of notes and some of them have an important ligature, the other non-important ligatures will be removed from the enharmonic cycling operation. The main point of using important ligatures is to exact fine-grained control over the available enharmonic spellings that a note has.

When given the option, the plugin will always choose to spell notes with important ligatures over non-important ligatures. This choice is made with a higher priority than the choice between strong vs weak ligatures.

The reason to use important ligatures is to override the use of all original accidental symbols in the accidental chains that the ligature applies to. This applies to all plugin operations (up/down/enharmonic).

🟢 Because important ligatures take precedence over all other enharmonic spellings, we need to make sure that — amongst the accidental chains the ligature applies to — all the symbols we need are represented in the ligature, including "non-ligatured" standard spellings.

In a nutshell, the difference between a strong ligature and an important ligature is that a strong ligature still allows the original accidental chains' symbols to show up when respelling enharmonics (J), but an important ligature will not.

🟠 While these non-ligatured symbols being overriden by an important ligature are not accessible from standard plugin operations (up/down/enharmonic), they will still be read correctly if these symbols are manually attached to the note.

Weak & important ligatures case study: HEJI

Building from the simple HEJI ligature example, there are a few changes to configure full support for HEJI:

  • We need to use important ligatures to prevent incorrect accidental spellings like #.v2 from showing up in enharmonic cycling. We need to override all degrees of accidental chains 1 and 2 so that when we have a mixture of #/b and ^/v symbols, it will always show up using the correct ligatured spellings.
    • This means we declare important ligatures for all symbols (including the standard #/b and ^/v symbols), otherwise those symbols will not show up after moving a note up/down/enharmonic cycling.
  • We need to implement the enharmonic schisma ~ using pseudo accidental degrees and irregular accidental tuning sizes, and create an important ligature for those symbols as well so that they can appear when cycling through enharmonics (J).
    • These ligatures also declared as weak so that the standard spellings are preferred over these enharmonic schisma ones.
    • C#v~ = Db and Db^~ = C#.

This is what that looks like:

C4: 440 * 16/27
0 9/8 81/64 4/3 3/2 27/16 243/128 2
~.b^(243/256) bb(-113.685*2c) b(-113.685c) (0) #(113.685c) x(113.685*2c) ~.#v(256/243)
v3 v2 v (81/80) ^ ^2 ^3

lig(1)?! // weak and important ligature set
-3 ~.#v // pseudo degree -3 =  ~#v
3 ~.b^ // pseudo degree 3 = ~b^

lig(1,2)!
-2 -2 bbv2
-2 -1 bbv
-2 0 bb // duplicate standard symbols when declaring important ligatures
-2 1 bb^
-2 2 bb^2
-1 -2 bv2
-1 -1 bv
-1 0 b
-1 1 b^
-1 2 b^2
0 -2 v2
0 -1 v
0 1 ^
0 2 ^2
1 -2 #v2
1 -1 #v
1 0 #
1 1 #^
1 2 #^2
2 -2 xv2
2 -1 xv
2 0 x
2 1 x^
2 2 x^2

🟥 The order of ligature declaration is very important. This wouldn't work if the lig(1)?! declaration is written after the lig(1,2)! declaration.

Recall how the order of declarations affect how the plugin reads notes. Here's what will happen if the ligature declaration order was flipped:

  • A note has the ~.b^ accidental
  • b^ gets eaten up by matching the lig(1,2) ligature, because it was declared first.
  • ~ remains unmatched, and the plugin will not be able to figure out what to do with it
  • Halt & catch fire

🟢 Refer to the heji/5 limit.txt tuning config to learn how HEJI is implemented.

Advanced: Text based accidentals

Some notation systems like HEWM (Helmholtz-Ellis-Wolf-Monzo) require accidentals that are text based (ASCII or UTF). You can use text based accidentals by quoting the text in single quotes like so:

A4: 440
0c 200c 300c 500c 700c 800c 1000c 1200c
'bb' 'b' (100c) '#' 'x'

This implements good old 12edo, but the accidentals will be text based instead of SMuFL symbols.

Text based accidentals are implemented as fingerings attached to a notehead, and you will be able to access these accidentals with the regular up/down/enharmonic operations.

However, if you want to be able to input these accidentals directly using fingering text, you will need to declare text representations.

For a thorough example, see the HEWM tuning config, which uses mainly text based accidentals.

🔴 IMPORTANT: Xen Tuner makes a distinction between 'x'.'x' and 'xx'. The former is two separate text elements whereas the latter is a single text element.

Advanced: Secondary accidentals

When working in high-complexity just intonation or very large tunings with numerous accidentals of varying sizes that can all be permuted and combined with each other, it's highly recomended to implement the higher-limit/sporadic accidentals as secondary accidentals, rather than declaring one accidental chain per prime-limit.

🟠 Declaring too many accidentals/ accidental chains will cause the plugin to take a long time to load the tuning config.

Secondary accidentals are accidentals that are 'left-over' after the plugin parses the main accidentals that contribute to the tuning chain.

You can tell the plugin what to do with them like so:

A4: 440
0c 200c 300c 500c 700c 800c 1000c 1200c
b (100c) #

sec() // this starts the secondary accidental declaration

// syntax: <symbol code/text code> [space] <cents or ratio expression>
# 50c // extra sharps are +50c
b -50c // extra flats are -50c

\\.\\ -30c // double down arrow is -30c
\\ -10c // single down arrow is -10c
/./ 30c // double up is +30c
/ 10c // single up is +10c

In this example, there is only one accidental chain declared consisting of -1 to 1 degrees of flats/sharps. If there are any extra flat or sharp symbols, they will match as secondary accidentals, contributing +/- 50c each.

Secondary accidentals can stack, and you don't need to declare a new secondary accidental for every unique number of times the symbol is repeated (unless the tuning is irregular and depends on the number of times the accidental appears). Only declare secondary accidentals for uniquely tuned symbols.

For example, there are 4 HEJI 7-limit accidentals, so we declare only 4 secondary accidentals:

sec()
u77 64/63 * 64/63
u7 64/63
d77 63/64 * 63/64
d7 64/63

Any repetitions of these symbols found on a note will stack.

The up/down arrows are declared in a specific order such that if there are double up/down arrows adjacent to each other, they will contribute +/- 30c instead of +/-(10 + 10)c.

Secondary accidental declaration order matters

🔴 The declaration order of secondary accidentals has to be carefully chosen so that certain combinations of symbols that overlap are matched with the correct precedence.

E.g. if \\ was declared before \\.\\, then the \\.\\ secondary accidental would never be matched, because the \\ symbol would always match first.

Secondary accidental declaration is almost never done on its own, and instead you would want to declare textual representations of the symbols at the same time.

Advanced: Declaring text representations of accidentals

Declaring textual representations allows you to input accidentals (both SMuFL and text-based) by attaching fingering text on the note. These declarations are done together with secondary accidental declarations and work the same way, except you provide a quoted text string that represents the accidental.

...
sec()
'up77' u77 64/63*64/63
'up7' u7 64/63

The above example declares two secondary accidentals, u77 and u7. To input them effeciently, you can attach a fingering and enter up77 or up7 respectively. After any plugin operation is applied to that note, the note will be regarded as if it has the symbols attached to it.

🔴 As usual, the declaration order matters. If the text representation 'up7' was declared before 'up77', then up77 would be matched as up7 first, leaving a 7 that would not be matched. The plugin will then ignore the fingering as it thinks that it is not a valid text-representation of accidental(s).

Declaration order must be carefully chosen so that there's no ambiguity between text representations (as they can be stacked repeatedly in a single fingering text), neither should there be ambiguity in how to match the secondary accidental symbols.

Elided text representations

If the secondary accidental itself is a single-element text accidental, then you won't need to repeat the text accidental twice:

sec()
'^' '^' 81/80 // this is unnecessary
'^' 81/80 // this does the same thing

// ⚠️ You can't do this. This is not a 
// single-element text accidental!
// `+`.`+` 50c

// do this instead:
'++' '+'.'+' 50c

Advanced: Other configurations

nobold()

Declare nobold() anywhere after declaring accidental chains to make the font style of fingering text based accidentals non-bold.

Otherwise, fingering text accidentals will be bold by default.

explicit()

Declare explicit() anywhere after declaring accidental chains to explicitly display all accidentals (even naturals).

Useful for atonal writing etc...

Congratulations on making it this far! You're encouraged to contribute your tuning systems to the project.

You can file a pull request adding files to the tunings/ folder, or simply file an issue with your tuning config, and I'll add it for you.

🟠 If your tuning configuration contains many notes/equave and takes a long time to load, you should pre-compute the tuning config into a .json file, which will help speed things up.

How to: key signatures

Regardless of whether you're using standard or custom key signatures, you will need to declare key signatures using System/Staff text for this plugin to work with key signatures properly.

Just like the tuning config, System Text will apply the key signature for all staves from that bar onwards, whereas Staff Text will only apply to the staff it is written on.

The key signature text should start with keysig, followed by a space, followed by space-separated symbols codes that should apply to each nominal starting from the reference note.

E.g. if the tuning config specifies A4 as the reference note, and you have 7 nominals in your tuning, then:

keysig 0 0 # 0 0 # 0

...specifies that the nominals C and F should have the # symbol applied to them by default. 0 is used to mean natural/no symbol.

As per normal, if you require multiple symbols on a nominal, you can join them with periods, e.g.:

keysig #.+ 0 bbb.bbb.bb 0 17.bv2 0 x.#x.#x

...also specifies a (rather extreme) key signature for 7 nominals.

How to use fingering annotations

🟢 If you're using fingering-related features, it is recommended to change the default MuseScore shortcut of Ctrl+F from "Find / Go to" to "Add fingering". This will make note entry much more efficient.

Fingerings are a handy way of attaching text directly to a single note. You can press space/tab to navigate between adjacent fingerings which allows you to edit them efficiently.

1. Entering accidentals via Accidental Vector

If you're dealing with a really large tuning system and can't reasonably access the accidental you need with just up/down & auxiliary operations, you can use fingerings to help you enter accidentals.

Create a fingering, type 'a', followed by comma-separated degrees of the accidental vector.

For example, the fingering a-1,1,2 corresponds to the accidental symbols required to notate going down 1 step of the first accidental chain, up 1 step of the second chain, and up 2 steps of the third chain. The actual symbols that this corresponds to will depend on the Tuning Configuration being applied on that note.

Then, simply tune the note/score (or do some other operation) and the accidental symbols required to denote the accidental vector -1,1,2 will magically appear.

This is especially helpful for huge tunings with many accidental chains.

2. Fingerings to denote JI intervals

You can tune any note to a just intonation interval relative to the reference note by attaching a fingering of the ratio/math expression followed by a period.

The note's tuning will be automatically octave-reduced/expanded to match the octave that it is written in (in accordance to the Tuning Config), so you can use JI fingering annotations to supplement your existing tuning.

🟡 E.g. the fingering 19. will cause a note to be tuned to the 19th harmonic of the current reference note. You can also use JavaScript expressions like Math.sqrt(19)..

🟠 If you regularly use this feature and do not require normal fingerings on your scores, you can set var REQUIRE_PERIOD_AFTER_FINGERING_RATIO = false; at around line 100 of fns.js. This will make all fingering text function as a JI ratio/harmonic by default, without the need for a period at the end — making your scores slightly neater.

Of course, this will also make normal fingering numbers act as otonal harmonics, so you should be careful.

⚠️ This is not a replacement for accidentals. Fingering annotations do not carry over noteheads unlike accidentals. See secondary accidentals if you want a way to sporadically apply certain higher-limit accidentals that behave like accidentals.

3. Fingerings to denote cent offsets

You can apply an additional cent offset to a note (on top of its standard tuning) by prefixing the fingering with a + or - sign.

E.g., +5 on a note will make the note tune 5 cents higher than normal.

⚠️ This is not a replacement for accidentals. Fingering annotations do not carry over noteheads unlike accidentals. See secondary accidentals if you want a way to sporadically apply certain higher-order accidentals that need not be part of the declared accidental chains.

How to: change shortcuts

You can change the keystrokes that this plugin listens to by editing xen tuner.qml directly. The syntax is pretty straightforward.

This is what the 'Tune' keybinding declaration looks like:

Shortcut {
  sequence: "Alt+R"
  context: Qt.ApplicationShortcut
  onActivated: {
      infoText.text = "Tuning score/selection...";
      Fns.operationTune();
      showWindow();
  }
}

If you want to change the keybinding to Home instead of Alt+R you can just modify the sequence: line:

Shortcut {
  sequence: "Home"
  context: ...

The strings of text that specifies a shortcut should be straightforward, but if you want to do anything fancy, you can refer to the QT docs

More auxiliary operations

In the same xen tuner.qml file, you can specify/enable more auxiliary operations.

The default file contains this empty template:

Shortcut {
  sequence: "End"
  enabled: false // set to true to enable
  context: Qt.ApplicationShortcut
  onActivated: {
      infoText.text = "Moving note(s) up aux 5";
      Fns.operationTranspose(1, 5);
      showWindow();
  }
}

You can set enabled: true (or delete that line), then change sequence to a keybinding of your choice.

To control which Nth auxiliary operation this keybinding is for, simply set the second number of Fns.operationTranspose(1, 5) to the desired auxiliary operation number. E.g. the 10th auxiliary operation would be Fns.operationTranspose(1, 10).

Writing in huge tunings

When dealing with a large tuning (> 1500 notes/equave), the Tuning Configuration data gets really large. MuseScore's plugins API really isn't designed to handle such demanding tasks — so, when you run a Xen Tuner action for the first time after opening MuseScore, it is normal for the plugin to take a few seconds, or even minutes, to load a large tuning, if the score requests for it.

Of course, the plugin caches the tuning data, so this loading is a once-off event.

However, it still can be annoying to always have to wait every time you reopen MuseScore, or want to experiment with a new large tuning system. Thankfully, there is a way to reduce the waiting time by 60-70%.

Here are some ways to tackle the slow initialization/loading of tuning configs.

1. Pre-compute the tuning config

Instead of writing the tuning config into the score or into a .txt file, you can go to this link: https://euwbah.github.io/musescore-xen-tuner/ to convert your tuning configuration into a .json file. In a nutshell, you're pre-computing the tuning configuration, so that you don't need to do it within MuseScore.

Once you have the .json file (which you can rename to whatever.json, as long as it still has the .json extension), you can save it into the tunings/ folder together with all the other .txt files.

You can reference this tuning configuration just like how you reference any other .txt tuning config files. When your score references a Tuning Configuration file, it will look for the .json file first, and reverts to the .txt file if the .json is not found.

This will make the initial loading of the tuning configuration much faster, but it still won't be instantaneous. A 1.6MB tuning config .json (≈5500 notes/equave) takes about 7 seconds to load.

This method is recommended if you're using a moderately large tuning system that is not ridiculously huge.

2. Use secondary accidentals

If there are some accidentals in a chain that you only use sporadically, you may want to consider using secondary accidentals instead of declaring them main accidentals.

The downside is that you aren't able to access these via the up/down/enharmonic operations. (But if you already have > 4 accidental chains, this wouldn't affect you much.)

3. Use fingering text ratios/cent offsets

If you're tuning config exceeds 30MB, it's probably time to consider cutting down on accidentals/accidental chains that aren't used that often, and use the occasional fingering text to denote certain offsets.

You can still have access to all the SMuFL symbols, and you can 'trick' the plugin to accept these symbols as accidentals so that you still get the benefit of auto-positioning by using pseudo-ligatures. (Work in progress)

4. Clear the tuning cache

If you've been experimenting with several large-sized tuning systems within the same score/over the current MuseScore session, this will populate a runtime & score metadata cache which may use up too much memory over time.

  • Quit/close the Xen Tuner plugin panel/window
  • Run Plugins > Xen Tuner > Clear Tuning Cache
  • Restart Xen Tuner

5. Notate comma shifts using reference pitch changes

One of the culprits of a huge Tuning Config is if you're writing a piece that utilizes tons of comma pumps that add up, requiring many accidentals per note throughout a particular comma-shifted section of the piece.

You can notate comma shifts by changing the reference tuning note & frequency. For example, if you want to shift down by 81/80 you can do this: A4: 440 * 80/81.

How to: export MIDI/MPE

⚠️ This feature is still a work in progress. The generated microtonal .mid file does contain proper MPE MIDI messages and plays back correctly when imported directly into Pianoteq standalone. However, I haven't found a nice simple way to import this MPE MIDI data directly into a DAW. It seems like DAWs don't implement MPE import/export.

MPE is a specification building on top of the MIDI 1.0 standard which allows for polyphonic pitch bend, which this plugin relies on to export microtonal pitch offsets of up to 15 notes per staff.

Unfortunately, as far as I know, there isn't a way to import MPE midi files into DAWs directly. There are two options:

  1. Import 1 channel at a time (from channel 1 to 15) into separate tracks/channels in your DAW, assigning the channel's pitch bend to 15 different copies of the synth.

  2. Use the included python script to play back the generated MPE midi file in real-time through a virtual MIDI port on your computer. Record this play-back using any DAW that supports MPE MIDI controllers.

The "Export MIDI CSV" plugin generates a .mid.csv file at the same location as the score.

This file can be fed into the generate-mpe.py Python script.

To run this, first, you will need to install Python 3 (preferably 3.6 or higher).

After installing, Python, you will need to install three Python libraries: mido, MIDIUtil, and python-rtmidi.

⚠️ If you installed Python 3 (the normal way) on Windows, you will need to use the py command instead of python3.

python3 -m pip install MIDIUtil
python3 -m pip install mido
python3 -m pip install python-rtmidi

To run the midi generator script:

cd path/to/musescore-xen-tuner
python3 generate-mpe.py path/to/score.mid.csv

This will generate a .mid file at path/to/score.mid.

Updating the plugin

This plugin is very experimental, so make sure you're always using the most updated version of this plugin as bugs are always being fixed. This plugin does not update automatically. Redownload the code from here, and replace the files.

⚠️ IMPORTANT: When updating the plugin, make sure you reopen MuseScore for changes to take effect. To be very certain that the newer files are being used, you can click the Reload Plugins button in the Plugin Manager to force reload all plugins.

Troubleshooting

The tuning is wrong/off

Checklist:

  • In the tuning config, suffix cent values with c, by default, numbers represent JI ratios.
  • Per-note cent offsets in fingerings must be prefixed with with + or '-'.
  • Per-note JI ratios must be suffixed with ., unless otherwise configured
  • Clear tuning cache
    • ⚠️ If you modify a tuning from a .txt or .json file, you will need to clear the tuning cache for the changes to take effect.
  • Specify key signature

If all else fails, report an issue. Include the tuning config text you were trying to use and provide a score example.

I made my own tuning config, but it doesn't seem to be doing anything. (Treated as 12edo)

This usually means that there's an error in the tuning config itself. On your laptop/PC, go to the Xen Tuner Tuning Config compiler website, paste your tuning config there, and click 'Debug config (js console)', which will print messages/syntax errors to the browser's JavaScript console about any issues with your declaration of the tuning config.

If you need help understanding the error messages, feel free to open an issue to ask for help using the "help wanted" tag.

The plugin just breaks when I use certain accidental symbols/text-entry combinations

This is most likely a tuning config issue — and usually has something to do with things being declared in the wrong order:

  1. Within a single ligature set, the ligatures are not declared in the right order
  2. If there are multiple ligature sets, the sets aren't declared in the right order
  3. Secondary accidentals/text representations are not declared in the right order

🟡 For example, in heji/5 limit.txt, if you shift the second ligature set declaration before the first, you will encounter this issue.

To make your tuning config debugging process easier, follow the instructions in "Reporting an issue" to find debug/error messages when running the plugin from the Plugin Creator.

If the issue is tuning config related, the debug messages will contain the exact details of how the plugin tried to parse a note and failed, and you can use that info to fix the tuning config yourself, or ask for help.

I changed the tuning config text, but the plugin isn't picking up the changes

If the plugin is lagging/tuning isn't correct

  • Reset the tuning cache. It is recommended to do this often when you are playing around with many tunings in one score but are no longer using most of the tunings you experimented with.

If you're dealing with many notes per equave (>1000), see how to deal with huge tunings

Workarounds + advanced configs

There are certain advanced configuration options at the top of the fns.js file, which you can modify to change certain behaviours of the plugin.

When I select a single notehead, it doesn't play the right pitch. However, playing back the score works fine.

This is normal. The plugin modifies PlayEvents to affect the MIDI pitch of the note, which are not reflected when you select a notehead. Modifying PlayEvents to compensate for large tuning offsets reduces distortion of the note's timbre during playback. However, if you want to hear the correct pitch all the time and disregard adjusting for timbre, you can modify this line in fns.js (around line 150):

var PLAY_EVENT_MOD_SEMITONES_THRESHOLD = 1000;

Set the number to like 1000 or something, and that will ensure that the playback upon selecting a notehead is mostly correct. However, when you have two notes on the same staff line, e.g. augmented unisons, the plugin will still modify the PlayEvent to ensure that the notes play back correctly.

The timbre is weird when I play back the score

This is the inverse problem of the above workaround. Simply set:

var PLAY_EVENT_MOD_SEMITONES_THRESHOLD = 0;

This way, PlayEvents will be aggressively modified to ensure that the Note.tuning offset is kept to a minimum.

Augmented/diminished unisons in the same voice/stafff/instrument/part don't play back

This is a known problem and has to do with how MuseScore handles playback as MIDI notes. You can see how two notes on the same staff line are represented as the same note in the piano roll, thus making them indistinguishable to the playback engine.

To work around this, simply attach standard-support accidentals (those that affect playback, not the symbolic ones) to either one of the clashing notes and make them invisible.

Doing this will change how the note's MIDI pitch is represented internally so that they won't clash. The plugin will know how to compensate for the added accidentals, and you can use up to triple sharps/flats.

Enharmonic equivalents aren't showing up / are incorrect

Around line 127 of fns.js, there is this setting:

var ENHARMONIC_EQUIVALENT_THRESHOLD = 0.005;

This sets the threshold interval (in cents) where two notes should be considered enharmonically equivalent.

If enharmonic equivalents in your ET/temperament are not showing up, try increasing this number slightly (e.g. 0.01). Floating point errors (inaccuracies in computer number-crunching) may cause enharmonically equivalent notes to have slightly different cent values. Also, make sure you specify your cent offsets to as many decimal places as possible to reduce this error.

If you're working in a very large JI subset and there is no need for enharmonic equivalents, it's recommended to set this number smaller (even to 0.000001), to prevent two very similar notes being regarded as enharmonically equivalent, since there are no equivalents in JI.

Keyboard shortcuts stop working

You could have started more than one instance of Xen Tuner. Close Xen Tuner and restart, or restart MuseScore.

If you ran Xen Tuner from the Plugin Creator, you will need to restart MuseScore to restart Xen Tuner normally again.

Reporting an issue

If none of the above remedies work, you will need to file an bug report issue here.

Do follow the template provided and include the following information:

  • Version of MuseScore
  • Version of plugin
  • Operating system
  • Example score
  • Tuning config you were using
  • Debug logs

Accessing plugin debug logs in MuseScore 3

  • Stop running Xen Tuner (close plugin window/quit button).
  • Open the Plugin Creator (Plugins > Plugin Creator).
  • Open the xen tuner.qml file
  • Run xen tuner.qml from the Plugin Creator.
  • Repeat the action you did that caused the issue.
  • Usually if an error occurs, you should be able to see the error message at the bottom of the log.
  • Copy and paste as much of the debug log as you can, including the error message at the bottom.
  • 🔴 If you wish to close the plugin, use the "Quit" button. Do not use the plugin window's 'X' button or the Plugin Creator's 'Stop' button, otherwise the shortcuts will stop working when you reopen the plugin.

Accessing plugin debug logs for MuseScore 4

Logs created directly by the plugin aren't accessible anywhere in MuseScore 4 yet.

The best option would be to attach the .log files located at:

  • Windows: C:\Users\<name>\AppData\Local\MuseScore\MuseScore4\logs\
  • MacOS: ~/Library/Application Support/MuseScore/MuseScore4/logs/
  • Linux: ~/.local/share/data/MuseScore/MuseScore4/logs/

if you're not on Windows, you can try running MuseScore from the command line/terminal to see if there's any output.

HELP NEEDED!

1. Testing on MS 4

I've followed the current temporary guidelines for plugins in MS 4.x, but I can't get MS 4 to open on my computer. I would appreciate if someone can help me test & debug the plugin on MS 4.

🔴 WARNING: Even if the plugin currently works on MS 4, the plugin API is said to be unstable and this plugin may break in a future update.

2. Data entry of accidentals

I need help with tabulating the list of all accidentals available in MuseScore, such that Symbol IDs (SymId) & Accidental IDs (AccidentalType) that point to the same/similar-looking symbol are grouped together.

  1. Use this tool for looking up symbols and their IDs, kindly provided by msfp on the MuseScore forums. Download the .zip from the link and open the .html file to access the lookup/symbol search tool.
  2. Gather all SymIDs and AccidentalTypes that point to the same/similar-looking accidental symbol and tabulate them in the spreadsheet.

Caveats

  • Does not intend to use the standard Accidentals at all. Accidental symbols used/created by the plugin are cosmetic symbols from the "Symbols" category of the Master Palette. This means:
    • You cannot drag accidentals from the "Accidentals" palette. All accidentals used must be from the "Symbols" category in the Master Palette.
    • Existing scores not made by this plugin will not work with this plugin.
    • Accidentals on grace notes can't be made smaller.
    • Formatting may look weird as this plugin has to reconstruct how accidentals are to be positioned.
  • Only concert pitch display mode is supported. If you wish to write for transposing instruments in its transposed key, put the score in Concert Pitch mode and use a Staff Text to enter a Tuning Config such that the tuning frequency matches the transposition of the instrument.
  • Does not fully support cross-staff notation. Accidentals don't carry over between two different staves if cross-staff notation is used. However, you can specify all accidentals explicitly.
  • You cannot adjust the Z index ("Stacking order") of accidental symbols, and certain Z indices are reserved for special fingerings (3903-3905, 1000-2000).

Smaller caveats

  • 5-10s freeze after starting this plugin for the first time after opening MuseSoce. The plugin is loading.
  • Does not differentiate between the order of appearance of accidentals within one note.
  • Does not intend to support having the same symbols in two different accidental chains (I am unaware of any notation system that requires this)
  • Does not support grace notes occurring after a note. Grace notes occuring before a note are supported.
  • Octave 8va/15ma/etc... lines are not supported when non-standard number of nominals are used (e.g. bohlen pierce). You can simulate an octave line by setting the reference frequency higher/lower when needed.
  • If an undeclared accidental combination is used, the note will be regarded as without accidental, even if some (but not all) symbols are declared in accidental chains.
  • Ornaments can only be tuned within +/- 100 cents resolution.
  • When exporting MIDI, crescendos/diminuendos do not affect velocity. There doesn't seem to be a simple way to get the velocity of a note from the plugin API.
  • Could be very laggy...

Clarifications

  • The use of the term accidental chain in this readme is not related to "Nominal-Accidental Chains". The former represents a sequence of accidentals where two adjacent accidentals differ by a more-or-less consistent interval size. The latter is a more general descriptor of the phenomenon where most western-centric notation systems involve one nominal and some accidentals which can generate a sequence of notes.

  • The "Xen Tuner" name is unrelated to Keenan Pepper's MuseScore Xentuner plugin. This naming coincidence I only realized after naming the project.

Contributors

Changelog

Dev Notes

See dev notes for technical implementation details & how to contribute.

Support me

YouTube

GitHub Sponsors

About

full xenharmonic & microtonal support for musescore! just intonation, regular temperaments, chromatic staves, bohlen pierce, anything at all

Topics

musescore just-intonation smufl edo microtonal ji musescore-plugin xenharmonic heji neji sagittal

Resources

Readme

License

GPL-3.0 license
Activity

Stars

35 stars

Watchers

3 watching

Forks

2 forks
Report repository

Releases

4 tags

Packages

No packages published

Contributors 2

Languages