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.

Compatible Pinball Machines

If you haven’t done so already, be sure to read the MPF Overview page to understand how MPF talks to physical pinball machines.

There are three options when it comes to using MPF with a pinball machine:

  • Build your own new machine completely from scratch.
  • Rewrite the rules for an existing machine, which means you don’t change the physical hardware at all, rather, you just update the software.
  • “Retheme” an existing machine, which means you reuse all of the mechanical and electrical components of an existing machine, but you strip down and replace all the artwork to transform it into something else. (And you rewrite all the rules for your new theme.)

Here are more details on each option. The “rewrite the rules” and “retheme” options above are combined below into the “controlling an existing machine” section: