Skip to content


This is a config file reference. Click for instructions.

This page is reference material which explains every setting and option for this section of an MPF yaml config file. See the instructions for config files for formatting and other details. See our guide to config file examples for more examples of real configs in action.

Valid in
machine config files YES ✅
mode config files YES ✅


This section can also be used in a show file in the lights: section of a step.

The light_player: section of your config is where you can control lights in config or shows. Example in config:

      color: red
      fade: 200ms
      color: ff0000
      fade: 2000ms
    - lights:
        (leds): red
    - lights:
        (leds): orange
    - lights:
        (leds): yellow
    - lights:
        (leds): green
    - lights:
        (leds): blue
    - lights:
        (leds): purple

Optional settings

The following sections are optional in the light_player: section of your config. (If you don't include them, the default will be used).


Single value, type: string. Default: white

Set a color to this light. Color values may be a hex string (e.g. 22FFCC), a hex string including a brightness value (e.g. 22FFCC%60), a color name (e.g. turquoise), or a brightness value (i.e. AA or 120). Note that a list of RGB values (e.g. [50, 128, 206]) cannot be used, these RGB values are only valid in the named_colors: section of your config file. MPF knows 140+ standard web color names, and you can define your own custom colors in the named_colors: section of your config. If you use brightness on an RGB light MPF will use the brightness for every channel. For instance brigness AA will result in color AAAAAA.

There is a special color stop which will remove the current light entry from the light stack and the current show will become transparent to underlying shows as if the light has never been used in this show.


Single value, type: ms_or_token. Defaults to empty.

Time to fade this light in ms. Use this to achieve smooth transitions between colors.


Single value, type: int_or_token. Default: 0

Relative priority of this entry in the light stack.

Something missing or wrong? You can fix it!

This website is edited by people like you! Is something wrong or missing? Is something out of date, or can you explain it better?

Please help us! You can fix it yourself and be an official "open source" contributor!

It's easy! See our Beginner's guide to editing the docs.

Page navigation via the keyboard: < >

You can navigate this site via the keyboard. There are two modes:

General navigation, when search is not focused:

  • F , S , / : open search dialog
  • P , , : go to previous page
  • N , . : go to next page

While using the search function:

  • Down , Up : select next / previous result
  • Esc , Tab : close search
  • Enter : go to highlighted page in the results