Skip to content

high_score:

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 NO 🚫
mode config files YES ✅

The high_score: section of your config is where you configure the built-in high score mode. See High Scores for details.

Example section:

#config_version=5
high_score:
  _overwrite: True
  categories: !!omap
  - score:
      - GRAND CHAMPION
      - HIGH SCORE 1
      - HIGH SCORE 2
      - HIGH SCORE 3
      - HIGH SCORE 4
  - loops:
      - LOOP CHAMP
  - hits:
      - MOST HITS
  defaults:
    score:
      - BRI: 4242
      - GHK: 2323
      - JK: 1337
      - QC: 42
      - MPF: 23
    loops:
      - JK: 42
    hits:
      - A: 1
  vars:
    loops:
      - player: number
    hits:
      - player: number
      - machine: credits_string

Required settings

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

categories:

Ordered list for one (or more) sub-settings. Each in the format of string : list (Instructions for entering lists)

An ordered map of categories which contain a list of awards. See High Scores for an example.

Optional settings

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

award_slide_display_time:

Single value, type: time string (ms) (Instructions for entering time strings). Default: 4s

How long should the award slide be displayed?

defaults:

One or more sub-entries. Each in the format of string : list (Instructions for entering lists)

A map of categories with a list of player/score tuples. See High Scores for an example.

enter_initials_timeout:

Single value, type: time string (secs) (Instructions for entering time strings). Default: 20s

Timeout for the player to enter his/her initials.

reset_high_scores_events:

List of one (or more) events. The device will add handlers for those events. Default: high_scores_reset,factory_reset

Event to reset high scores. The default is used by the service mode.

reverse_sort:

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

A list of categories where the sort should be inverted. Usually the highest score is the best but sometimes you want the shortest time or least amount of shots to be the best score.

vars:

(Added in MPF 0.56.1)

One or more sub-entries. Each in the format of string : list (Instructions for entering lists) Defaults to empty.

By default player name/initials and value of high score entry are saved for later use in slides, such as in your attract mode. Adding additional values here allows for unique variables to be saved. These can include both player and machine variables.

Entered in the form of variable type: variable name (e.g., player: number)

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