Skip to content

show_config:

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 NO 🚫
mode config files NO 🚫

The show_config: section of your config is where you configure a show to play within a device.

See show_player: for more details about the settings.

Required settings

The following sections are required in the show_config: section of your config:

show:

Single value, type: string.

The show to play.

Optional settings

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

loops:

Single value, type: integer. Default: -1

How often should the show loop? -1 means forever.

manual_advance:

Single value, type: boolean (Yes/No or True/False).

Whatever, the show should advance manually only.

priority:

Single value, type: integer. Default: 0

Priority for this show. This is usually added to the mode priority if the device is defined within a mode.

show_tokens:

One or more sub-entries, each in the format of string : string Dict of show tokens to pass to the show.

speed:

Single value, type: number (will be converted to floating point). Default: 1

Speed multiplier for this show.

start_step:

Single value, type: integer. Default: 1

First step to play.

sync_ms:

Single value, type: integer.

See the Synchronizing multiple shows documentation for details.


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