Config File Reference Index
This section contains details about every possible entry you can use in your YAML config files. Each entry also has information about whether it's valid in your machine-wide config, a mode-specific config, or both.
Instructions
As you dig into the specific settings for individual config sections, it's important to understand how various settings mentioned in the reference are used:
Index of config sections
Here's a list of every single config section from both MPF and the MPF-MC. Some of these are valid only in machine-wide configs, and others only work in mode config files. (And some are valid in both.) The detail page for each setting indicated which type of config file it's valid in.
Config Players:
For more info, see: "Config Players" Reference Index
These are a special type of MPF device that allow you to listen for events
and perform actions in response. Each config player is named for the type
of device that you control with it. For example, light_player is a config
player that lets you set light colors in response to events.
- blinkenlight_player:
- coil_player:
- display_light_player:
- event_player:
- flasher_player:
- light_player:
- queue_event_player:
- queue_relay_player:
- random_event_player:
- score_queue_player:
- segment_display_player:
- show_player:
- slide_player:
- sound_player:
- variable_player:
- widget_player:
Devices:
These are generally MPF device configs, or other very general settings.
- accelerometers:
- accruals:
- achievements:
- achievement_groups:
- assets:
- autofire_coils:
- ball_devices:
- ball_holds:
- ball_locks:
- ball_saves:
- bcp:
- bcp_connection:
- bcp_server:
- blinkenlights:
- coil_overwrites:
- coils:
- color_correction_profile:
- combo_switches:
- config:
- counters:
- counter_control_events:
- custom_code:
- displays:
- digital_outputs:
- diverters:
- dmds:
- drop_target_banks:
- drop_targets:
- dual_wound_coils:
- extra_balls:
- extra_ball_groups:
- flippers:
- game:
- hardware:
- info_lights:
- kickbacks:
- light_stripes:
- light_rings:
- lights:
- light_segment_displays:
- light_settings:
- logic_blocks:
- machine:
- machine_vars:
- magnets:
- mode:
- mode_settings:
- modes:
- motors:
- multiball_locks:
- multiballs:
- mpf:
- named_colors:
- player_vars:
- playfield_transfers:
- playfields:
- plugins:
- psus:
- rgb_dmds:
- score_queues:
- score_reel_groups:
- score_reels:
- segment_displays:
- servos:
- sequences:
- sequence_shots:
- shot_control_events:
- shot_groups:
- shot_profiles:
- shots:
- show_pools:
- shows:
- spinners:
- speedometers:
- state_machines:
- steppers:
- switch_overwrites:
- switches:
- text_ui:
- timed_switches:
- timers:
MPF Built-in configs
These configs relate to the optional modes that MPF provides that allow you to
have standard features you would expect from a pinball machine with minimal configuration,
such as attract mode, tilt handling, and credit management. Many of these features
depend on tags set on related devices, such as start on the start button switch.
Platform-specific Configs
While the previous configs listed are generic across the many platforms provided by MPF, all of these platforms need their own configurations, and some offer additional features on top of the standard devices already listed.
- fadecandy:
- fast:
- fast_coils:
- fast_switches:
- hardware_sound_player:
- hardware_sound_systems:
- kivy_config:
- lisy:
- mypinballs:
- open_pixel_control:
- opp:
- opp_coils:
- osc:
- p_roc:
- pd_led_boards:
- pin2dmd:
- pkone:
- pololu_maestro:
- pololu_tic:
- raspberry_pi:
- rpi_dmd:
- servo_controllers:
- smart_virtual:
- smartmatrix:
- snux:
- spi_bit_bang:
- spike:
- spike_node:
- step_stick_stepper_settings:
- system11:
- tic_stepper_settings:
- trinamics_steprocker:
- twitch_client:
- virtual_platform_start_active_switches:
- virtual_segment_display_connector:
Legacy MPF-MC Configs
Prior to MPF 0.80, the standard media controller was "mpf-mc". The MPF config files were used to configure the various audio and video effects played on the machine alongside the pinball device and mode configs listed above. Developers upgrading from pre-0.80 to GMC will need to replace the features implemented in these configs with equivalents in Godot or a custom media controller.
slide_player, sound_player, and widget_player are listed in the
"Config Players" section above, and they are very similar between pre-GMC
and GMC eras of media controller.
- animations:
- bitmap_fonts:
- image_pools:
- images:
- keyboard:
- mc_custom_code:
- mc_scriptlets:
- mpf-mc:
- playlist_player:
- playlists:
- slides:
- sound_ducking:
- sound_loop_player:
- sound_loop_sets:
- sound_marker:
- sound_pools:
- sound_system_tracks:
- sound_system:
- sounds:
- text_strings:
- track_player:
- videos:
- video_pools:
- widget_styles:
- widgets:
- window:
Deprecated Config Reference
These configs were available in earlier versions of MPF (generally pre-0.56), but are no longer supported. See the individual pages for information on their replacements.
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