Skip to content

settings:

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 NO 🚫

The settings: section of your config is where you configure settings which are configurable in service mode.

This is an example:

settings:
  replay_score:
    label: Replay Score
    values:
      500000: "500000 (default)"
      1000000: "1000000"
      1500000: "1500000"
    default: 500000
    key_type: int
    sort: 100

Required settings

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

default:

Single value, type: string. Defaults to empty.

Default value to use if not changed or on reset. Must be included in values.

label:

Single value, type: string. Defaults to empty.

Label to use in service mode for this setting.

sort:

Single value, type: integer. Defaults to empty.

Sort in service mode.

values:

One or more sub-entries. Each in the format of string : string

Values for this setting in the format value: label. value will be assigned to the machine_var and label will be shown in service mode.

Optional settings

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

key_type:

Single value, type: one of the following options: str, float, int. Default: str

Type of the key. If you want to do math with the variable you need either float or int.

machine_var:

Single value, type: string. Defaults to empty.

Name of the machine variable to use. If this is not set it will use the name of this setting as machine variable.

settingType:

Single value, type: string. Default: standard

Help us write it!

This section is unwritten or needs an update or edit. Can you help write it? Get your name in lights and geeky pinball bragging rights! Hit the magic sparkly wand to the right of the title to see this page source on GitHub. Then add/edit and submit your change. It's easy!

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