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.

Developer Documentation

We talk a lot about how you don’t have to be an experienced software developer to use MPF. However, if you are an experienced developer, there are a few ways you can leverage your coding knowledge:

  • You can add custom code to your machine for parts of your game where you’d rather write “real” code versus using config files.
  • You can add custom code to handle unique and one-off hardware.
  • You can write Python-based unit tests to test your machine.
  • You can extend MPF to add features or to support new types of hardware.

Instructions for all of this, as well as an API reference, is available at the MPF Developer Documentation website: