Warning

This is the dev documentation for an unreleased version of MPF!

This is the documentation for MPF 0.56+, which is the “dev” (next) release of MPF that is a work-in-progress. Unless you’re specifically looking for this version, you probably want to use the version of documentation called “latest” which is for the latest released version of MPF. That documentation is at docs.missionpinball.org/en/latest.

How to download the mpf-examples bundle

We maintain a GitHub repo called mpf-examples which contains a few different example MPF configs and some templates you can use.

The mpf-examples repo doesn’t have an installer, rather, you just download it and unzip it and start using the stuff it contains.

Each software repo in GitHub has several “branches”. (Think of branches kind of like versions.) The mpf-examples repo has multiple branches that each match a specific version of MPF. For example, the 0.21 branch of the mpf-examples repo is for MPF 0.21, the 0.30 branch is for MPF 0.30, etc.

Here are the direct links (to ZIP files) for the various branches of mpf-examples that you can download based on your version of MPF:

If you are looking for another version please switch to the documentation of that MPF version.

Unzip the file to any location you want, and then browse the files to see what’s there, or open a console window to launch MPF and/or MPF MC in each folder.

demo_man

Williams Demolition Man. This config is pretty basic, but you can play complete games and it has some simple shots, scoring, and modes. It also contains custom code to run the Cryro Claw. See details which explain how to “play” this game on your computer here.

mc_demo

A machine config that demonstrates several capabilities of the MPF Media Controller (MPF-MC). Details here.

tutorial (and several tutorial_step_XX folders)

Contains the config files used in the MPF Tutorial.

wpc_template

A template config you can use for WPC machines (with either a P-ROC or FAST WPC controller).