Warning

This is the documentation the latest work-in-progress 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. This is probably ok, and means you’ll be on the latest, cutting-edge version of MPF.

However, if you want a more stable version, select the v:stable version from the lower-left corner of this page, which is the most recent version that is not getting new updates.

If you are new to MPF, we have recently rewritten the installation process which only applies to this “latest” 0.56, so you probably want to stay here because the prior installation process doesn’t work on the latest OS and Python versions.

Tools

There are several tools that have been created to help you build your game in MPF.

MPF Monitor

The MPF Monitor is a graphical utility you can use to interact with a running instance of MPF. See lights change in action, click to control switches, and lay out everything on an image of your playfield.

“Interactive” MC (or “iMC”)

The interactive MC lets you create YAML configurations for slides and widgets in realtime and see them on a display. This is great for fine tuning and tweaking your slides.

Service Cli

The MPF service cli is a fast way to debug or troubleshoot your machine during development and operation.

Build Production Configs

A command to prepare production config bundles.

Lightshow Creator

A lightshow generator for MPF.

Language Server in Your IDE

IDE support for your editor to support auto-complete for MPF configs.

MPF format

Reformat your MPF config files.

MPF test

Run single file tests to reproduce problems or verify behaviour.

MPF test

Commands to debug, upgrade or benchmark your hardware.

Machine Fuzzer

Fuzz your machine using afl to find crashes in MPF, your config or your code. Currently not documented. Let us know if you want to use it.

Hardware Debugger

The hardware debugger allows you to scan all your configured hardware platforms. In some cases it also supports firmware updates and configuration settings. See mpf hardware for details.

Future Tools

  • GUI config builder
  • Music builder / looper / manager
  • Show builder
  • Slide / animation tool
  • Auto machine documentation builder
  • Device / asset explorer (Why did this sound stop? Why is this LED red? etc)