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.

Shows

In MPF, shows are containers that hold steps of instructions for things that can be “played” in a certain order with specific timings.

You can do almost anything in a step in a show, including setting the color of LEDs, playing sounds, showing slides on the display, posting events, firing drivers, etc.

You’re going to use shows a lot.

Note

Prior to MPF 0.30, “light shows” and “display shows” were two independent things. In MPF 0.30+, shows are now universal. There’s only one type of show, and it can be used to do anything.

Shows are controlled and run by the MPF game engine, and if a show contains actions in a step for the media controller, such as display or sound actions, then those actions are sent via BCP to the media controller when that step is played.

Shows are configured via the YAML formatting just like config files. You can add the definitions for simple shows into your config files directly, or you can create standalone shows files that you store in your machine’s`shows` folder.

It is totally viable to create simple shows by hand. However, there is a MPF Showcreator to create complex light shows.

Read on for more info on how shows work:

You should have a look at Config Players to find more information about all the elements which are possible in shows (i.e. lights, slides, widgets or sounds).

Videos about shows: