Mission Pinball Framework: Open source software to run a real pinball machine.
Python Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Mission Pinball Framework (mpf)

Let's build a pinball machine!

The Mission Pinball Framework (MPF) is an open source, cross-platform, software framework for powering real pinball machines.

MPF is written in Python 3. It can run on Windows, Mac, and Linux using the same code and configurations.

MPF interacts with real, physical pinball machines via modern pinball controller hardware such as the Multimorphic P-ROC or P3-ROC, FAST Pinball controllers, Open Pinball Project (OPP) open source hardware, or Stern SPIKE pinball machines. You can use it to power your own custom-built machine or to update the software in existing Williams, Bally, Stern, or Data East machines.

There's also an MPF Media Controller (based on Kivy) which is used to control graphics and sounds, including high-res LCD displays, classic DMDs, and modern RGB LED DMDs.

MPF is a work-in-progress that's not yet complete, though we're actively developing it and checking in several commits a week. It's MIT licensed, actively developed by fun people, and supported by a vibrant pinball-loving community.

The MPF project homepage is here : http://missionpinball.org

Coverage Status Build Status Build status Code Health CII Best Practices

Installation, Documentation, and Examples

Support

We have a user support forum at : https://groups.google.com/forum/#!forum/mpf-users

Authors & Contributing

MPF is a labor of love awesome pinball-loving people. There's a list of authors in the AUTHORS file. We'd love for you to join us! Even if you don't know Python well, you can help improve the documentation or write how to guides. Drop us a line in the forum, or make a change and submit a pull request! More info about Contributing Code and Contributing Documentation.

License

  • MPF and its related projects are released under the terms of the MIT License. Please refer to the LICENSE file for details.
  • Docs are Creative Commons CC BY 4.0.
  • Both of these basically mean you can do anything you want with MPF and the docs, including using them for commercial projects. You don't have to pay us or share your changes if you don't want to. Just go make pinball!