This is the dev documentation for an unreleased version of MPF!
This is the documentation for MPF 0.55+, which is the “dev” (next) release of MPF that is a work-in-progress. Unless you’re specifically looking for this version, you probably want to use the version of documentation called “latest” which is for the latest released version of MPF. That documentation is at docs.missionpinball.org/en/latest.
The widget player is a config player that’s used to add or remove widgets to existing slides on a display. (This player is part of the MPF media controller and only available if you’re using MPF-MC for your media controller.)
Full instructions on how to use the slide_player are included in the Widgets section of the documentation. The stuff here in the config reference is for reference later. You can test slides and widgets interactively using Interactive MC (iMC).
Generically-speaking, there are two formats you can use for widget_player entries: “express” and “full” configs. Express configs will look like this:
widget_player: event1: widget1 event2: widget2 event3: widget3
widgets: widget1:  widget2:  widget3:  widget_player: event1: widget1 event2: widget2 event3: widget3
Full configs will look like this:
widget_player: event1: widget1: <settings> event2: widget2: <settings> event3: widget3: <settings>
In both cases, these configurations are saying, “When event1 is posted, add widget widget1. When event2 is posted, add widget2. Etc.”
This “express” config is down-and-dirty, with no options, to just add widgets to the current slide on the default display. The full config lets you specify additional options (based on the settings detailed below).
For example, the following config will add widget_1 when some_event is posted, but it will also override the default settings and add widget to the slide called slide_2, even if that’s not the current slide that’s showing.
widget_player: some_event: widget_1: slide: slide_2
widgets: widget_1:  widget_player: some_event: widget_1: slide: slide_2
Usage in config files¶
In config files, the widget player is used via the
Usage in shows¶
In shows, the widget player is used via the
widgets: section of a step.