OpenMPT Wiki - User contributions [en]

Talk:Manual: Setup/General

2012-04-17T23:36:07Z

Jmkz: Help: Describe options in detail

Audio setup requires a dedicated article like the Audio 101.

== Consider creation of "Manual:_Setup" and such for an overview of main title. ==

While I was transferring the OHM, I have guessed that structure will better if has a main tree like "Manual:_Setup" to preserve OHM formatting.

:Done. --[[User:Saga Musix|Saga Musix]] 15:57, 23 September 2011 (UTC)

== Describe options in detail ==
I'm unsure with how to "describe in detail" misc options. Please give me a note here. -[[User:Jmkz|jmkz]] 23:36, 17 April 2012 (UTC)

Manual: Setup/General

2012-04-17T23:31:26Z

Jmkz: /* Miscellaneous options */

[[Image:Settings General.png|thumb|300px|General tab of the settings dialog]]

The first tab of the Options page holds miscellaneous settings — namely the paths to various relevant folders, and flags that make using MPT easier depending on what you are accustomed to.

== Default Directories ==

ModPlug Tracker, when opening Open File or Save File dialogs, will default to the folders you enter into each of these fields (except for saving previously created files, which will default to their own directory). The folders are for tracks / modules / songs, samples, instruments, VST plugins and another for VST presets. You can type the path manually, or you can click on the Browse button next to it to find the correct folder using Windows' standard browse technique. These folders can be anywhere, but if you set the path to a Briefcase, and it is open or in use by another program, MPT will not be able to save to that Briefcase.

== Miscellaneous options ==

To enable any of these options, make sure the box is checked next to the text. To get info on what each toggle does, select the text itself, and Help tips will appear on the right side of the page.
Most of the settings you can leave at their default setting if you are new to tracking, but you can get details on their dedicated sections.

{{todo|Describe these settings in detail.}}

*'''Play new notes while recording''': When this option is enabled, notes entered in the pattern editor will always be played (if not checked notes will not be played in record mode).
*'''Play whole row while recording''': When this option is enabled, all notes on the current row are played when entering notes in the pattern editor. This option can be used to ''preview'' how the entire row will sound.
*'''Always center active row''': Turn on this option to have the active row always centered in the pattern editor (requires "Always center active row)
*'''Use large fonts for comments''': When this option enabled. the song message editor (Comments tab) will use a larger font.
*'''Display rows in hex''': With this option enabled, row numbers and sequence numbers will be displayed in hexadecimal.

[[Category:Manual|Setup/General]]

Talk:Manual: Known Issues

2011-11-11T14:23:49Z

Jmkz:

Xpressor issue should be recovered. I can confirm that I have that issue. -[[User:Jmkz|jmkz]] 22:55, 17 October 2011 (UTC)
: Are you sure that this is a problem of OpenMPT and not the plugin, i.e. does the same thing happen in Renoise when doing exactly the same, and also do you have a simple testcase to reproduce the issue? I cannot reproduce it in either Renoise or OpenMPT. --[[User:Saga Musix|Saga Musix]] 07:01, 18 October 2011 (UTC)
::Ok, I'll provide a testcase in some days. There is also an issue with Drumatic, but I don't remember what. Maybe is like the bug with V2 and P8 or something. -[[User:Jmkz|jmkz]] 08:22, 18 October 2011 (UTC)
:::I have now a proper testcase but but its always reproduceable under WineHQ (1.2.2) This bug also can be present in Windows. Luckly with Wine is always present, please test, you'll require few free plugins: Organizer [http://code.google.com/p/macaw/downloads/detail?name=macawvst2_301.zip], obviously XPressor, and Freeverb. Test module: [https://dl.dropbox.com/u/35217013/xpressor-sample-3%20%28copia%29.mptm] -[[User:Jmkz|jmkz]] 14:23, 11 November 2011 (UTC)

Manual: Keyboard Actions

2011-10-25T08:43:39Z

Jmkz: Added note column shorcuts

{{todo|Working on the rest<br />
Update to v1.19.04}}

== Global Keys ==

These keyboard shortcuts will work on all parts of ModPlug Tracker, as long as it's the frontmost application. '''Note''': Keyboard shortcuts are ignored when the input focus is within a text field. Only Windows' shortcuts can be applied.

{| class="wikitable"
|-
! Shortcut !! Description
|-
| File/New || Creates a new blank track. If one is already open, it is neither closed nor saved.
|-
| File/Open || Shows the dialog to open an existing readable tracking format. If one is already open, it is neither closed nor saved.
|-
| File/Close || Closes the current song. If it has not been saved, you are given the opportunity before the file is closed.
|-
| File/Save || Saves the file in its current name and format.
|-
| File/Save As || Allows you to save the file with a new name or in another folder.
|-
| File/Save as Wave || Exports the current track into a .wav file in the folder you choose.
|-
| File/Save as MP3 || Exports the current track into an .mp3 file in the folder you choose.
|-
| File/Export to MIDI || Exports the current track into the .mid format. See the section on MIDI files for a detailed explanation of how this file is exported.
|-
| File/Compatibility Export || Exports the current track without any of [[Manual: Saving and exporting#Compatibility Export|MPT′s hacks]] to its original format.
|-
| Previous Document || Goes to the previous tracking file that is open (these are visible in the Windows Menu).
|-
| Next Document || Goes to the next tracking file that is open (these are visible in the Windows Menu).
|-
| File/Import MIDI Library || Imports the MIDI Instrument Library of your choosing. The MIDI Library can be accessed from the [[Manual: Tree View#MIDI Library|Tree View]].
|-
| File/Add Sound Bank || Imports a sound bank of your choosing. Sound banks can be accessed from the [[Manual: Tree View#Sound Banks|Tree View]].
|-
| Play Song / Pause Song || Toggles the playback of the current track. The playback pointer is not reset when using this toggle; that is, it plays from where the pointer left off when it was last pressed.
|-
| Pause Song || Only stops the playback of the current track but does not reset the playback pointer.
|-
| Stop Song || Stops the playback of the current track and resets the playback cursor to the start of the song.
|-
| Play Song from Start || Resets the playback cursor to the very first row and begins playback from there.
|-
| Play Song from Cursor || Resets the playback cursor to the row where the editing cursor is set, and begins playback from there. Playback will continue until the end of the track.
|-
| Play Pattern from Start || Resets the pointer to the first row of the current pattern (even if you are in a different section of MPT), and begins playback from there. It will stop at the end of the pattern (or loop within the pattern if Loop Pattern is enabled).
|-
| Play Pattern from Cursor || Resets the pointer to the row where the editing cursor is set in the current pattern (even if you are in a different section of MPT), and begins playback from there. It will stop at the end of the pattern (or loop within the pattern if Loop Pattern is enabled).
|-
| Estimate Song Length || Estimates the playback length of the entire track.
|-
| Show approx. real BPM || Estimates the beats per minute of the song, based on the Initial tempo and the number of ticks per row, plus the Tempo Mode in the Song Properties dialog.
|-
| Toggle MIDI Record || Toggles the MIDI Record option.
|-
| Undo || Rescinds the last edit in the pattern or sample editor.
|-
| Cut || Copies the selected pattern, sample or instrument data into the clipboard, then removes it from the selection it occupies.
|-
| Copy || Copies the selected pattern, sample or instrument data into the clipboard.
|-
| Paste || Pastes the selected data at the location of the cursor, but Paste acts differently on the type of data.With pattern data, clipboard contents are pasted in the same row at the same column of the current (visible) Pattern where the cursor is located, overwriting any pattern data that falls within the paste area. With sample data, clipboard contents replcae the '''whole''' sample.
|-
| Mix Paste || Clipboard contents are pasted in the same row at the same column of the current (visible) pattern where the cursor is located, except where there is already any data in any corresponding field of the paste area.
|-
| Mix Paste (IT Style) || For detailed differences between Mix Paste and Mix Paste (IT Style), consult the appropriate [[Manual: Menus#Paste|Menu help]].
|-
| Paste Flood || Clipboard contents are pasted from the cursor, repeating the data paste until every row in the pattern has been filled and pasting over any data in its path.
|-
| Push-Forward Paste || Clipboard contents are inserted at the row of the cursor, and pushing all data below that row further down the pattern. Any data of the affected channels pushed beyond the pattern's row limit is deleted.
|-
| Toggle Overflow Paste || When enabled, pasting will continue to the next pattern if the data overflows the current pattern.
|-
| Select All || Selects all pattern or sample data.
|-
| Find / Replace || Opens the Find/Replace dialog, which allows you to search for and/or replace given pattern data. Find starts from the cursor location.
|-
| Find Next || Applies the current Find settings and searches for the next data that matches it, selecting the given data; however, it does not set the cursor in that row. For Find to be used again, the cursor must be set in the current pattern, then Find Next searches the entire row (in each channel) before going to the next row.
|-
| View General || Opens the [[Manual: General|General Tab]].
|-
| View Pattern || Opens the [[Manual: Patterns|Pattern Tab]].
|-
| View Samples || Opens the [[Manual: Samples|Sample Tab]].
|-
| View Instruments || Opens the [[Manual: Instruments|Instrument Tab]].
|-
| View Comments || Opens the [[Manual: Comments|Comments Tab]].
|-
| Toggle Main View || Shows / hides Main toolbar.
|-
| Toggle Tree View || Shows / hides [[Manual: Tree View|Tree View]].
|-
| View Options || Opens the [[Manual: Setup|Setup dialog]].
|-
| View Channel Manager || Opens the [[Manual: Channel Manager|Channel Manager]].
|-
| View Plugin Manager || Opens the [[Manual: Plugin Manager|Plugin Manager dialog]].
|-
| Show Song Properties || Opens the [[Manual: Song Properties|Song Properties dialog]].
|-
| View MIDI Mapping || Opens the [[Manual: MIDI Mapping|MIDI Mapping dialog]].
|-
| Help (to do) || Opens the manual (currently not functional)
|-
| Previous instrument || Changes the current instrument to the previous one in order.
|-
| Next instrument || Changes the current instrument to the next one in order.
|-
| Previous octave || Changes the current octave to the next lower octave.
|-
| Next octave || Changes the current octave to the next higher octave.
|-
| Previous order || Changes the current pattern to the previous one in the pattern order. If the pattern ID is the same the display will not change.
|-
| Next order || Changes the current pattern to the next one in the pattern order. If the pattern ID is the same the display will not change.
|-
|}

== Pattern ==

=== Order List ===

These keyboard shortcuts operate while the cursor focus is in the Order List (a pattern ID will be highlighted).

{| class="wikitable"
|-
! Shortcut !! Description
|-
| Delete Order || Erases the pattern from that location in the Order List (the pattern ID is still available, however).
|-
| Insert Order || Creates a new blank spot in the Order List.
|-
| Edit Pattern || Resets the Pattern Editor to show the highlighted pattern.
|-
| Switch to Pattern Editor || Moves the cursor focus to the Pattern Editor.
|-
| Previous Order || Selects the previous pattern in the Order List.
|-
| Next Order || Selects the following pattern in the Order List.
|-
| First Order || Selects the first pattern in the Order List.
|-
| Last Order || Selects the final pattern in the Order List.
|-
| Pattern Index Digit 0-9 || Enters the respective numeral into the pattern ID box.
|-
| Increase Pattern Index || Adds one to the pattern number, up to the highest indexed pattern.
|-
| Decrease Pattern Index || Subtracts one from the pattern number, to a minimum of index 0.
|-
|}

=== General Context ===

These keyboard shortcuts will only work if the cursor focus is within one of the columns of the Pattern Editor, except where noted. When navigating (moving the cursor) to before the first row or after the last row in the pattern, the cursor “wraps” to the other side of the same pattern, if the “Cursor Wrap” option is enabled (in the Options section of the General tab of the MPT Setup dialog). If navigating beyond the first or last row when the “Continuous Scroll” option is enabled, the cursor will instead move to the previous/next pattern in the order list.

{| class="wikitable"
|-
! Shortcut !! Description
|-
| Navigate down by 1 row || Moves the cursor to the next row in the same column.
|-
| Navigate up by 1 row || Moves the cursor to the previous row in the same column.
|-
| Navigate down by spacing || Moves the cursor down (in the same column) by the value in the Row Spacing field.
|-
| Navigate up by spacing || Moves the cursor up (in the same column) by the value in the Row Spacing field.
|-
| Navigate left || Moves the cursor to the previous column in the same row, going to the previous channel′s last column if moving from the first column of the current channel.
|-
| Navigate right || Moves the cursor to the next column in the same row, going to the next channel's first column if moving from the last column of the current channel.
|-
| Navigate to next channel || Moves the cursor to the same column in the same row in the next channel.
|-
| Navigate to previous channel || Moves the cursor to the same column in the same row in the previous channel.
|-
| Jump down by measure || Moves the cursor down (in the same column) by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump up by measure || Moves the cursor up (in the same column) by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump down by beat || Moves the cursor down (in the same column) by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump up by beat || Moves the cursor up (in the same column) by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap down to measure || Moves the cursor down (in the same column) to the first row of the next measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap up to measure || Moves the cursor up (in the same column) to the first row of the previous measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap down to beat || Moves the cursor down (in the same column) to the first row of the next beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Snap up to beat || Moves the cursor up (in the same column) to the first row of the previous beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Go to first channel || Moves the cursor to the first column of the first channel in the same row.
|-
| Go to first row || Moves the cursor to the first row of the same channel in the same column.
|-
| Go to first row of first channel || Moves the cursor to the first column of the first channel in the first row.
|-
| Go to last channel || Moves the cursor to the last column of the last channel in the same row.
|-
| Go to last row || Moves the cursor to the last row of the same channel in the same column.
|-
| Go to last row of last channel || Moves the cursor to the last column of the last channel in the last row.
|-
| Previous pattern || Displays the previous pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Next pattern || Displays the next pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Selection key || The modifier key to be used to extend the selection when navigating with keyboard shortcuts.
|-
| Copy select key || The modifier key to be used to copy the selection when dragging with the mouse.
|-
| Select channel / Select all || Toggles the “select all” method, either all events in the current pattern of the current channel where the cursor is located, or all events in the pattern.
|-
| Copy and lose selection || Copies the selected events (replacing whatever was in the clipboard) and deleting the selected events from the pattern. The cursor is not relocated.
|-
| Clear row || Deletes all event data in the same row in the current channel.
|-
| Clear field || Deletes only the data in the same row of the same column in the current channel.
|-
| Clear field (IT Style) || Deletes the note and instrument when the cursor is in the note column; note FX and channel FX remain.
|-
| Clear row and step || Deletes all event data in the same row in the current channel and moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear field and step || Deletes only the event data in the same row of the same column in the current channel and moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear field and step (IT Style) || Deletes the note and instrument when the cursor is in the note column (note FX and channel FX remain) and moves the cursor by the number of rows in the Row Spacing field.
|-
| Delete rows || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; the data is moved up to replace the cleared data, and extra rows are added in the affected channels so that the row number remains the same.
|-
| Delete all rows || Deletes all event data in the selected channels
|-
| Insert Row || Moves event data in the current and following rows in the selected channel down one row. Event data in the last row of those channels is deleted.
|-
| Insert All Rows || Moves event data in the current and following rows in all channels down one row. Event data in the last row of all channels is deleted.
|-
| Mute current channel || Toggles the sound output (mute) for the channel where the cursor is located.
|-
| Solo current channel || Toggles the sound output (mute) for all channels except the one where the cursor is located.
|-
| Unmute all channels || Activates the sound output for all channels, regardless of Mute status.
|-
| (Un)mute chan on pat transition || Toggles the sound output (mute) for the channel where the cursor is located, but the change takes place when the current pattern is finished playing.
|-
| Unmute all channels on pattern transition || Activates the sound output for all channels, regardless of Mute status, but the change takes place when the current pattern is finished playing.
|-
| Solo channel on pattern transition || Toggles the sound output (mute) for all channels except the one where the cursor is located, but the change takes place when the current pattern is finished playing.
|-
| Reset Channel || Stops all note processing, and resets all channel variables to their defaults (volume, panning, etc.).
|-
| Transpose +1 || Raises by one the note number of the currently selected notes.
|-
| Transpose -1 || Lowers by one the note number of the currently selected notes.
|-
| Transpose +12 || Raises by one the octave number of the currently selected notes.
|-
| Transpose -12 || Lowers by one the octave number of the currently selected notes.
|-
| Amplify selection || Opens a dialog to change the volume commands (note FX not channel FX) of the selected volume data. Only selected volume data (third column vxx) is affected.
|-
| Interpolate Note || Transitions smoothly (using all available notes) between notes in the selection, filling in (and replacing if necessary) all rows with new note data.
|-
| Interpolate Volume || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new volume effects. The first and last rows of the selection must contain the same volume effect, or one of the two rows might be empty.
|-
| Interpolate Effect || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new effect data. The first and last rows of the selection must contain the same effect, or one of the two rows might be empty. Different effects within the selection are not overwritten.
|-
| Open effect visualizer || Opens the Params Editor dialog.
|-
| Open pattern randomizer || Opens the Pattern Randomizer dialog. (not functional)
|-
| Go to row/channel/... || Opens the Go To dialog to allow you to display a prompted pattern.
|-
| Apply current instrument || Applies the current instrument to all rows in the selection that contains note data.
|-
| Grow selection || “Expands” the selection by doubling the number of the selected rows, and evenly spacing out the event data within it. The expansion will replace event data below it in the same channels as the selection.
|-
| Shrink selection || “Shrinks” the selection by deleting every other row of the selection. However, if only part of any row is selected, the data corresponding to the deleted selected data is also deleted.
|-
| Toggle follow song || Toggles the “Follow Song” function.
|-
| Quick copy || Copies only one chunk of data (where the cursor is located) to MPT′s “Quick” clipboard; the standard clipboard is not erased. Each column pair has its own Quick clipboard. See the section on Using the Clipboard for more details.
|-
| Quick paste || Pastes the data in MPT′s “Quick” clipboard to the location of the cursor. The data last saved in that column's clipboard will be pasted in the cursor′s corresponding column.
|-
| Enable recording || Toggles the Event Record feature. When enabled, patterns may be edited.
|-
| Play row || Process and play only the events in the current row where the cursor is located.
|-
| Set row jump on note entry || The modifier key(s) that, when pressed with digits 0-8, allows you to change the Row Spacing amount without using the mouse or moving the cursor focus out of the editor.
|-
| Switch to order list || Toggles the cursor focus between the pattern editor and the current pattern in the Pattern Order list.
|-
| Insert new pattern || Inserts a new blank pattern after the current pattern, displays it, and moves the cursor to the same position in it. Also functions when cursor focus is in the Order list.
|-
| Duplicate Pattern || Inserts a new pattern ID with this pattern′s contents.
|-
| Edit Plugin assigned to PC Note || Opens the GUI window for the plugin of the selected Parameter Control Event.
|-
| Toggle channel’s plugin editor || Opens the Plugin Manager dialog.
|-
| Show note properties || Opens the Note Properties dialog, where you can assign any event data to the current row of the current channel.
|-
| Show pattern properties window || Opens the Pattern Properties dialog.
|-
| Show macro configuration || Opens the Macro Setup dialog.
|-
| Split Keyboard Settings dialog || Opens the dialog where a Split Keyboard can be set up.
|-
| Toggle loop pattern || Toggles the Loop Pattern feature.
|-
| Show context (right-click) menu || Opens the context menu at the cursor location without using the mouse.
|-
| Show playback time at current row || Shows the estimated time within the track at the start of the current row.
|-
|}

=== Note Column ===

These shortcuts will be recognized as note entries when the pattern editor has focus and the cursor is in the note column (the first column).

{| class="wikitable"
|-
! Shortcut !! Description
|-
| Base octave [note] || Enters a note in the octave indicated in the Octave field
|-
| Base octave +1 [note] || Enters a note in the next higher octave indicated in the Octave field
|-
| Base octave +2 [note] || Enters a note two octaves higher than the one indicated in the Octave field
|-
| Set octave [0 – 9] || Sets the selected note's octave.
|-
| Chord Modifier || The modifier key(s) that calls a chord rather than a note. The chords are set and assigned in the [[Manual: Chord Editor|Chord Editor]].
|-
| Note Cut || Enters a Note Cut command (^^) and applies the current instrument.
|-
| Note Off || Enters a Note Off command (==) and applies the current instrument.
|-
| Note Fade || Enters a Note Fade command (~~) and applies the current instrument.
|-
| Note Cut (no instrument) || Enters a Note Cut command (^^), leaving the instrument field blank.
|-
| Note Off (no instrument) || Enters a Note Off command (==), leaving the instrument field blank.
|-
| Note Fade (no instrument) (IT only) || Enters a Note Fade command (~~), leaving the instrument field blank.
|-
| Parameter Control (MPTm only) || Enters a [[Manual:_Parameter_Control_Events|Parameter Control event]] (PC), using an absolute setting.
|-
| Parameter Control (Smooth) (MPTm only) || Enters a Parameter Control event (PCs), using a sliding setting.
|-
|}

[[Category:Manual|Keyboard Actions]]

Talk:Manual: Known Issues

2011-10-18T08:22:26Z

Jmkz:

Talk:Manual: Known Issues

2011-10-17T22:55:54Z

Jmkz: Created page with "Xpressor issue should be recovered. I can confirm that I have that issue. -~~~~"

Xpressor issue should be recovered. I can confirm that I have that issue. -[[User:Jmkz|jmkz]] 22:55, 17 October 2011 (UTC)

Manual: Setup/Keyboard

2011-10-17T16:43:13Z

Jmkz: Link to Action List

[[Image:Settings Keyboard.png|thumb|300px|Keyboard tab of the settings dialog]]

In this page you can choose or edit keyboard shortcuts for many of the actions in ModPlug Tracker, which are always active unless the input focus is within a textbox. MPT keeps an internal default layout, but you can save your own or load others that have been proven to be useful to other MPT trackers, or the included in the <code>extraKeymaps</code> subfolder (in MPT’s root) by clicking on the “Import Keys” button near the middle of the page. The list of the '''current''' shortcuts are kept in the <code>Keybindings.mkb</code> file in the <code>"%APPDATA%\OpenMPT"</code> folder (or the root folder if in portable mode), but with this dialog, you can save these shortcuts in a separate file for safekeeping or sharing.
The following is a description of the various items on the page.

== Keyboard Entry Setup ==

To view or edit keyboard shortcuts, first find the context to which the keypress would be applied by clicking on the Category field. A popup menu will open and you can choose the context to view. If you wanted, for example, to assign the Z key to C4 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 – Notes” from the popup menu. The list of assignable note messages will be displayed in the field below it. Scroll down to the “C4” entry and select it. If one or more keys is assigned for that note input, it will be shown on the right under Key Setup. If you want to create a new shortcut, select <new> from the popup menu on the top right, then click inside the “Key” field.

Press the key you want and it will update the assignment. You can also dictate if the entry will be input when the key is first pressed, when it is held, or when it is released.

If there is a conflict between a new keyboard shortcut and one already assigned, you will be notified in the log window. If the conflicting key assignments cannot co-exist, the old one is deleted.

You can also export your key assignments, but ModPlug starts up from the file <code>Keybindings.mkb</code> (kept in the <code>"%APPDATA%\OpenMPT"</code> folder, or next to MPT executable if portable mode)

=== Select Category ===
Shows the current set of functions you can assign shortcuts to. Clicking this field opens a popup menu so you can choose which set of shortcuts you wish to edit or assign.

=== Action List ===
Clicking on one of the entries selects it for key assignment. See [[Action List]] table for a description of the assignable actions.

=== Key setup ID ===
Only enabled when there is an action highlighted, this field shows the choices of key assignments for this action. If there is no key assigned, it will display <code><new></code>; otherwise, the text will read <code>"Choice ''x'' (of ''y'')"</code> where '''''x''''' is the number of the current shortcut and '''''y''''' is the total count of this action's possible key assignments. Clicking in this field will display other choices, where you can select the one to edit.

=== Key ===
Shows the key assignment for this key setup. Clicking in this field (after choosing an action in the Action List) will “listen” for the new key assignment or this choice. Any key presses will be entered into this field and assigned to the action as a keyboard shortcut, but in order to deactivate “listening” you must use the mouse and click outside of the field. the key setup ID is also changed to reflect the new assignment.

=== On Key Down/Hold/Up ===
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.

=== Restore ===
Clicking on this button resets the key assignments of this action to when the action was first selected. If there were conflicts generated, however (see Log below), the altered action is not restored.

=== Delete ===
Clicking on this button deletes this key assignment. If there were other keyboard shortcuts for this action, they remain; otherwise the key setup ID reverts to <code><new></code>.

=== Repeat notes on hold ===
These two buttons are a short cut for enabling or disabling the “On Key Hold” property for all '''note''' keys.

=== Chord Detect Interval ===
Shows the maximum number of milliseconds between note-assigned keypresses that MPT “listens” for, to consider those notes part of a chord.

=== Import Keys ===
Clicking on this button opens the Load File dialog so you can load another <code>.mkb</code> file of your choosing. This allows you or another user to use an alternate set of keyboard assignments.

=== Export Keys ===
Clicking on this button opens the Save File dialog so you can save the current set of keyboard shortcuts within a folder and with a name of your choosing. This is helpful not only for multiple users of one computer, but also for testing different setups for ease of use.

=== Error Log ===
Shows conflicts between key assignments. Conflicts occur when one keypress or combination keypress is already assigned to an action within the same context. A conflict may also occur with the keyboard shortcuts of Windows. Sometimes a conflict can be tolerated, such as using the number keys to enter digits in any context.
In most cases the '''other''' action has its shortcut deleted as you assign the keypresses to this action. Other times there is simply a warning that keys may interfere and actually execute two actions.
A problem may also occur when modifier keys (Shift, Ctrl, Alt, Windows or the Application key) are expected but another key is assigned. In this case, MPT will not allow the non-modifier key to be assigned.

=== Clear Log ===
Clicking this button deletes all the text in the log window.

[[Category:Manual|Setup/Keyboard]]

Manual: Keyboard Actions

2011-10-17T16:41:15Z

Jmkz: Added General Context Table

{{todo|Working on the rest<br />
Update to v1.19.04}}
== Keyboard Setup commands ==

=== Global keys ===

These keyboard shortcuts will work on all parts of ModPlug Tracker, as long as it's the frontmost application. '''Note''': Keyboard shortcuts are ignored when the input focus is within a text field. Only Windows' shortcuts can be applied.

{| class="wikitable"
|-
! Shortcut !! Description
|-
| File/New || Creates a new blank track. If one is already open, it is neither closed nor saved.
|-
| File/Open || Shows the dialog to open an existing readable tracking format. If one is already open, it is neither closed nor saved.
|-
| File/Close || Closes the current song. If it has not been saved, you are given the opportunity before the file is closed.
|-
| File/Save || Saves the file in its current name and format.
|-
| File/Save As || Allows you to save the file with a new name or in another folder.
|-
| File/Save as Wave {1} || Exports the current track into a .wav file in the folder you choose.
|-
| File/Save as MP3 {1} || Exports the current track into an .mp3 file in the folder you choose.
|-
| File/Export to Midi {1} || Exports the current track into the .mid format. See the section on MIDI files for a detailed explanation of how this file is exported.
|-
| File/Export to IT/XM {1} || Exports the current track to "pure" .it format, without MPT's hacks.
|-
| Previous Document || Goes to the previous tracking file that is open (these are visible in the Windows Menu).
|-
| Next Document || Goes to the next tracking file that is open (these are visible in the Windows Menu).
|-
| File/Import Midi Lib || Imports the MIDI Instrument Library of your choosing. If the file is valid, it will appear in the Folder Tree in its own heading.
|-
| File/Add Sound Bank || Imports a sound bank of your choosing. If the file is valid, it will appear in the Folder Tree in its own heading.
|-
| Play song/Pause song || Toggles the playback of the current track. The playback pointer is not reset when using this toggle; that is, it plays from where the pointer left off when it was last pressed.
|-
| Pause song || Only stops the playback of the current track but does not reset the playback pointer.
|-
| Stop Song || Stops the playback of the current track AND resets the pointer to the start of the song.
|-
| Play song from start || Resets the playback pointer to the very first row and begins playback from there.
|-
| Play song from cursor || Resets the pointer to the row where the editing cursor is set (even if the selected row is not in the currently displayed pattern), and begins playback from there. Playback will continue until the end of the track.
|-
| Play pattern from start || Resets the pointer to the first row of the current pattern (even if you are in a different section of MPT), and begins playback from there. It will stop at the end of the pattern (or loop within the pattern if Loop Pattern is enabled).
|-
| Play pattern from cursor || Resets the pointer to the row where the editing cursor is set in the current pattern (even if you are in a different section of MPT), and begins playback from there. It will stop at the end of the pattern (or loop within the pattern if Loop Pattern is enabled).
|-
| Estimate Song Length || Estimates the playback length of the entire track.
|-
| Show approx. real BPM || Estimates the beats per minute of the song, based on the Initial tempo and the number of ticks per row, plus the Tempo Mode in the Song Properties dialog.
|-
| Toggle Midi Record || Toggles the MIDI Record option.
|-
| Undo {2} || Rescinds the last edit. NOTE: there is only one Undo for text edits (pressing Undo a second time re-applies the edited text).
|-
| Cut {2} || Copies the selected data into the clipboard, then removes it from the selection it occupies.
|-
| Copy {2} || Copies the selected data into the clipboard.
|-
| Paste {2} || Pastes the selected data at the location of the cursor, but Paste acts differently on the type of data. With text, clipboard contents are inserted at the point of the cursor, or, if text is already highlighted, replace the selected text. With pattern data, clipboard contents are pasted in the same row at the same column of the current (visible) Pattern where the cursor is located, overwriting any pattern data that falls within the paste area. With sample data, clipboard contents are pasted OVER THE ENTIRE SAMPLE, in essence replacing all of that sample's data with whatever sample data is stored in the clipboard.
|-
| Mix Paste {3} || Clipboard contents are pasted in the same row at the same column of the current (visible) pattern where the cursor is located, EXCEPT where there is already any data in any corresponding field of the paste area.
|-
| Mix Paste (old IT Style) {3} || Clipboard contents are pasted in the same row at the same column of the current (visible) pattern where the cursor is located, EXCEPT where there is already any pattern data that falls within the paste area. However, the note data is assumed to include the note name, the designated instrument, and the note FX (volume data field), so if any of these contain non-blank data, none of the note data in that row of that channel of the clipboard will be pasted over it. (But channel FX data is tested separately, and will be only pasted if the last column in that channel is blank.)
|-
| Paste Flood {3} || Clipboard contents are pasted from the cursor, repeating the data paste until every row in the pattern has been filled and pasting over any data in its path.
|-
| Push-Forward Paste {3} || Clipboard contents are inserted at the row of the cursor, and pushing all data below that row further down the pattern. Any data of the affected channels pushed beyond the pattern's row limit is deleted.
|-
| Toggle Overflow Paste {3} || When enabled, pasting will continue to the next pattern if the data overflows the current pattern.
|-
| SelectAll {2} || Selects all text data, pattern data, or sample data, depending on the location of the cursor or current selection.
|-
| Find || Opens the Find/Replace dialog, which allows you to search for and/or replace given pattern data. Find starts from the cursor location.
|-
| Find Next || Applies the current Find settings and searches for the next data that matches it, selecting the given data; however, it does not set the cursor in that row. For Find to be used again, the cursor must be set in the current pattern, then Find Next searches the entire row (in each channel) before going to the next row.
|-
| View General || Opens the General Tab.
|-
| View Pattern || Opens the Pattern Tab.
|-
| View Samples || Opens the Samples Tab.
|-
| View Instruments || Opens the Instruments Tab.
|-
| View Comments || Opens the Comments Tab.
|-
| View Graph || Currently not functional.
|-
| Toggle Main View || Shows/hides Main toolbar.
|-
| Toggle Tree View || Shows/hides Folder Tree panel.
|-
| View Options || Opens the OpenMPT Setup dialog.
|-
| View Channel Manager || Opens the Channel Manager table.
|-
| View Plugin Manager || Opens the Plugin dialog.
|-
| Show Song Properties || Opens the Song Properties dialog.
|-
| View MIDI Mapping || Opens the MIDI mapping dialog.
|-
| Help (to do) || Opens the Offline Help Manual (currently not functional)
|-
| Previous instrument || Changes the current instrument to the previous one in order.
|-
| Next instrument || Changes the current instrument to the next one in order.
|-
| Previous octave || Changes the current octave to the next lower octave.
|-
| Next octave || Changes the current octave to the next higher octave.
|-
| Previous order || Changes the current pattern to the previous one in the pattern order. If the pattern ID is the same the display will not change.
|-
| Next order || Changes the current pattern to the next one in the pattern order. If the pattern ID is the same the display will not change.
|-
|}

[1] This action does not close or save the current track.

[2] Applies to text, pattern, and sample data.

[3] Applies only to pattern data.

=== Pattern ===

==== Order List ====

These keyboard shortcuts operate while the cursor focus is in the Order List (a pattern ID will be highlighted).

{| class="wikitable"
|-
! Shortcut !! Description
|-
| Delete Order || Erases the pattern from that location in the Order List (the pattern ID is still available, however).
|-
| Insert Order || Creates a new blank spot in the Order List.
|-
| Edit Pattern || Resets the Pattern Editor to show the highlighted pattern.
|-
| Switch to Pattern Editor || Moves the cursor focus to the Pattern Editor.
|-
| Previous Order || Selects the previous pattern in the Order List.
|-
| Next Order || Selects the following pattern in the Order List.
|-
| First Order || Selects the first pattern in the Order List.
|-
| Last Order || Selects the final pattern in the Order List.
|-
| Pattern Index Digit 0-9 || Enters the respective numeral into the pattern ID box.
|-
| Increase Pattern Index || Adds one to the pattern ID, up to the highest indexed pattern.
|-
| Decrease Pattern Index || Subtracts one from the pattern ID, to a minimum of index 0.
|-
|}

==== General Context ====

These keyboard shortcuts will only work if the cursor focus is within one of the columns of the Pattern Editor, except where noted. When navigating (moving the cursor) to before the first row or after the last row in the pattern, the cursor "wraps" to the other side of the same pattern, if the "Cursor Wrap" option is enabled (in the Options section of the General tab of the MPT Setup dialog). If navigating beyond the first or last row when the "Continuous Scroll" option is enabled, the cursor will instead move to the previous/next pattern in the order list.

{| class="wikitable"
|-
! Shortcut !! Description
|-
| Navigate down by 1 row || Moves the cursor to the next row in the same column.
|-
| Navigate up by 1 row || Moves the cursor to the previous row in the same column.
|-
| Navigate down by spacing || Moves the cursor down (in the same column) by the value in the Row Spacing field.
|-
| Navigate up by spacing || Moves the cursor up (in the same column) by the value in the Row Spacing field.
|-
| Navigate left || Moves the cursor to the previous column in the same row, going to the previous channel's last column if moving from the first column of the current channel.
|-
| Navigate right || Moves the cursor to the next column in the same row, going to the next channel's first column if moving from the last column of the current channel.
|-
| Navigate to next channel || Moves the cursor to the same column in the same row in the next channel.
|-
| Navigate to previous channel || Moves the cursor to the same column in the same row in the previous channel.
|-
| Jump down by measure || Moves the cursor down (in the same column) by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump up by measure || Moves the cursor up (in the same column) by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Jump down by beat || Moves the cursor down (in the same column) by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Jump up by beat || Moves the cursor up (in the same column) by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap down to measure || Moves the cursor down (in the same column) to the first row of the next measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap up to measure || Moves the cursor up (in the same column) to the first row of the previous measure, as determined by the number in the Rows/measure field (of the Song Properties dialog).
|-
| Snap down to beat || Moves the cursor down (in the same column) to the first row of the next beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Snap up to beat || Moves the cursor up (in the same column) to the first row of the previous beat, as determined by the number in the Rows/beat field (of the Song Properties dialog).
|-
| Go to first channel || Moves the cursor to the first column of the first channel in the same row.
|-
| Go to first row || Moves the cursor to the first row of the same channel in the same column.
|-
| Go to first row of first channel || Moves the cursor to the first column of the first channel in the first row.
|-
| Go to last channel || Moves the cursor to the last column of the last channel in the same row.
|-
| Go to last row || Moves the cursor to the last row of the same channel in the same column.
|-
| Go to last row of last channel || Moves the cursor to the last column of the last channel in the last row.
|-
| Previous pattern || Displays the previous pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Next pattern || Displays the next pattern in the order list, moving the cursor to its equivalent position in it.
|-
| Selection key || The modifier key to be used to extend the selection when navigating with keyboard shortcuts.
|-
| Copy select key || The modifier key to be used to copy the selection when dragging with the mouse.
|-
| Select channel / Select all || Toggles the "select all" method, either all events in the current pattern of the current channel where the cursor is located, or all events in the pattern.
|-
| Copy and lose selection || Copies the selected events (replacing whatever was in the clipboard) and deleting the selected events from the pattern. The cursor is not relocated.
|-
| Clear row || Deletes all event data in the same row in the current channel.
|-
| Clear field || Deletes only the data in the same row of the same column in the current channel.
|-
| Clear field (IT Style) || Deletes the note and instrument when the cursor is in the note column; note FX and channel FX remain.
|-
| Clear row and step || Deletes all event data in the same row in the current channel and moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear field and step || Deletes only the event data in the same row of the same column in the current channel and moves the cursor by the number of rows in the Row Spacing field.
|-
| Clear field and step (IT Style) || Deletes the note and instrument when the cursor is in the note column (note FX and channel FX remain) and moves the cursor by the number of rows in the Row Spacing field.
|-
| Delete rows || Deletes the same number of rows as the selection, affecting the same number of channels where the selection extends; the data is moved up to replace the cleared data, and extra rows are added in the affected channels so that the row number remains the same.
|-
| Delete all rows || Deletes all event data in the selected channels
|-
| Insert Row || Moves event data in the current and following rows in the selected channel down one row. Event data in the last row of those channels is deleted.
|-
| Insert All Rows || Moves event data in the current and following rows in all channels down one row. Event data in the last row of all channels is deleted.
|-
| Mute current channel || Toggles the sound output (mute) for the channel where the cursor is located.
|-
| Solo current channel || Toggles the sound output (mute) for all channels except the one where the cursor is located.
|-
| Unmute all channels || Activates the sound output for all channels, regardless of Mute status.
|-
| (Un)mute chan on pat transition || Toggles the sound output (mute) for the channel where the cursor is located, but the change takes place when the current pattern is finished playing.
|-
| Unmute all channels on pattern transition || Activates the sound output for all channels, regardless of Mute status, but the change takes place when the current pattern is finished playing.
|-
| Solo channel on pattern transition || Toggles the sound output (mute) for all channels except the one where the cursor is located, but the change takes place when the current pattern is finished playing.
|-
| Reset Channel || Stops all note processing, and resets the memory caches for all FX commands. It clears the buffers and variables as if you pressed the Play Song button.
|-
| Transpose +1 || Raises by one the note number of the currently selected notes.
|-
| Transpose -1 || Lowers by one the note number of the currently selected notes.
|-
| Transpose +12 || Raises by one the octave number of the currently selected notes.
|-
| Transpose -12 || Lowers by one the octave number of the currently selected notes.
|-
| Amplify selection || Opens a dialog to change the volume commands (note FX not channel FX) of the selected volume data. Only selected volume data (third column vxx) is affected.
|-
| Interpolate note || Transitions smoothly (using all available notes) between notes in the selection, filling in (and replacing if necessary) all rows with new note data. The first and last rows of the selection must contain note data.
|-
| Interpolate volume || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new note FX data. The first and last rows of the selection must contain note FX data, and they must be of the same type (volume, panning, etc). Note FX of different types are not replaced.
|-
| Interpolate effect || Transitions smoothly between data amounts in the selection, filling in (and replacing if necessary) all rows with new channel FX data. The first and last rows of the selection must contain channel FX data, and they must be for the same effect (Ixx, Zxx, etc.). Channel FX of different types are not replaced.
|-
| Open effect visualizer || Opens the Params Editor dialog.
|-
| Open pattern randomizer || Opens the Pattern Randomizer dialog. (not functional)
|-
| Go to row/channel/... || Opens the Go To dialog to allow you to display a prompted pattern.
|-
| Apply current instrument || Applies the current instrument to all rows in the selection that contains note data.
|-
| Grow selection || "Expands" the selection by doubling the number of the selected rows, and evenly spacing out the event data within it. The expansion will replace event data below it in the same channels as the selection.
|-
| Shrink selection || "Shrinks" the selection by deleting every other row of the selection. However, if only part of any row is selected, the data corresponding to the deleted selected data is also deleted.
|-
| Toggle follow song || Toggles the "Follow Song" function.
|-
| Quick copy || Copies only one chunk of data (where the cursor is located) to MPT's "Quick" clipboard; the standard clipboard is not erased. Each column pair has its own Quick clipboard. See the section on Using the Clipboard for more details.
|-
| Quick paste || Pastes the data in MPT's "Quick" clipboard to the location of the cursor. The data last saved in that column's clipboard will be pasted in the cursor's corresponding column.
|-
| Enable recording || Toggles the Event Record feature. When enabled, patterns may be edited.
|-
| Play row || Process and play only the events in the current row where the cursor is located.
|-
| Set row jump on note entry || The modifier key(s) that, when pressed with digits 0-8, allows you to change the Row Spacing amount without using the mouse or moving the cursor focus out of the editor.
|-
| Switch to order list || Toggles the cursor focus between the pattern editor and the current pattern in the Pattern Order list.
|-
| Insert new pattern || Inserts a new blank pattern after the current pattern, displays it, and moves the cursor to the same position in it. Also functions when cursor focus is in the Order list.
|-
| Duplicate Pattern || Inserts a new pattern ID with this pattern's contents.
|-
| Edit Plugin assigned to PC Note || Opens the GUI window for the plugin of the selected PCE.
|-
| Toggle channel’s plugin editor || Opens the Plugin Manager dialog.
|-
| Show note properties || Opens the Note Properties dialog, where you can assign any event data to the current row of the current channel.
|-
| Show pattern properties window || Opens the Pattern Properties dialog.
|-
| Show macro configuration || Opens the Macro Setup dialog.
|-
| Split Keyboard Settings dialog || Opens the dialog where a Split Keyboard can be set up.
|-
| Toggle loop pattern || Toggles the Loop Pattern feature.
|-
| Show context (right-click) menu || Opens the context menu at the cursor location without using the mouse.
|-
| Show playback time at current row || Shows the estimated time within the track at the start of the current row.
|-
|}

Manual: Keyboard Actions

2011-10-17T16:20:35Z

Jmkz: Added pattern/Order List shortcut table

Manual: Keyboard Actions

2011-10-17T16:12:34Z

Jmkz: Keyboard Shortcuts Table

Manual: Keyboard Actions

2011-10-17T16:00:50Z

Jmkz: Keyboard Shortcuts Table

Talk:Manual: Tree View

2011-10-17T14:59:51Z

Jmkz: Missing references

I'll try to rewrite the entire page. It doesnt work like it is now.
:Good idea. Also feel free to drop references like "and is the same as using the format before MPT version 1.17.3.02" - that's nothing an up-to-date manual needs, and 1.17.03 was an internal test build anyway. The first official version to feature sequences was MPT 1.18, and it came with its own release notes document with a short explanation that this feature is new. --[[User:Saga Musix|Saga Musix]] 21:34, 29 September 2011 (UTC)
::I agree too. I'm currntly working on [[Manual:_Contextual_Menus_Reference]] and this takes me some time. [[User:Jmkz|jmkz]] 21:39, 29 September 2011 (UTC)
:I've proof-read and corrected the new text and I think it's pretty much complete now. Good work! --[[User:Saga Musix|Saga Musix]] 22:02, 30 September 2011 (UTC)

Currently are missing the references the in table, please fix them. -[[User:Jmkz|jmkz]] 14:59, 17 October 2011 (UTC)

Manual: Tree View

2011-10-17T14:55:15Z

Jmkz: Added context menus table

[[Image:Tree View Upper Half.png|thumb|184px|Upper half of the Tree View]]

The Tree View, or Folder Tree, is a place for all of your resources of your song in a single and easy view, here you have access to your patterns, sequences, samples, instruments, plugins and comments. In addition you also have access to your default instrument and sound library library, this is also available when you do not have any songs loaded.
The Tree view can be found on the left side of MPT’s window. If it is not visible, you can enable it from the [[Manual: Menus#View|View menu]], or with the default keyboard shortcut Ctrl+F2.

The tree view consists of two halfs, which can be adjusted in size by dragging the horizontal splitter bar that separates them. Also, the width of the tree view can be adjusted by dragging the vertical splitter bar on the right side of the view. That way, more or less space can be given to song windows.

=== Song Folders ===

Whenever you load a song or create a new song, a folder with the track’s name is added to the Tree view. If you have multiple songs loaded, you can switch between them by clicking on the song’s root folder. When you click the + icon left of the root folder, you get access to its child folders:

* '''Sequence''': This folder contains one or more order lists (sequences). You can remove and rearrange sequence items by drag’n’dropping them. Double-click an item brings up the [[Manual: Patterns|pattern editor]], where you can edit the selected pattern. If you are working with the MPTM format, it is possible to add and remove sequences by right-clicking the appropriate folder items. This feature can be handy when you want to write several songs that share the same set of instruments, for example for composing game music.
* '''Patterns''': Gives you a list of all the patterns used in your file, and also lists unused patterns. Double-clicking an item brings up the [[Manual: Patterns|pattern editor]], where you can edit the selected pattern. You can also right-click any item to delete the corresponding pattern.
* '''Samples''': Gives you the list of all the samples loaded in your file. Double-clicking an item brings up the [[Manual: Samples|sample editor]], where you can edit the selected sample. Right-clicking an item also gives you the option to preview or delete samples. If you are not working in instrument mode, you can also (un)mute and solo a sample from the context menu. A little green icon can indicate playback (either because the sample is triggered in your song, or when previewing it from the Tree view or sample editor) if the appropriate option is enabled in the [[Manual: Setup/General#Miscellaneous options|General settings]].
* '''Instruments''': Similar to the sample folder, this folder gives you an overview of all instruments. The same options including muteing and soloing instruments are available, and playback status of instruments can be indicated by a little green icon. Additionally, when working with ITP files, you can set instrument paths and save instruments from the context menu.
* '''Comments''': Double-clicking this item brings you to the [[Manual: Comments|comments editor]].
* '''Plugins''': Loaded plugins are listed in this folder. A speaker icon indicates an effect plugin, a keyboard icon indicates an instrument plugin.

=== MIDI Library ===

The MIDI Library is used when loading MIDI files. As MIDI files only contain MIDI protocol data and no samples or other sound generators, it is necessary for a host application to connect MIDI program changes with some kind of sound generator. MPT’s MIDI Library contains a set of General MIDI instruments that are used when importing MIDI files.

By default, those sounds are extracted from DirectX’s default soundfont (GM.DLS), however you can exchange any of the MIDI programs in the MIDI library to make them suit your own taste. This way, you can influence how imported MIDI files sound, but you can also use the MIDI Library as some kind of custom sample library for your own sounds.

By double-clicking a library item, you can import a new sample or instrument for this slot. You can import .xi (FastTracker 2 instruments), .pat (GF1 Patches), .wav (Wave files), .iti (Impulse Tracker Instruments), .dls (Downloadable Sounds) and .sf2 (SoundFont 2.0 banks) files. In the latter two cases, the appropriate patch is loaded automatically. You can use drag’n’drop to import MIDI Library items into the sample or instrument editor.

You can replace the whole library at once by right-clicking one of the folders and choosing '''Import MIDI Library'''. You then can load for example a DLS or SF2 file, which can replace the whole existing library or just fill in missing slots.

Note: ModPlug does not support multilayered SF2 instruments at this moment, so if you choose to load a complex soundfont, ModPlug will only load one layer.

If you want to work with multiple MIDI Libraries, you can right-click any of the MIDI Library folders to import or export the MIDI library to / from a text file.

=== Sound Banks ===

Sound Banks are collections of samples, often sorted in categories defined by the General MIDI standard. Additionally to the default (but poor-sounding) sound bank GM.DLS that is shipped with DirectX and is automatically detected by MPT on Windows systems, you can add new sound banks by right-clicking an empty spot of the Tree view and choosing “Add Sound Bank...”. The following formats are supported:
* SoundFont 2.0 (.sf2)
* SoundFont 1.0 (.sbk)
* Downloadable Sounds (.dls)
* Miles Sound System (.mss)

=== Instrument Library ===

The Instrument Library is made up of two parts — the “Instrument Library” folder in the upper half of the tree view, and the entire lower half. The upper half is used for navigating around your file system and the lower half is used to display folder or module contents.

When expanding the “Instrument Library” folder, you get to see a list of all drives and all child folders of the current library folder. Double-click the “..” folder to navigate one folder up in the file system hierarchy, and double-click any other folder or drive to change to that folder or drive. Module files that OpenMPT can open are marked in green - you can imagine them as virtual folders in your instrument library, and double-clicking a module will show all its samples and instruments in the lower half of the tree view — just like if it was a real folder. You may also right-click a module and choose '''Edit Song''' to open the entire module instead of just importing instruments from it.

The lower half of the tree view is dedicated to displaying folder contents. The first item of this list tells you which folder or module you are currently browsing. By default, only sample and instrument files are shown in this view; if you want to list all folder contents, right-click the first item and choose '''Show All Files'''.

You can preview any instrument by double-clicking it. You may also press note keys just like in the sample editor to play it at a different pitch. If you want to load a sample or instrument from the instrument library into a module, simply drag′n′drop it onto the sample or instrument view.

The Instrument Library is not updated live. If you have added new instruments to the folder that is displayed in the lower half of the tree view, you have to right-click the list and choose '''Refresh''' to reload the folder contents.

== Contextual Menus ==

The context menus in the Tree View depends on the item that you right click on. The following is a table of the elements that have contextual menus and descriptions of the contextual menu items.

{| class="wikitable"
|-
! Element/Icon !! Menu !! Description
|-
| Any || '''Refresh''' || Re-verifies the folders and items that should be shown in the Tree, in case you added, subtracted, or moved elements from outside ModPlug.
|-
| None (Blank space) || '''Add Sound Bank''' || Shows the Open File dialog so you can load an .sf2 or .dls sound bank file.
|-
| Song folder || '''View''' || Brings the track's window to the front.
|-
| || '''Close''' || Closes the song file. If any changes were made to the track, you are prompted to save it.
|-
| Sequence folder || '''Insert Sequence''' || Adds a new empty Sequence to the end of the Sequence list and shows it if the Pattern tab is displayed. This is the only way to create an empty Sequence.
|-
| Sequence ID || '''Swithch to Sequence''' || Displays the current sequence in the Pattern page.
|-
| || '''Insert Sequence''' || Adds a new empty Sequence to the end of the Sequence list and shows it if the Pattern tab is displayed.
|-
| || '''Duplicate Sequence''' || Copies the selected Sequence and adds it to the end of the Sequence List.
|-
| || '''Delete Sequence''' || Deletes the selected Sequence and renumbers the other Sequences if necessary. There is no undo for this deletion, so you are prompted for confirmation.
|-
| Sequence Pattern ID || '''Edit Pattern''' || Shows the selected Pattern and its Sequence in the Pattern page.
|-
| || '''Delete from List''' || Removes the pattern from the sequence, but does not erase the pattern from the track.
|-
| Pattern folder - Pattern ID || '''Edit Pattern''' || Displays the selected pattern in the Sequence from which it was created.
|-
| || '''Delete Pattern''' || Deletes the Pattern from the '''track'''. There is no undo for this deletion, so you are prompted for confirmation.
|-
| Sample folder - Sample ID || '''View Sample''' || Shows this sample slot in the Samples page.
|-
| || '''Play Sample''' || Plays the sample at C-5, the same as clicking on the Preview Sample icon, applying all sample attributes.
|-
| || '''Delete Sample''' || Removes the sample from the track. There is no undo for this deletion, so you are prompted for confirmation.
|-
| Instrument folder - Instrument ID || '''View Instrument''' || Shows this instrument slot in the Instruments page.
|-
| || '''Play Instrument''' || Plays the instrument at C-5, the same as clicking on the Preview Instrument icon, applying all of its attributes.
|-
| || '''Delete Instrument''' || Removes the instrument from the track. There is no undo for this deletion, so you are prompted for confirmation.
|-
| || '''Mute Instrument''' {1} || Disables playback of this instrument in all channels.
|-
| || '''Solo Instrument''' {1} || Enables playback of only this instrument on all channels.
|-
| || '''Unmute All''' || Enables playback of all instruments.
|-
| || '''Set Path''' || (ITP only) Saves the path for the instrument in the track's cache. You can verify the path by looking in the Instruments listing in the Comments page.
|-
| || '''Save''' || Opens the Save File dialog so you can save the instrument with the settings you've made for it.
|-
| Comments icon || '''View Comments''' || Opens the Comments page.
|-
| Plugins folder – Plugin ID || '''Edit''' || Opens the MPT's plugin window. If the plugin has a GUI, it is presented inside the window.
|-
| || '''Bypass''' || Mutes the '''playback''' from or through the plugin. However, the memory cache for its playback is still used, so when you turn off the Bypass the other notes that were played during the muted state will be played at its next note.
|-
| MIDI Library folder (or any of its elements) || '''Import/Export Library''' || Shows the Open File or Save File dialog so you can load or save the selected library.
|-
| MIDI Instrument ID || '''Map Instrument''' || Shows the Open File dialog so you can add this instrument to a sound bank.
|-
| || '''Play Instrument''' || Currently not functional.
|-
| || '''Unmap Instrument''' || Disables the MIDI instrument from use in this library.
|-
| GM folder {2} || '''Properties''' || Shows the info window with details on this .dls file.
|-
| || '''Remove Bank''' || Removes this folder from the Tree permanently. Use Import Sound Bank to reload it from disk.
|-
| || '''Add Sound Bank''' || Shows the Open File dialog so you can load an .sf2 or .dls sound bank file.
|-
| Bank folder – Instrument ID || '''Play Instrument''' || Plays the instrument at C-5, the same as clicking on the Preview Instrument icon, applying all of its attributes.
|-
| Instrument Library folder || '''Show Only Sound/All Files''' || Toggles between showing all files in the Instrument Library folder and only showing sound files. (All disks and volumes are always visible.)
|-
| Library Volume || '''Browse''' || Displays all folders and files at the root level of the selected volume. Click on the "Up Folder" icon to move up one level from the directory. ||
|-
|}

[1] VST instruments cannot be muted by Instrument Mute (or Soloing by other instruments). Use the Bypass item in the Plugin contextual menu to mute VST plugins.

[2] Windows' General MIDI folder is located by default in the following path: <code>%WINDIR%\system32\drivers\gm.dls</code>

[[Category:Manual|Tree view]]

Active row

2011-10-17T13:40:46Z

Jmkz: Content from MPT OHM Glassary.pdf, of OHM source documents

It's the current row where the cursor exists. Even when switching to another pattern, the active row remains in the same pattern until activated by setting the cursor location. If you move the cursor while the Active Row is in a hidden pattern, the Pattern View will switch to the pattern with the Active Row.

Development: Compiling the code

2011-10-15T16:08:43Z

Jmkz:

If you want to get involved with OpenMPT development, or just want to compile your own version of the tracker, here are some hints on how to get started.

== Prerequisites ==

*Visual Studio 2003/2005/2008/2010 (at least Standard version is required; Express will not work)
*''Optional'' [http://tortoisesvn.tigris.org/ TortoiseSVN] or any other SVN client. You will need this to get the latest code revision via the [http://en.wikipedia.org/wiki/Apache_Subversion SVN] system. The description below is written for TortoiseSVN. You can also [http://modplug.svn.sourceforge.net/viewvc/modplug/trunk/OpenMPT/ download the code in a GNU tarball] if you don not want to install a SVN client.

== Getting the code ==

*'''Using TortoiseSVN:''' First, you have to create a directory on your hard drive in which you want to place the source code. Right-click on the directory and choose the context menu entry "SVN Checkout...". The "Repository URL" to fill in is <code><nowiki>https://modplug.svn.sourceforge.net/svnroot/modplug/trunk/OpenMPT</nowiki></code>. After clicking the OK button, all files will be downloaded.

*'''Tarball:''' If you don not want to use a SVN client, simply get the GNU tarball from http://modplug.svn.sourceforge.net/viewvc/modplug/trunk/OpenMPT/ and extract it somewhere.

*Once you have checked out, you can always right-click on the directory and choose "SVN Update..." to get the most recent revision of the code. This will of course not work with the tarball method, you will have to download a new tarball after every commit in that case.

To compile OpenMPT with ASIO and VST support, you will have to get the respective SDKs from the [http://www.steinberg.net/en/company/developer.html Steinberg website]. The following files are required:

*VST 2.4: Copy the files <code>aeffect.h</code> and <code>aeffectx.h</code> from <code>vstsdk2.4/pluginterfaces/vst2.x</code> to the "include" directory of OpenMPT.

*ASIO: Copy the files <code>asio.h</code>, <code>asiosys.h</code> and <code>iasiodrv.h</code> from <code>common/</code> to the "include" directory of OpenMPT.

== Compiling the code ==

To open the code, you will need Visual Studio .NET 2003/2005/2008/2010.

Open the file <code>mptrack/MPTRACK.sln</code> (if you are using VS2003 or VS2005), <code>mptrack/MPTRACK_08.sln</code> (VS2008) or mptrack/MPTRACK_10.sln (VS2010) in Visual Studio and click on the menu item "<code>Build</code>"→"<code>Build solution</code>" to compile the code. Note that this process may take quite a while!

Depending on the version of Visual Studio used, the code might not compile out of the box. Some known reasons for that are:

*You forgot to download the VST 2.4 and ASIO SDKs. Read the previous section to find out which files you need. Alternatively, if you don not want to compile OpenMPT with VST and ASIO support, you can define the constants <code>NO_VST</code> and <code>NO_ASIO</code> in the file <code>StdAfx.h</code> (appropriate <code>#define</code> statements are already present but commented out).

*File dsound.h not found: You need the DirectX SDK. Please read the next step to find out how to add the SDK to Visual Studio's path settings. Alternatively, you can define the constant <code>NO_DSOUND</code> in the file <code>StdAfx.h</code> (an appropriate <code>#define</code> is already present but commented out). '''Installing this before installing Visual Studio''' could spare you some work with setting up the paths.

*If not installed with Visual Studio already, you will also require the [http://www.microsoft.com/downloads/details.aspx?FamilyId=A55B6B43-E24F-4EA3-A93E-40C0EC4F68E5&displaylang=en Microsoft Platform SDK]. After installing, you should check if the library and include paths have been set up properly in Visual Studio. To do so, go to "<code>Tools</code>"→"<code>Options</code>" and then "<code>Projects</code>"→"<code>VC++ Directories</code>". With VS2008 and VS2010, this step should not be necessary.

== Staying up to date ==

If you want to be notified of new code commits, you can subscribe to the SVN mailing list at https://lists.sourceforge.net/lists/listinfo/modplug-svn-commit.

Development: Compiling the code

2011-10-15T16:08:00Z

Jmkz: Article copied from OpenMPT forum (http://forum.openmpt.org/index.php?topic=4432.0)

Talk:Manual: Contextual Menus Reference

2011-10-15T14:50:32Z

Jmkz:

It might be better to actually keep the context menu explanations on the appopriate pages (f.e. Manual: Samples, Manual: Patterns, etc...), what do you think? That's at least how we do it on the German Wiki. --[[User:Saga Musix|Saga Musix]] 23:18, 29 September 2011 (UTC)
:Ok, I'll make some changes not so soon, and let's see how it works ;) [[User:Jmkz|jmkz]] 00:15, 30 September 2011 (UTC)

Saga, you can now delete this page, I have moved into appropiate pages now. [[User:Jmkz|jmkz]] 14:50, 15 October 2011 (UTC)

Manual: Patterns

2011-10-15T14:46:55Z

Jmkz: Transferred Contextual Menus from Reference

{{todo|Respective Images}}
__NOTOC__
== Contextual Menus ==

Image of pattern context menu

Many of the menu items in this contextual menu may not be available/visible based on what the selection contains. To show all menu items, even if they don not apply, check the “Old-style Pattern Context Menu” option in the General page of the Options dialog; the unavailable items will be grayed out.

===== Select Column =====

Select all data within the selected channel.

===== Select Pattern =====

Select all data within the current pattern.

===== Cut =====

Executes a Copy action on the selected region, then erases all data from it. The cursor is not relocated.

===== Copy =====

Copies the selection to the clipboard, leaving the data and cursor location intact.

===== Paste =====

Transfers a copy of the clipboard contents (if it is pattern data) where the cursor is located, overwriting any data within the bounds of the pasted data. This will begin in the same event as the cursor location, even if the cursor is not in the first column of the event.

===== Mix Paste =====

Transfers a copy of the clipboard contents where the cursor is located, but what is entered depends on the Mix type. Normally, the values are changed, but for the effect columns, the prefixes are not overwitten. In IT style, only empty fields within the bounds of the pasted data are overwritten. See the [[Manual:_Menus#Paste|Edit menu]] version of this command for an example.

===== Undo =====

Repeals the last action taken, up to the most recent 1000 actions in the Pattern Editor and 1000 per sample in the Sample Display. Note, however, navigation cannot be un-done.

===== Clear =====

Erases all data in the selected region without affecting the clipboard contents.

fields), the origin data will simply be repeated, filling in any blank fields in the affected columns. The transition will occur within all channels in the selection for those that meet the criteria, using the following rules:

===== Interpolate =====

Fills in data that transitions between the uppermost, or “origin”, data of the selected column and the lowermost (“destination”) data in the same column. If the data in the origin is the same as the destination row (or if the destination row has blank fields), the origin data will simply be repeated, filling in any blank fields in the affected columns. The transition will occur within all channels in the selection for those that meet the criteria, using the following rules:

===== Interpolating Notes =====

* The notes will be transitioned using the notes according to the note names of the tuning which they use; if no tuning is applied, it will use MPT’s default notes of the “B chromatic scale” — C, C#, D, D#, E, F, F#, G, G#, A, A#, and B.

* Any row in the interpolated selection which already contains a note will be skipped, and the existing note will remain.

* If the origin note is also assigned an instrument, the instrument will accompany any note entered into the transition (skipping already existing notes), even if the destination note does not call an instrument.

===== Interpolating Note Effect =====

* Any row in the interpolated selection which already contains a note effect will be skipped and will remain intact, '''unless''' it is the same effect command as the interpolated data.

===== Interpolating Channel Effect =====

* Any row in the interpolated selection which already contains a channel effect will be skipped and will remain intact, '''unless''' it is the same effect command as the interpolated data.

* If only one side of the channel effect column is selected (the prefix or the value), the transition will still occur using the same rules.

===== Transpose =====

Changes the pitch of all notes within the selection, up or down an octave, or up or down one note.

===== Change Instrument =====

Assigns the current instrument (shown in the Main Instrument field) to '''all''' notes within the selection (even if the selection does not include the instrument column). This will override the alternate instrument applied from a keyboard split. (There is no way to apply the alternate instrument based on the note using a keyboard shortcut or contextual menu.) This menu item will appear only if the right-click is on a note event.

===== Amplify =====

image of amplify window

Assigns a volume command to all notes in any event included in the selection. It is applicable only if the note effect column is included in the selection, but the note column does '''not''' need to be included. When choosing this command, you will be presented with the Amplify dialog which allows you to enter a percent decrease/ increase of each notes current volume. (If the note does not have a volume command, the volume value is assumed to be 64; the sample's/instrument's volume settings are not considered). Then each note in an event that is part of the selection will be assigned a volume command with the calculated value. '''Note:''' Amplify does not work in MOD formats.

===== Visualize =====

Opens the Parameter Editor window, using only the channel FX data from the first channel of the selection.
The next 3 menu items are only visible if the right-click occurs on a Parameter Control Event (PCE):

:'''Change Plugin:''' Shows a submenu so you change the PCE plugin to another one. Only loaded plugins are listed.

:'''Change Plugin Parameter:''' Shows a submenu of the plugin's parameter IDs (along with their names if the VST provides them) so you can choose another parameter to control.

:'''Toggle Plugin Editor:''' Opens the plugin GUI so you can edit the parameters or use other functions.

===== Grow Selection =====

Doubles the number of rows the selection occupies by inserting a blank row after every row in the selection. This will overwrite any rows in those channels below the selection, then re-select the area overwritten. The cursor is not relocated.

===== Shrink Selection =====

Halves the number of rows the selection occupies by deleting every second row in the selection. The new area is re-selected, but the cursor is not relocated.

===== Show Row Play Time =====

Displays an estimate of the time length from the song/sequence start to the selected row.

===== Insert Rows =====

Inserts one row at the top row of the selection in every selected channel, shifting (the rows below it) down by one row, which deletes the last row in the channel.

===== Delete Rows =====

Deletes the selected rows in the selected channels, shifting (the rows below it) up by the same number deleted and inserting empty rows at the bottom to keep the same number of rows in the channel.

=== Order List ===

===== Insert Pattern =====

Copies the same selected pattern(s), placing the same Pattern IDs at that point in the Order List.

===== Remove Pattern =====

Removes the selected pattern(s) from the Order List.

===== Create New Pattern =====

Places a new blank pattern in the Order List where you clicked, or after the last “official” pattern, whichever is closest to the front. If the selected pattern is a null pattern, the new blank pattern will have the default number of rows (64); otherwise it will contain the same number of rows.

===== Duplicate Pattern =====

Copies the pattern into a new pattern ID, placing it in the Order List where you clicked, or after the last “official” pattern, whichever is closest to the front.

===== Copy Pattern =====

Copies the pattern data of a single pattern (the selected one) into the clipboard.

===== Paste Pattern =====

Places the pattern data in the clipboard into the selected pattern, replacing any data in the pattern. The Pattern ID is not changed.

===== Copy Orders =====

Copies the selected Pattern IDs (Orders) into the clipboard. This option appears only if multiple orders are selected.

===== Cut Orders =====

Copies the selected Orders into the clipboard and removes the selection from the Order List. This option appears only if multiple orders are selected.

===== Paste Orders =====

If there are any Patterns in the clipboard, the Pattern IDs are inserted before the selected Order.

===== Pattern Properties =====

Opens the [[Manual:_Pattern Properties|Pattern Properties]] dialog.

===== Sequences =====

This submenu only appears in MPTM tracks, and you can choose from the following items:

:'''Sequence List:''' The first items are a list of all the Sequences in the module. Selecting one switches to that Sequence.

:'''Duplicate Current Sequence:''' Creates a new Sequence at the end of the Sequence List, and copies the Orders into it. The Sequence name is not copied over.

:'''Create Empty Sequence:''' Creates a new Sequence at the end of the Sequence List without any Orders.

:'''Delete Current Sequence:''' Deletes the current Sequence, but not any Patterns that it may contain. There is no Undo for this action, so you are prompted for confirmation after selecting this option.

===== Render to WAV =====

Exports the selected pattern(s) to a .wav file. See the section on [[Manual:_Saving_and_exporting#Wave_Export|WAV Export]] for more info.

=== Channel Header ===

Image of channel header context menu

===== Mute Channel =====

Disables all audio output from this channel.

===== Solo Channel =====

Mutes all channels except this one.

===== Unmute All =====

Enables audio output from all channels.

===== Transition Actions =====

Will carry out one of these actions the next time the playback pointer is at the beginning row of the next-played pattern. The actions are Mute (disable audio from the selected channel), Unmute All (enable audio from every channel), or Solo (disable audio from all '''except''' the selected channel).

===== Reset Channel =====
Stops the processing of all notes in the channel, as well as reverts to the initial channel settings, such as those for pan position, volume, etc.

Manual: Samples

2011-10-15T14:45:27Z

Jmkz: Transferred Contextual Menus from Reference

{{todo|Respective Images}}
__NOTOC__
== Contextual Menus ==

The contextual menus for the Sample Display are different depending on whether or not there is a selected block of data.

Image of "normal" context menu; Image of on-selection fragment context menu.

The left menu will show with a Right-click in the waveform display when there is a selection; otherwise, the menu on the right will pop up.

===== Set as (Sample) Loop =====

When a selection is made, this sets the start and end points of the Sample Loop to that of the selection block.

===== Set Loop Start =====

Uses the selected sample point as the start of the Sample Loop.

===== Set Loop End =====

Uses the selected sample point as the end of the Sample Loop.

===== Set as Sustain Loop =====

When a selection is made, this sets the start and end points of the Sustain Loop to that of the selection block.

===== Set Sustain Start =====

Uses the selected point as the start of the Sustain Loop.

===== Set Sustain End =====

Uses the selected sample point as the end of the Sustain Loop.

===== Convert to 8-bit =====

If the sample is 16-bit, this will convert the sample to 8-bit, slightly reducing its sound quality in exchange for a smaller sample size. Neither the pitch nor the playback frequency is altered.

===== Convert to Mono =====

Blends the left and right channels together to mono-ize the sample, which can save file space or allow for interesting playback effects.
'''Note:''' There is no “Convert to Stereo” function.

===== Trim =====

Deletes all sample data outside of the selected region. You cannot trim audio channels separately with ModPlug.

===== Trim around Loop Points =====

Deletes all sample outside of the selected region. If no selection is given, then the selection outside of the Sample Loop points will be deleted. You cannot trim audio channels separately with ModPlug.

===== Quick Fade =====

If the selection includes the beginning of the waveform, this applies a fade-in from the first sample point to the last one in the selected region. If the selected region includes the end of the waveform, then a fade-out from the first sample point of the selection to the last one is applied. If both beginning and end are part of the selection, then this is the same as applying a Crossfade to the entire waveform.

===== Cut =====

Performs a Copy command, then removes the selected data points, shifting the remaining sample data together.

===== Copy =====

Stores the start and end points of the selection, overwriting the clipboard. Unfortunately you cannot do anything with this data except Paste it into (over) this or another sample. It cannot be pasted into a third-party audio editor.

===== Paste =====

Replaces the entire sample with the sample data in the clipboard. You cannot paste '''into''' the sample waveform.

===== Undo =====

Reverts to the previous waveform data (before the last edit).

=== Sample Map ===

===== Edit Sample Map =====

Opens the [[Manual:_Sample_Map|Sample Map]] dialog, where you can assign samples to certain notes for input and playback.

===== Edit Sample =====

Allows you to select a sample whose attributes you wish to modify; once selected, the Samples tab is opened and the sample slot is shown.

===== Map All Notes to sample =====

Assigns all notes to the sample.

===== Map All Notes to note =====

Assigns all notes to the given note.

===== Transpose Map Up =====

Moves the sample assignments up one semitone.

===== Transpose Map Down =====

Moves the sample assignments down one semitone.

===== Reset Note Mapping =====

Reverts the map to the default assignment of C-0 through B-9.

===== Duplicate Instrument =====

Creates a new instrument slot and sets all of its attributes to those of the current instrument.

Manual: Module formats

2011-10-15T14:26:06Z

Jmkz: Missing dot

== File formats that can be read and written by ModPlug Tracker ==

=== The MOD format (.mod) ===

The MOD format is the original tracking format, developed for the Commodore Amiga and its application Ultimate SoundTracker.
It was designed to use 4 channels each with one voice. Ultimate SoundTracker was soon superseded by ProTracker, which allowed for more tracker commands (effects), longer samples and more improvements. Later, more popular variants of the MOD format made use of 32 channels, exceeding the original Amiga limits.
Arguably one of the most widespread tracker formats (because of its use in many computer games and demos), it is also one of the simplest to use, but this is due to its few note-driven effects.
With MPT, you can use up to 32 tracks (the default is 4), and note data includes sample numbers (as opposed to instruments, which cannot be used in the MOD format).
Initial tempo, number of rows (always 64), and the “time signature” cannot be defined (always uses the highlight values provided in the [[Manual:_Setup/Colours|Colour setup]]).
There is limited sample control and few global settings.

=== The ScreamTracker 3 format (.s3m) ===

Scream Tracker 3′s S3M format added sample tuning (defining the exact frequency of the middle C for samples), increased the number of playback channels, made use of an extra column specifically for volume control (which was extended by other trackers to handle panning commands as well), and compressed pattern data for smaller file sizes.
ModPlug Tracker has similar limitations when working with .s3m files as .mod, except with the S3M format, you can set the initial tempo and speed (ticks per row), initial global and sample volume, initial channel pan, and set each sample’s playback frequency.
Compared to MOD, there is also a different, more expanded set of effect commands.

=== The FastTracker 2 format (.xm) ===

With the XM format, Fasttracker 2 introduced the concept of “instruments”, which applied volume and panning envelopes to samples or sample loops. It also added the ability to map several samples to the same instrument.
It uses MOD effect command numbers, plus a few of its own for more sound control.
You can define initial tempos, speeds, and time signatures; provide envelopes to samples by assigning them to instruments; set sample looping and apply vibrato oscillation; and with MPT, apply VST plugins to instruments, channels, or the track.

=== The Impulse Tracker format (.it) ===

Impulse Tracker introduced the IT format, which, in comparison to the XM format, allows instruments to also specify the transposition of assigned samples depending on the note being played, applying resonance filters to samples, and defining “New Note Actions” (NNAs) for instruments to release playing notes on a pattern channel while a new note is already playing, which helped to increase polyphony without having to resort to more pattern channels.
Samples also have decent compression in file storage when saving IT files directly in Impulse Tracker.
IT effect commands use a more advanced set of S3M commands.

=== The IT Project format (.itp) ===

ITP is a version of ModPlug’s IT format, which, instead of storing the samples internally, stores the relative links the sample files, making a file in this format rather small but still full of MPT’s features, especially when using MPT on a flashdrive, or “stick”.
It also makes less of a memory footprint on one’s hard drive, because the sample is not duplicated for storage into the track file.

=== The OpenMPT format (.mptm) ===

MPTM is ModPlug Tracker’s own format. It follows the IT format, except there are added capabilities of tunings, Parameter Control events, and Pattern Sequences and many more features.

=== The MIDI format (.mid) ===

MIDI files are of course no module files. They store instrument parameters and patterns in a block format that is not easily converted to a tracker format.

MPT can import many MIDI-sequenced songs in the MID format, but it is important to remember that sequence files are not the same as tracks and the data within the file does not translate well to a tracking format. The main problem that MPT has with MIDI importing is that the events are not lined up in evenly or uniformly in channels, so that, while all the events may be brought in, you have to spend hours clicking-and-dragging all the events to their proper time and channel.

Users at the ModPlug forum have suggested the following to import MIDI files. Until the MIDI capabilities are quantified and streamlined, this is all we have.
* When importing MIDI files, experiment with the File Import speed in the [[Manual: Setup/MIDI|MIDI Setup]]. Usually the higher the speed, the more will be brought in to each pattern.
* Quantize the original MIDI file in its original application to 120 BPM and try to import with MPT.
* Use a third-party application to convert a MIDI file to a track, then open the track in MPT. Suggestions are [http://www.un4seen.com/mid2xm.html MID2XM] (a Win16-based shareware application, so will not run on 64-Bit Windows systems), [http://berotracker.de/ BeRoTracker] (a freeware tracker) and [http://www.renoise.com/ Renoise] (a commercial application which handles MIDI files well) together with [http://xrns2xmod.codeplex.com/documentation Xrns2XMOD] (as Renoise does not output files readable by OpenMPT by default).

== File formats that can only be read by ModPlug Tracker ==

The following formats can be imported into OpenMPT. Internally, they are converted to one of the file formats described above.
Depending on the source format, conversion might not always be accurate.

* Composer 669 / UNIS 669 (.669)
* ASYLUM Music Format / Advanced Music Format (.amf)
* Extreme’s Tracker / Velvet Studio (.ams)
* DigiBooster (.dbm)
* X-Tracker (.dmf)
* DSIK (.dsm)
* Farandole Composer (.far)
* General Digital Music (.gdm)
* Imago Orpheus (.imf)
* Jazz Jackrabbit 2 Music (.j2b)
* DigiTracker (.mdl)
* OctaMED (.med)
* MadTracker 2 (.mt2)
* MultiTracker (.mtm)
* Oktalyzer (.okt)
* Epic Megagames MASI (.psm)
* PolyTracker (.ptm)
* Scream Tracker 2 (.stm)
* UltraTracker (.ult)
* Unreal Music (.umx) ''only from Unreal (Tournament 1) and Deus Ex''
* Grave Composer (.wow)

=== Compressed modules ===
ModPlug Tracker also handles several compression formats, so you do not extract modules from these formats to be able to listen to them: Modules in ZIP, RAR, LHA and GZ containers can be opened directly. Modules in ZIP or RAR archives make use of custom file extensions sometimes; Instead of ZIP or RAR, the file extension might be one of the following: MDZ, S3Z, XMZ, ITZ, MPTMZ, MDR.

MPT cannot save modules into compressed files, you will have to save your work as a normal module first and then compress it f.e. with Windows’ zip capabilities or other third party compression utilities.

Some module-specific compression routines are also supported, for example XPK and PowerPack PP20.

Furthermore, OpenMPT can handle MO3 files. MO3 is a highly compressed module format with lossy sample compression.
MO3 encapsulates the features of several module formats (IT, XM, S3M, MTM, MOD), but with one big difference: MP3 and OGG compressed samples.
It also has a lossless codec for any samples that do not like lossy encoding, and the whole file structure is compressed too. [http://www.un4seen.com/mo3.html]

MO3 files can only be read if unmo3.dll is present in OpenMPT’s root directory; This file is shipped with OpenMPT, but can also be downloaded [ftp://ftp.untergrund.net/users/sagamusix/openmpt/archive/unmo3/ separately].

[[Category:Manual|Module formats]]

Manual: Samples

2011-10-15T14:22:11Z

Jmkz: /* Convert to Mono */

Manual: Instruments

2011-10-15T14:21:30Z

Jmkz: Created page with "{{todo|Respective Images}} __NOTOC__ == Contextual Menus: Envelope Window == Image of envelope window context menu ===== Loop ===== Toggles the Instrument Loop. ===== Sustai..."

{{todo|Respective Images}}
__NOTOC__
== Contextual Menus: Envelope Window ==

Image of envelope window context menu

===== Loop =====

Toggles the Instrument Loop.

===== Sustain =====

Toggles the Sustain Envelope.

===== Carry =====

Toggles the Envelope Carry.

===== Insert Point =====

Adds a new point to the envelope at the location of the mouseclick.

===== Remove Point =====

Removes the selected point from the envelope. You cannot remove the first or last point.

===== Toggle Release Node =====

Toggles the point as a Release Node.

===== Copy Envelope =====

Places the data of the envelope into the Clipboard.

===== Paste Envelope =====

Transfers the envelope data in the clipboard to the selected envelope, replacing it if it exists already. Release nodes are not pasted to non-MPTM tracks.

===== Scale Points =====

Shows a dialog which allows you to shift all envelope points by a given factor. For example, scaling by a factor of 2 will double the time it takes to get to each envelope point.

Manual: Samples

2011-10-15T14:17:15Z

Jmkz: Created page with "{{todo|Respective Images}} __NOTOC__ == Contextual Menus == The contextual menus for the Sample Display are different depending on whether or not there is a selected block of da..."

{{todo|Respective Images}}
__NOTOC__
== Contextual Menus ==

The contextual menus for the Sample Display are different depending on whether or not there is a selected block of data.

Image of "normal" context menu; Image of on-selection fragment context menu.

The left menu will show with a Right-click in the waveform display when there is a selection; otherwise, the menu on the right will pop up.

===== Set as (Sample) Loop =====

When a selection is made, this sets the start and end points of the Sample Loop to that of the selection block.

===== Set Loop Start =====

Uses the selected sample point as the start of the Sample Loop.

===== Set Loop End =====

Uses the selected sample point as the end of the Sample Loop.

===== Set as Sustain Loop =====

When a selection is made, this sets the start and end points of the Sustain Loop to that of the selection block.

===== Set Sustain Start =====

Uses the selected point as the start of the Sustain Loop.

===== Set Sustain End =====

Uses the selected sample point as the end of the Sustain Loop.

===== Convert to 8-bit =====

If the sample is 16-bit, this will convert the sample to 8-bit, slightly reducing its sound quality in exchange for a smaller sample size. Neither the pitch nor the playback frequency is altered.

===== Convert to Mono =====

Blends the left and right channels together to mono-ize the sample, which can save file space or allow for interesting playback effects. '''Note:''' There is no “Convert to Stereo” function.

===== Trim =====

Deletes all sample data outside of the selected region. You cannot trim audio channels separately with ModPlug.

===== Trim around Loop Points =====

Deletes all sample outside of the selected region. If no selection is given, then the selection outside of the Sample Loop points will be deleted. You cannot trim audio channels separately with ModPlug.

===== Quick Fade =====

If the selection includes the beginning of the waveform, this applies a fade-in from the first sample point to the last one in the selected region. If the selected region includes the end of the waveform, then a fade-out from the first sample point of the selection to the last one is applied. If both beginning and end are part of the selection, then this is the same as applying a Crossfade to the entire waveform.

===== Cut =====

Performs a Copy command, then removes the selected data points, shifting the remaining sample data together.

===== Copy =====

Stores the start and end points of the selection, overwriting the clipboard. Unfortunately you cannot do anything with this data except Paste it into (over) this or another sample. It cannot be pasted into a third-party audio editor.

===== Paste =====

Replaces the entire sample with the sample data in the clipboard. You cannot paste '''into''' the sample waveform.

===== Undo =====

Reverts to the previous waveform data (before the last edit).

Talk:Manual: Contextual Menus Reference

2011-09-30T00:15:45Z

Jmkz:

Talk:Manual: Display Features

2011-09-20T16:06:27Z

Jmkz: Created page with "I guess Multiview article fits here, and Display Features can be expanded in the future."

I guess Multiview article fits here, and Display Features can be expanded in the future.

Talk:Manual: Setup/Soundcard

2011-09-18T17:32:16Z

Jmkz:

Note for link references (OHM): Links to references are linked to Reference:_"section"/"Theme"