Manual: System Setup

From OpenMPT Wiki
Jump to navigation Jump to search

System requirements[edit]

System requirements are few. There are different versions of OpenMPT for various hardware and software configurations. All you need to run and use OpenMPT is:

  • 32-bit version:
    • Windows 7 SP 1 or newer / Wine 1.8 or newer
    • An x86-compatible CPU with support for the SSE2 instruction set*
  • 64-bit version:
    • Windows 7 SP 1 or newer / Wine 1.8 or newer
    • An x64-compatible CPU
  • ARM versions
    • Windows 10 or newer / Wine 1.8 or newer
    • An ARM / ARM64 CPU
  • Some kind of soundcard
  • A display resolution of 800x600 or higher, preferably much higher.

*Most computers capable of running Windows 7 will fulfill this requirement.

64-bit vs. 32-bit[edit]

If you run a 64-bit operating system, you should generally use the 64-bit version of OpenMPT.
If you must use 32-bit VST plugins, then you should take care; plugins that do not match OpenMPT’s “bitness” need to be run in a bridge process, and every bridged plugin slows down OpenMPT’s audio mixer. If you use more 32-bit plugins than you do 64-bit plugins, you should use the 32-bit version of OpenMPT to lessen performance issues.

If in doubt, you can try both versions and use either one at your discretion. When using the OpenMPT installer, all versions of OpenMPT supported by your setup are installed automatically. When using portable builds, you can extract them into separate directories to verify which one works better.

Expandability[edit]

OpenMPT can also take advantage of some peripherals, such as:

  • A MIDI-compatible external device. See the MIDI Reference for setting up a MIDI device for use in OpenMPT.
  • External speakers or headphones, including Quad Surround systems for soundcards that support this configuration.
  • Software plugins (either VST or DirectX plugins) that are compatible with your computer and operating system.*

*OpenMPT's system requirements are independent from any software plugin(s) you might use with it. Since some plugins can require higher system requirements than OpenMPT itself, you should also check the system requirements of any plugin(s) you plan on using.

Installation[edit]

  1. Download a version of OpenMPT.
  2. Install OpenMPT.
    • If you are using the Installer software for OpenMPT, you will be asked for the directory you wish to install OpenMPT into.
    • If you are updating from a previous version, the installer will replace the old files and folders with any new ones by default as well as update the registry (for file associations) if necessary.
      Note: As with all software, updates may not be as stable as their previous versions, or features that you have become accustomed to may have been reworked in the new version. Although the Installer will keep the old user files (by giving the files a new extension), it is recommended you backup your previous version of OpenMPT until you are satisfied with the upgrade.
    • If you are using the .zip archive, unzip the archive to the folder of your choice.
  3. Run OpenMPT.
When run for the first time, the Welcome dialog will appear automatically to allow you to set up some basic settings. There are many more ways to customize OpenMPT through the Setup dialog, but you should first set up your soundcard settings by opening the “Sound Card” tab in the Setup dialog. Consult the section on Soundcard Options for determining the proper settings for your system. OpenMPT’s conservative default settings should work on all Windows systems, but adjusting the options to better meet your system's capabilities will likely give you a better experience.

Uninstallation[edit]

If you wish to uninstall OpenMPT, you can use the provided uninstaller to remove all files and registry entries created during installation. However, this process will not remove files created during the use of OpenMPT, which you may want to remove manually. If you have installed OpenMPT for all users of the system, this step needs to be repeated for every Windows user account on which OpenMPT was used.

  • Auto saves: Before uninstalling OpenMPT, review your Auto Save settings. If a fixed auto save location has been set up, make sure to empty that folder if you do not want to keep the auto save files.
  • Configuration data: Before uninstalling OpenMPT, choose “Show Settings Folder” from the “Help” menu to open the folder containing all configuration data. Uninstall OpenMPT, then delete the folder.

Portability[edit]

If you would like to use OpenMPT on a flash drive or other removable media, there is an option to keep OpenMPT self-contained so that it does not leave a footprint on the computer’s system. Using OpenMPT’s installer affects the system registry and creates a new folder in the Settings directory. Portable Mode bypasses all of these. It can be achieved in multiple ways:

Portable Zip Package[edit]

This is the preferred option. On the download page, download a portable zip package for the architecture(s) you want to run OpenMPT on. If you want to have a portable OpenMPT version for more than one architecture, you must extract those packages to separate folders.

Command-line switch[edit]

You can force OpenMPT into using Portable Mode by specifying the /portable command-line switch. Even if there is no configuration file present in OpenMPT’s directory, it will not look for an existing configuration in %APPDATA%\OpenMPT.

This way, you can copy an existing OpenMPT installation to a different location and make it portable temporarily.

Creating a permanent portable multi-architecture setup[edit]

To manually create a portable multi-architecture OpenMPT setup, you can use an existing installation from a non-portable drive.

  1. Copy all of the files in the original OpenMPT folder (typically C:\Program Files\OpenMPT) to a new folder on the portable drive.
  2. Create a file called OpenMPT.portable in that folder.
  3. If you want to import your previous configurations (like keyboard shortcuts, tunings, and other preferences), you will need to:
    1. Navigate to OpenMPT's setting folder (%APPDATA%\OpenMPT). This can be achieved by using the “Show Settings Folder” option from the Help menu.
    2. Copy all files into the folder you created. This includes mptrack.ini, Keybindings.mkb, plugin.cache, SongSettings.ini and the tunings folder.

Be sure to adjust the paths in the General and the Paths / Auto Save pages of the Options dialog.

After the above changes, OpenMPT should be completely portable. If you will be working away from your main computer, remember to copy any samples, instrument files, and plugins you plan on using somewhere you can access them.

Important notes: Special care has to be taken of modules with external content:

  • Plugins need to be installed on the same removable drive as OpenMPT or else they cannot be found on another computer. Some plugins cannot be used in a portable fashion since they may depend on program data on the system drive or registry entries.
  • Paths to external samples in MPTM modules are stored as relative paths to the MPTM file if possible, so they are portable as long the samples are stored on the same drive as the module file.