Config file reference
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.
- accelerometers:
- accruals:
- achievements:
- achievement_groups:
- animations:
- assets:
- auditor:
- autofire_coils:
- ball_devices:
- ball_holds:
- ball_locks:
- ball_saves:
- bcp:
- bcp_connection:
- bcp_server:
- bitmap_fonts:
- blinkenlight_player:
- blinkenlights:
- bonus (mode_settings:)
- coil_overwrites:
- coil_player:
- coils:
- color_correction_profile:
- combo_switches:
- config:
- counters:
- counter_control_events:
- credits:
- custom_code:
- display_light_player:
- displays:
- digital_outputs:
- diverters:
- dmds:
- drop_target_banks:
- drop_targets:
- dual_wound_coils:
- event_player:
- extra_balls:
- extra_ball_groups:
- fadecandy:
- fast:
- fast_coils:
- fast_switches:
- flasher_player:
- flashers:
- flippers:
- game:
- gi_player:
- gis:
- hardware:
- hardware_sound_player:
- hardware_sound_systems:
- high_score:
- image_pools:
- images:
- info_lights:
- keyboard:
- kickbacks:
- kivy_config:
- led_player:
- light_stripes:
- light_rings:
- lisy:
- leds:
- lights:
- light_segment_displays:
- light_settings:
- light_player:
- logic_blocks:
- logging:
- machine:
- machine_vars:
- magnets:
- matrix_lights:
- mc_custom_code:
- mc_scriptlets:
- mode:
- mode_settings:
- modes:
- motors:
- mpf:
- mpf-mc:
- multiball_locks:
- multiballs:
- mypinballs:
- named_colors:
- open_pixel_control:
- opp:
- opp_coils:
- osc:
- p_roc:
- pd_led_boards:
- pin2dmd:
- pkone:
- player_vars:
- playfield_transfers:
- playfields:
- playlist_player:
- playlists:
- plugins:
- pololu_maestro:
- pololu_tic:
- psus:
- queue_event_player:
- queue_relay_player:
- random_event_player:
- raspberry_pi:
- rgb_dmds:
- rpi_dmd:
- score_queue_player:
- score_queues:
- score_reel_groups:
- score_reels:
- scriptlets:
- segment_display_player:
- segment_displays:
- servo_controllers:
- servos:
- settings:
- sequences:
- sequence_shots:
- shot_control_events:
- shot_groups:
- shot_profiles:
- shots:
- show_player:
- show_pools:
- shows:
- slide_player:
- slides:
- spinners:
- smart_virtual:
- smartmatrix:
- snux:
- sound_ducking:
- sound_loop_player:
- sound_loop_sets:
- sound_marker:
- sound_player:
- sound_pools:
- sound_system_tracks:
- sound_system:
- sounds:
- speedometers:
- spi_bit_bang:
- spike:
- spike_node:
- state_machines:
- steppers:
- step_stick_stepper_settings:
- switch_overwrites:
- switch_player:
- switches:
- system11:
- text_strings:
- text_ui:
- tic_stepper_settings:
- tilt:
- timed_switches:
- timers:
- track_player:
- trinamics_steprocker:
- twitch_client:
- variable_player:
- video_pools:
- videos:
- virtual_platform_start_active_switches:
- virtual_segment_display_connector:
- widget_player:
- widget_styles:
- widgets:
- window:
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