Skip to content

widgets:

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 ✅

The widgets: section of your config is where you pre-define "named" widgets that you can then use later in shows and the widget_player section of a config file. See the Widgets guide for details. You can test slides and widgets interactively using Interactive MC (iMC).

Since there are many different types of widgets in MPF, it doesn't make sense to list all the widget type and all the options here. Instead check out the Widgets documentation which has all the details, including config file reference for different types of widgets.

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