Skip to content

show_pools:

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 show_pools: section of your config is where you configure a pool of shows. When used one of the shows is selected from the pool based on a configurable pattern called type.

This is an example:

#! shows:
#!   show1:
#!     - duration: 1
#!   show2:
#!     - duration: 1
#!   show3:
#!     - duration: 1
show_pools:
  group1:
    shows:
      - show1
      - show2
      - show3
    type: random

Required settings

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

shows:

List of one (or more) values, each is a type: string name of a shows: device. Defaults to empty.

A list of shows which are part of the show pool

Optional settings

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

type:

Single value, type: one of the following options: random, sequence, random_force_next, random_force_all. Default: sequence

How the next show is selected. See Assets 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