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.


MPF Event

Starts game while bypassing the many systems which have to “approve” the start. (Are the balls in the right places, are there enough credits, etc.) Use of this method is not recommended but may be useful in testing code. Instead, use the request_to_start_game event.

Keyword arguments

(See the Conditional Events guide for details for how to create entries in your config file that only respond to certain combinations of the arguments below.)

A list of switches tagged with player that were held in when the start button was released. This is used for “alternate” game starts (e.g. hold the right flipper and press start for tournament mode, etc.)
The time, in seconds, that the start button was held in to start the game. This can be used to start alternate games via a “long press” of the start button.