Skip to content

Latest commit

 

History

History
164 lines (134 loc) · 5.09 KB

index.rst

File metadata and controls

164 lines (134 loc) · 5.09 KB
Raw

Start Here </start/index> Compatible Pinball Machines </machines/index>

Installing MPF </install/index> Running MPF </running/index> Tutorial </tutorial/index>

Control Systems / Hardware </hardware/index> Pinball Mechanisms </mechs/index> Game Logic </game_logic/index> Game Design </game_design/index> Media Controllers & MPF-MC </mc/index> Displays & Graphics</displays/index> Segment Displays</segment_displays/index> Sound</sound/index> Shows </shows/index> Assets </assets/index> Config Players </config_players/index> Machine Management </machine_management/index> Tools </tools/index> Testing Your Machine </testing/index> Finalizing Your Machine </finalization/index> Flowcharts </flowcharts/index> Troubleshooting </troubleshooting/index>

Example Config Files </examples/index> Example Games </example_games/index> Cookbook </cookbook/index>

Config File Reference </config/index> Events Reference </events/index> Player Variable Reference </player_vars/index> Machine Variable Reference </machine_vars/index>

Overview </developer/index>

About this Documentation </about/index> FAQ </faq/index> Glossary </glossary/index> Contributing to MPF</about/contributing_to_mpf> Contributing to MPF docs</about/contributing_to_mpf_docs> MPF Versions </versions/index>

Mission Pinball Framework Documentation

This is the documentation for the Mission Pinball Framework (MPF), version . Click the "Read the Docs" link in the lower left corner for other versions.

Note

You can download PDF, Epub, and HTML versions of these docs. Click the "Read the Docs" link in the lower left corner for the links.

Overview

  • MPF Overview </start/index>: What MPF is and how it works.
  • MPF Versions </versions/index>: Understanding MPF versions & features.
  • Compatible Pinball Machines </machines/index>: What types of machines work with MPF?
  • Supported Hardware </hardware/index>: What types of pinball control systems work with MPF?

Installation & First Steps

  • /install/index: How to download and install MPF.
  • /tutorial/index: Step-by-step beginner's guide.

MPF User Manual

  • /mechs/index: switches, coils, lights, troughs, flippers, etc.
  • /game_logic/index: modes, scoring, multiballs, ball saves, etc.
  • /displays/index: DMDs, LCDs, slides, widgets, animations, text, etc.
  • /segment_displays/index: 7-segment displays and other segment displays
  • /mc/index: The MPF Media Controller (MPF-MC), the Unity 3D Backbox Server, creating your own MC
  • /sound/index: sound tracks, music, volume, sound effects
  • /shows/index: sequences of lights, sounds, slides, etc.
  • /assets/index: videos, images, animations, sound files

Examples

  • /examples/index: Huge list of example config files you can learn from.
  • Example Games </example_games/index>: List of several example machine projects.
  • The Cookbook </cookbook/index> shows you how to implement features of real pinball machines using MPF. This is great for the "How do I build something like X?" questions you might have.

Reference Guides

  • /events/index: All the standard events MPF has, and how to use them.
  • /config/index: Lists every config setting and all the options.
  • /player_vars/index: Lists all the built-in player variables and parameters.
  • /machine_vars/index: Lists all the standard machine variables.

Developer Documentation

  • /developer/index

Getting Help

About MPF

  • /about/index
  • /about/authors
  • /about/contributing_to_mpf
  • /about/contributing_to_mpf_docs
  • /about/license

Follow us

Let's go!

You can access the full table of contents of MPF documentation via the expandable menu on the left (or the hamburger menu icon if you're on a mobile device). There are over 1100 pages of printed documentation and examples to help you build your pinball machine!