Skip to content

mpf:

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 mpf: section of your config is where you configure global MPF settings.

Optional settings

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

allow_invalid_config_sections:

Single value, type: boolean (true/false). Default: false

MPF will not raise a fatal error when on invalid section when you set this to true. This might be useful when you are developing a new feature and do not want to constantly update config_spec (the file which describes allowed sections).

auto_create_switch_events:

Single value, type: boolean (true/false). Default: true

MPF will post switch_event_active and switch_event_inactive (see below) when this is enabled.

config_players:

Unknown type. See description below.

A list of config players which will be loaded.

core_modules:

Unknown type. See description below.

A list of core modules which will be loaded.

Single value, type: boolean (true/false). Default: false

Default value for whether ball search is enabled or disabled on all playfields (unless you overwrite it on that playfield).

default_light_hw_update_hz:

Single value, type: integer. Default: 50

Default light update hz. Can be overwritten per platform.

default_platform_hz:

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

For all non-tickless platforms we poll this often. This usually means how often we will read switches. Reducing this setting might reduce the amounts of CPU significantly. We recommand to keep this at least at 50Hz or you will loose switch hits. For smooth game play aim at 100Hz. Everything above that will mostly only reduce switch latency.

default_pulse_ms:

Single value, type: integer. Default: 10

Default default_pulse_ms for all coils when not overwritten. This will be used when you do not specify any pulse_ms in your coil.

default_show_sync_ms:

Single value, type: integer. Default: 0

Default sync_ms for all shows when not specified otherwise.

default_timed_enable_ms:

Single value, type: integer. Default: 0

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!

device_modules:

Unknown type. See description below.

A list of device modules which will be loaded.

paths:

Unknown type. See description below.

Paths for all additional files loaded in MPF.

platforms:

Unknown type. See description below.

A list of platforms which will be loaded.

plugins:

Unknown type. See description below.

A list of plugins which will be loaded.

report_crashes:

Single value, type: one of the following options: ask, never, always. Default: ask

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!

save_machine_vars_to_disk:

Single value, type: boolean (true/false). Default: true

If set to true MPF will persist machine_vars to disk in a background writer.

switch_event_active:

Single value, type: string. Default: %_active

If auto_create_switch_events is set to true this event will be posted after a switch turned active.

switch_event_inactive:

Single value, type: string. Default: %_inactive

If auto_create_switch_events is set to true this event will be posted after a switch turned inactive.

switch_tag_event:

Single value, type: string. Default: sw_%

This event will be posted for all tags after a switch turned active.

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