Warning

This is the dev documentation for an unreleased version of MPF!

This is the documentation for MPF 0.56, which is the “dev” (next) release of MPF that is a work-in-progress. Unless you’re specifically looking for this version, you probably want to use the version of documentation called “latest” which is for the latest released version of MPF. That documentation is at docs.missionpinball.org/en/latest.

Config file instructions

This section contains some general formatting guidelines.

• Understanding the #config_version setting
  • Updating your config files to the latest version
  • Which versions of MPF require which config_versions?
• Machine config files
• Mode config files
• Using dynamic runtime values in config files
  • Types of dynamic values
    • Current Player Variables
    • Player Variables of Specific Player
    • Game Variables
    • Machine Variables
    • Settings
    • Devices
    • Modes
  • Using if/else logic with dynamic values
• Gamma correction in MPF
  • Tuning your DMD gamma
• How to enter gain values in config files
  • Entering a simple numeric gain value
  • Entering a gain value in decibels
• How to enter time strings in config files
  • Entering a time duration in seconds
  • Entering a time duration in milliseconds
  • Entering a time duration in minutes, hours, or days
• Case insensitivity in config files
• Device Control Events
  • If you have just one event
  • If you have multiple events
  • If you want to configure “delays” before performing your action
  • Messing with priorities
• Overwriting config files
• Specifying Colors in Config Files
  • Specifying opacity / alpha
• Understanding tags
  • General Theory
  • Tags and Events
  • Power of Tags
    • Example 1 - Pop Bumpers
    • Example 2 - Playfield is active
  • Reserved Tags in MPF
• Understanding the debug: setting
• Config player “express” configs
• How to add lists to config files
  • Valid options for lists
  • Valid options for “lists of lists”
• How to create and understand YAML files
  • Indentation
  • Dashes
  • Colons
  • Quotes
• Text Templates
  • Common format strings
    • Alignment and Padding
    • Truncating long strings