Manual: Setup/Keyboard
This page contains information on a not yet released version of OpenMPT. Some of this information might not be applicable to the current version of OpenMPT. You may view an (possibly outdated) older version of this article without information on the upcoming changes.
In this page you can choose or edit keyboard and MIDI shortcuts for many of the actions in OpenMPT. OpenMPT has several built-in keyboard layouts you can choose from, but you can also load and save custom layouts, for example from the ExtraKeymaps folder in OpenMPT’s application folder by clicking on the “Import Key Map...” button near the bottom of the page. The current shortcut configurations are kept in the Keybindings.mkb file in the %APPDATA%\OpenMPT folder (or OpenMPT’s application folder if in portable mode), but here you can save these shortcuts in a separate file for safekeeping or sharing as well.
The following is a description of the various items on the page.
To view or edit keyboard shortcuts, first find the context to which the keypress would be applied by clicking on the Category field at the top. A dropdown list will open and you can choose the context to view. If you wanted, for example, to assign the Q key to the base octave C when inputting a note in a pattern, this keypress would be needed in the Pattern Editor for the note column. So you would select “Pattern Editor – Note Column” from the popup menu. The list of assignable note messages will be displayed in the field below it. Select the “Base octave C” entry and select it. Alternatively, if you know (parts of) the shortcut name, you can type it into the “Find by Name” box.
Limited support for MIDI message handling is also there: Additionally to computer keyboard keys, MIDI CCs and MIDI note events may be used to trigger shortcuts. To make use of them, first enable MIDI Input. Then, go to this settings dialog, focus the Key input field and send the wanted MIDI CC or note using your MIDI device.
It is possible to assign the same key combination to several shortcuts by means of the hidden setting Misc.AllowMultipleCommandsPerKey, but a warning about this potentially unwanted situation is emitted if you are trying to re-use an existing key combination that may be conflicting.
Shortcut List[edit]
Select Category[edit]
Shows the current set of functions you can assign shortcuts to. Clicking this field opens a dropdown list so you can choose which set of shortcuts you wish to edit or assign.
Action List[edit]
Clicking on one of the entries selects it for key assignment. See the Keyboard Actions table for a description of all available actions.
In the right-hand column, you see the currently assigned shortcut(s) for each entry. Double-clicking this column allows you to directly change the primary choice for this entry.
Find[edit]
This can be used to search for a specific shortcut in the complete shortcut list by its name. Instead of searching by name, you can also search by shortcut. Just click on the Find by Hotkey... button and enter the key combination that you want to find into the edit field that pops up (e.g. pressing Ctrl+C would bring up the “Copy” shortcut when using the default configuration). Focus the edit box again to remove the search term.
Pressing the Clear button cancels any active search filters.
Key Setup[edit]
Key setup choice[edit]
This field lets you switch between the choices of key assignments for this action. If there is no key assigned, it will display <new>; otherwise, the text will read "Choice x (of y)" where x is the number of the current shortcut and y is the total count of this action’s current key assignments. Clicking in this field will display other choices, where you can select the one to edit.
Keys[edit]
Shows the key assignment for this shortcut. Double-clicking in this field (after choosing an action in the Action List) will “listen” for a new key assignment. Any keypresses or recognized MIDI events will be entered into this field and assigned to the action as a keyboard shortcut. In order to stop “listening” for new key assignments, press the Cancel button right next to it or click on another control.
Set / Cancel[edit]
You can also press the Set button to start “listening” for a new shortcut assignment. It then changes into a Cancel button, in case you want to abort the action and not assign a new key.
Restore[edit]
Clicking on this button resets the key assignments of this action to when the action was first selected.
On Key Down/Hold/Up[edit]
When any of these are checked, the action will be activated at the corresponding event of the keypress, either when the key is pressed down, when it is held down, and / or when the key is released.
Delete Choice[edit]
Clicking on this button deletes the current key assignment. If there were other keyboard shortcuts for this action, they remain.
Conflict / Warning Display[edit]
Shows conflicts between the currently chosen action and any other actions. Conflicts occur when one keypress or combination keypress is already assigned to an action within the same context or a parent context. A problem may also occur when modifier keys (Shift, Ctrl, Alt or the Windows key) are expected but another key is assigned. In this case, OpenMPT will not allow the non-modifier key to be assigned and a warning is displayed here.
Miscellaneous[edit]
Repeat Note Keys on Hold[edit]
This checkbox indicates whether all assigned note keys have the “On Key Hold” property set and allows to toggle it quickly for all of them.
If all assigned note keys have the “On Key Hold” property set, the checkbox is checked; if only some of them have the property set, the checkbox is shown in an indeterminate state. Clicking on the checkbox enables or disables the “On Key Hold” property for all note keys.
Chord Detect Interval[edit]
If you have the Pattern Editor’s Edit Step setting set to some other value than 0 and have a record group set up, OpenMPT will put all notes detected within the Chord Detect Interval on the same row, regardless of the Edit Step setting, i.e. the notes are interpreted as a chord.
Import Key Map...[edit]
Use this button to import an .mkb (OpenMPT keyboard layout) file. This allows you to use an alternate set of pre-defined keyboard assignments. In the side bar of the file dialog, a shortcut to the ExtraKeymaps can be found to quickly jump to the alternative keyboard layouts shipped with OpenMPT.
Export Key Map...[edit]
Use this button to export the current set of keyboard shortcuts to a keyboard layout file. This is helpful not only for multiple users of one OpenMPT setup, but also for testing different setups for ease of use.
Restore Default Configuration[edit]
Clicking on this button restores all keybindings to their default keys. From the dropdown menu, you can choose one of several key map “flavours” that change some of the default keys to be more similar to those of Impulse Tracker or Fast Tracker.