Skip to content

MPF Tutorial

Let's learn by example!

This tutorial will walk you through using MPF to create a basic pinball machine config. Since MPF is just software that supports lots of different physical hardware, you don't actually need to have physical pinball machine hardware to complete the tutorial. You can create a "virtual" pinball machine for now and then hook up a real machine later.

The tutorial includes:

  • Configuring switches, coils, flippers, sling shots, and your trough.
  • Starting and playing a complete game with multiple players.
  • Setting up attract mode light and display shows.
  • Basic scoring and defining shots and lights.
  • Using the display to show what's happening and the score.
  • Setting up a "base" game mode.

The idea is that everyone should follow the tutorial, and complete every step, in order. (The tutorial steps all build off the previous steps.) Once that's done, you can then move browse through the rest of the documentation to read specific "How To" guides for everything else you need. (These are in the Control Systems / Hardware, Pinball Mechanisms, Game Logic, Displays & Graphics, Sound, and Shows sections.)

If you want to see us work through the tutorial you can also watch our walk-through video:

Now let's get started...

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