Warning

This is the documentation the latest work-in-progress 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. This is probably ok, and means you’ll be on the latest, cutting-edge version of MPF.

However, if you want a more stable version, select the v:stable version from the lower-left corner of this page, which is the most recent version that is not getting new updates.

If you are new to MPF, we have recently rewritten the installation process which only applies to this “latest” 0.56, so you probably want to stay here because the prior installation process doesn’t work on the latest OS and Python versions.

Glossary of MPF terms

Here’s a list of terms you might come across in MPF. Note that this is not an exhaustive list of everything, rather, these are terms we use in MPF that might not be obvious.

display
A logical target which holds slides. Displays are abstract–purely logical. You use the machine config to map logical displays to the physical on-screen window or a DMD.
machine folder
The folder which holds your machine config files.
player variable
A named value that is stored on a per-player basis, such as the current ball number or score.
watch dog
A feature of a hardware control system that ensures you don’t blow anything up if MPF crashes. Essentially it’s a timer which runs on the hardware (typically set to a short amount of time, like 1 second) that has to be “pinged” by MPF constantly to reset the timer. If the timer runs out before its pinged, then the hardware system will shut off all power to its devices. In normal operation, MPF pings the watchdog constantly, but if MPF crashes or shuts down ungracefully, then the watchdog pings stop, the hardware timer expires, and the hardware controller shuts off all the power to the connected devices.
widget
A thing that is put on a display. There are different types of widgets, such as text, images, videos, shapes, etc.