Skip to content

MPF command-line utility

When you install MPF, it registers an executable called mpf and puts it in your system path. Everything you do with MPF will use this tool from the command line.

Simply running mpf by itself will start the MPF game engine and run whatever machine configuration is in the current folder. But you can also use mpf to launch other things, like mpf mc to start the media controller, or mpf migrate to migrate your config files to the current version of MPF.

A full list of all the available commands, along with the various command line options, is here.

Command line options


Prints the version of MPF and exits:

$ mpf --version
MPF v0.xx.yy

Runs the MPF command (with or without additional options).

See the commands/index documentation for options.

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