Mission Pinball Framework v0.57 User Documentation
latest

Overview

  • Start Here
  • Compatible Pinball Machines

Installation & First Steps

  • Installing MPF
  • Running MPF
  • Tutorial

MPF User Manual

  • Control Systems / Hardware
  • Pinball Mechanisms
  • Game Logic
  • Game Design
  • Displays & Graphics
  • Sound
  • Shows
  • Assets
  • Config Players
  • Machine Management
  • Tools
  • Testing Your Machine
  • Finalizing Your Machine
  • Flowcharts
  • Troubleshooting

Building Machines

  • Physically Building Pinball Machines

Examples

  • Example Config Files
  • Example Games
  • Cookbook

Reference

  • Config File Reference
  • Events Reference
  • Game Variable Reference
  • Machine Variable Reference
  • Player Variable Reference
  • Log Reference

Developer Documentation

  • Overview

About MPF

  • About this Documentation
  • FAQ
    • FAQ: General
    • FAQ: Installation
    • FAQ: Building your game
    • FAQ: Getting help
  • Glossary
  • Contributing to MPF
  • Contributing to MPF docs
  • MPF Versions
Mission Pinball Framework v0.57 User Documentation
  • Docs »
  • MPF FAQ
  • Edit on GitHub

Warning

This is the documentation the latest work-in-progress version of MPF!

This is the documentation for MPF 0.57, 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. You can always update to the latest at any time.

MPF FAQ¶

  • FAQ: General
    • Why does this project exist?
    • Isn’t using config files limiting?
    • Can I mix “real” code in with MPF config files?
    • Where does the name come from?
    • What pinball hardware does MPF work with?
    • Who’s behind this?
    • Is MPF stable?
    • Is MPF beta? When will v1 be released?
    • How can I download the documentation and read it offline?
    • What other options are there besides MPF?
  • FAQ: Installation
    • How do I get started?
    • What are the prerequisites?
    • What computer hardware do I need?
    • What Python version can I use with MPF?
    • Should I use the stable version or development version?
    • Where do I find information on older versions of MPF?
  • FAQ: Building your game
    • Where do I get help building my machine?
    • I want to do something that’s not in MPF. Now what?
  • FAQ: Getting help
    • Where can I go for help?
    • I think I’ve found a bug. Now what?
    • I want MPF to work with a new piece of hardware
Next Previous

© Copyright 2013-2023, The Mission Pinball Framework Team Revision 21b20d8e.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
0.55
0.54
0.53
0.52
0.51
0.50
0.33
Downloads
pdf
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.