Skip to content

text_ui:

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 text_ui: section of your config is where you configure the Text UI that appears in the console while MPF is running.

The Text UI displays information about the machine and game: switch states, active modes, variable values, and game information. By default, it displays all machine variables and player variables.

Depending on the complexity of your game and the mode you're working on, you may not want the Text UI to display every variable. In that case, you can use the text_ui: section to specify which player and machine variables you want to see.

Optional settings

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

machine_vars:

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

A list of all of the machine variables to display and update in the Text UI. If the list is empty, no machine variables will be displayed.

If the machine_vars: setting is not included in your config, all machine variables will be displayed.

player_vars:

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

A list of all of the player variables to display and update in the Text UI.

While a game is active, MPF will always show three player variables: player number, ball number, and player score. If the player_vars: setting is provided, the variable names listed will also be shown in the Text UI.

If the player_vars: setting is not included in your config, all player variables will be displayed.

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