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.

Using LEDs as display (display_light_player)

You can map any display to your playfield LEDs or any LEDs (e.g. a LED matrix) in your machine. This enables you to leverage any MC features and display them on any LEDs (or more specifically any lights) in your machine.

Video about display_light_player:

To use this in a show you can use this:

##! show: test_show
- display_lights:
    your_source_display:     # use any display defined in your machine
      lights: "*"            # map all lights. you can also use a tag
This example is tested to be valid MPF config. However, it is not integration tested.
##! show: test_show
- display_lights:
    your_source_display:     # use any display defined in your machine
      lights: "*"            # map all lights. you can also use a tag

Or standalone:

display_light_player:
  your_event:
    your_source_display:
      lights: "*"
This example is tested to be valid MPF config. However, it is not integration tested.
display_light_player:
  your_event:
    your_source_display:
      lights: "*"

Then map your lights to a position on the display:

lights:
  l_light1:
    number: 1
    x: 0.3595817467355206
    y: 0.026751757949132805
  l_light2:
    number: 2
    x: 0.34303657433971446
    y: 0.02873336964906857
This example is tested to be valid MPF config. However, it is not integration tested.
lights:
  l_light1:
    number: 1
    x: 0.3595817467355206
    y: 0.026751757949132805
  l_light2:
    number: 2
    x: 0.34303657433971446
    y: 0.02873336964906857

You can map those in the MPF monitor and then copy the locations using the script in tools/monitor_to_config.py or manually. You may need to adjust config names in the script (improvements welcome).

Usage in config files

In config files, the display light player is used via the display_light_player: section.

Usage in shows

In shows, the display light player is used via the display_lights: section of a step.

Config Options

See display_light_player: for config details.