Skip to content

Commit

Permalink
final updates for 0.56.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
toomanybrians committed Jan 16, 2023
1 parent 32903a7 commit 777af07
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 22 deletions.
31 changes: 15 additions & 16 deletions README.md
Expand Up @@ -9,21 +9,21 @@ What is Mission Pinball Framework?
----------------------------------

Mission Pinball Framework (MPF) is an open source, cross-platform software for powering real pinball
machines in restaurants, bars, arcades, and elsewhere. MPF is developed by fun people under the MIT license, and supported by a vibrant pinball-loving community. It is a work in progress we are actively developing. We review commits weekly.
machines in restaurants, bars, arcades, and elsewhere. MPF is a community-developed project released under the MIT license. It's supported by volunteers in their spare time. Individual pinball hardware makers are responsible for their own platform interface maintenance and contributions.

[![Coverage Status](https://coveralls.io/repos/missionpinball/mpf/badge.svg?branch=dev&service=github)](https://coveralls.io/github/missionpinball/mpf?branch=dev)
[![Test Status](https://github.com/missionpinball/mpf/actions/workflows/run_tests.yml/badge.svg)](https://github.com/missionpinball/mpf/actions/workflows/run_tests.yml)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1687/badge)](https://bestpractices.coreinfrastructure.org/projects/1687)


Technology and Compatibility
----------------------------

You can use MPF to power your own custom-built machine, or to update software in existing Williams, Bally,
Stern, or Data East pinball machines. MPF interfaces with machines via modern pinball controller hardware, including:
You can use MPF as the software to run a custom-built machine, or (with appropriate interface hardware) existing Williams, Bally, Stern, or Data East pinball machines. MPF interfaces with machines via modern pinball controller hardware, including:

* FAST Pinball controllers
* Multimorphic P-ROC or P3-ROC systems
* CobraPin
* Stern SPIKE / SPIKE 2
* Multimorphic P-ROC or P3-ROC
* Open Pinball Project (OPP) open source hardware
* LISY Platform
* Penny K Arcade PKONE
Expand All @@ -32,27 +32,26 @@ Stern, or Data East pinball machines. MPF interfaces with machines via modern pi

MPF is written in Python. It can be run on Windows, Mac, Linux, and Raspberry Pi host machines using the same code and configurations.

Visit the MPF project homepage at http://missionpinball.org.
Visit the MPF project homepage at https://missionpinball.org. Additional related projects exist as part of the MPF ecosystem, including the "MPF Monitor" which is a graphical application that lets you simulate pinball hardware, and "MPF-MC" which is a media controller which provides graphics and sounds for pinball machines.

<em>See also the [MPF Media Controller](https://github.com/missionpinball/mpf-mc/) (based on [Kivy](http://kivy.org)),
which is used to control graphics and sounds, including high-res LCD displays, classic DMDs, and modern RGB LED DMDs.</em>
Documentation
-------------

Installation and Documentation
------------------------------
* Getting started tutorial: http://docs.missionpinball.org/en/latest/tutorial/
* Installation: http://docs.missionpinball.org/en/latest/install/
* User documentation: http://docs.missionpinball.org
* Developer documentation: http://developer.missionpinball.org/
* User Docs (installation, tutorials, & reference): https://docs.missionpinball.org
* Developer documentation: https://developer.missionpinball.org/

Support
-------
Visit the user support forum at https://groups.google.com/forum/#!forum/mpf-users.

MPF is open source and has no official support. Some MPF users follow the MPF-users Google group: https://groups.google.com/forum/#!forum/mpf-users. Individual hardware providers may provide additional support for users of their hardware.

Contributing
------------
MPF is a passion project supported by an awesome pinball-loving community. If you're a Python coder, documentation writer, or pinball proponent, join the community! Drop us a line in the forum, or make a change and submit a pull request. For more information about contributing see the [Contributing Code](http://docs.missionpinball.org/en/latest/about/contributing_to_mpf.html)

MPF is a passion project created and maintained by volunteers. If you're a Python coder, documentation writer, or pinball maker, feel free to make a change and submit a pull request. For more information about contributing see the [Contributing Code](http://docs.missionpinball.org/en/latest/about/contributing_to_mpf.html)
and [Contributing Documentation](http://docs.missionpinball.org/en/latest/about/contributing_to_mpf_docs.html) pages.

License
-------

MPF and related projects are released under the MIT License. Refer to the LICENSE file for details. Docs are released under Creative Commons CC BY 4.0.
2 changes: 1 addition & 1 deletion mpf/_version.py
Expand Up @@ -10,7 +10,7 @@
"""

__version__ = '0.56.0-dev33'
__version__ = '0.56.0'
'''The full version of MPF.'''

__short_version__ = '0.56'
Expand Down
10 changes: 5 additions & 5 deletions pyproject.toml
Expand Up @@ -26,24 +26,24 @@ dependencies = [
"pyserial-asyncio == 0.4; platform_system=='Windows'",
"pyserial-asyncio == 0.5; platform_system!='Windows'",
"sortedcontainers == 2.3.0",
"psutil >= 5.7.3",
"psutil == 5.9.4",
"packaging",
]
dynamic = ["version"]

[project.optional-dependencies]
cli = ['prompt_toolkit==3.0.8', 'asciimatics==1.12.0', 'terminaltables==3.1.0',]
cli = ['prompt_toolkit==3.0.33', 'asciimatics==1.12.0', 'terminaltables==3.1.0',]
crash_reporter = ['requests==2.28.2']
irc = ['irc==19.0.1']
linux_i2c = ['smbus2_asyncio==0.0.5']
osc = ['python-osc==1.7.4']
pin2dmd = ['pyusb==1.1.0']
rpi = ['apigpio-mpf==0.0.3']
rpi = ['apigpio-mpf==0.0.4']
vpe = ['grpcio_tools==1.34.0', 'grpcio==1.34.0', 'protobuf==3.14.0',]
all = [ # currently no way to just use the names from above afaik?
'prompt_toolkit==3.0.8', 'asciimatics==1.12.0', 'terminaltables==3.1.0',
'prompt_toolkit==3.0.33', 'asciimatics==1.12.0', 'terminaltables==3.1.0',
'requests==2.28.2', 'irc==19.0.1', 'smbus2_asyncio==0.0.5',
'python-osc==1.7.4', 'pyusb==1.1.0', 'apigpio-mpf==0.0.3',
'python-osc==1.7.4', 'pyusb==1.1.0', 'apigpio-mpf==0.0.4',
'grpcio_tools==1.34.0', 'grpcio==1.34.0', 'protobuf==3.14.0',
]

Expand Down

0 comments on commit 777af07

Please sign in to comment.