Skip to content

Commit

Permalink
updated README & links
Browse files Browse the repository at this point in the history
  • Loading branch information
toomanybrians committed Mar 24, 2023
1 parent 777af07 commit 35e94a9
Show file tree
Hide file tree
Showing 10 changed files with 37 additions and 43 deletions.
2 changes: 1 addition & 1 deletion AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ MPF is inspired by pyprocgame and skeletongame which were written by:
* Michael Ocean
* Josh Kugler

Want to contribute to MPF? Get started here: http://docs.missionpinball.org/en/latest/about/contributing_to_mpf.html
Want to contribute to MPF? Get started here: http://docs.missionpinball.org/about/contributing_to_mpf.html
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See: http://docs.missionpinball.org/en/dev/about/contributing_to_mpf.html
See: http://docs.missionpinball.org/about/contributing_to_mpf.html
38 changes: 16 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,30 +8,13 @@ Mission Pinball Framework (MPF)
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 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.
Mission Pinball Framework (MPF) is open source, cross-platform software for powering real pinball
machines. MPF is a community-developed project released under the MIT license. It's supported by volunteers in their spare time.

[![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 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
* CobraPin
* Stern SPIKE / SPIKE 2
* Multimorphic P-ROC or P3-ROC
* Open Pinball Project (OPP) open source hardware
* LISY Platform
* Penny K Arcade PKONE
* Arduino Pinball Controller
* Plus many more systems & devices!

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 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.

Documentation
Expand All @@ -43,13 +26,24 @@ Documentation
Support
-------

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.
MPF is an open source community project which has no official support. Some MPF users participate in the MPF-Users Google group: https://groups.google.com/forum/#!forum/mpf-users.

Individual pinball hardware companies may provide additional support for users of their hardware, often via their own Slack, Discord, or other chat groups. If you get stuck, you can ask for help in the MPF-users group, or you reach out to your hardware provider.

Maintenance, Pull Requests, & Bug Fixes
---------------------------------------

As a community project, we welcome pull requests and bug fixes. However, we do not have the resources to provide support for MPF. If you are interested in becoming a maintainer, please contact us at brian@missionpinball.org.

Bugs or other issues related to MPF itself can be posted to the [MPF Discussions page on GitHub](https://github.com/orgs/missionpinball/discussions).

Contributing
------------

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.
Individual pinball hardware makers are responsible for their own platform interface maintenance and contributions.

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/about/contributing_to_mpf.html)
and [Contributing Documentation](http://docs.missionpinball.org/about/contributing_to_mpf_docs.html) pages.

License
-------
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See: http://docs.missionpinball.org/en/latest/versions/release_notes.html
See: http://docs.missionpinball.org/versions/release_notes.html
4 changes: 2 additions & 2 deletions docs/code/machine_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ match up to any of MPF's built in devices. The elevator and claw unloader
in *Demolition Man* is a good example, and what we'll use here.

(You can read about how to download and run *Demo Man* in the
`example games section <http://docs.missionpinball.org/en/latest/example_games>`_
`example games section <http://docs.missionpinball.org/example_games>`_
section of the MPF User Documentation.)

Here's how to create a custom code class:
Expand All @@ -35,7 +35,7 @@ In the *Demo Man* example, it looks like this:
.. image:: /images/scriptlet.png

Add an empty ``__init__.py`` file into your folder to make it a package.
It become the package ``code`` and all your classes will be referenced as
It become the package ``code`` and all your classes will be referenced as
``code.file_name.ClassName``.

2. Open and edit your custom code class file
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/event_annotations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,5 @@ document the event in code and in the docs, we use a custom docblock annotation:
reason: The reason for this awesomeness is stated here.
'''
The event will be automatically added to the `event reference <http://docs.missionpinball.org/en/latest/events/index.html>`_
The event will be automatically added to the `event reference <http://docs.missionpinball.org/events/index.html>`_
on the next update of the documentation.
24 changes: 12 additions & 12 deletions docs/dev/mc.widget_player.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The widget player is available via: ``self.mc.widget_player``

Methods & Attributes
---------------------
``play(settings, context, calling_context)``
``play(settings, context, calling_context)``

``Add``, ``update`` or ``remove`` widget based on config

Expand Down Expand Up @@ -38,11 +38,11 @@ So here is our base ``widget`` from the config file that we will be using.
some_image_widget:
- type: image
image: this_image_is_wrong
y: 20
y: 20
x: 35
Refer to the widget section in the docs for more info on how to set it up:
http://docs.missionpinball.org/en/latest/displays/widgets/index.html
http://docs.missionpinball.org/displays/widgets/index.html

Writing the settings to show/play this widget in code
^^^^^^^^^^^^^^^
Expand All @@ -67,9 +67,9 @@ When it comes to the settings we start with the following:
}
}
You need to add ``action`` and ``key`` to make the ``widget`` work.
You need to add ``action`` and ``key`` to make the ``widget`` work.
Refer to the ``widget_player`` section for more info on these and what other functions can be added:
http://docs.missionpinball.org/en/latest/config/widget_player.html
http://docs.missionpinball.org/config/widget_player.html

Now you can show the pre-defined widget from the config file.

Expand All @@ -86,13 +86,13 @@ First we will define a ``variable`` which will hold our image name. (for example
character_name = some_function_for_retrieving_a_string()
image_name = “character_{}_profile_image”.format(character_name)
To keep things organized in the image folder we made a prefix for the image.
To keep things organized in the image folder we made a prefix for the image.
Make sure you add the images with the right syntax in the image folder.

The following code shows how to override an image and x-coordinate

.. code-block:: python
settings = {
"some_image_widget": {
"action": "add",
Expand All @@ -104,10 +104,10 @@ The following code shows how to override an image and x-coordinate
}
}
You can ``change``/``add`` everything this way from the related type of ``widget``, or the common settings for all widgets.
You can ``change``/``add`` everything this way from the related type of ``widget``, or the common settings for all widgets.
Refer to the common settings for a overview of all settings.

http://docs.missionpinball.org/en/latest/displays/widgets/common_settings.html
http://docs.missionpinball.org/displays/widgets/common_settings.html

Just make sure you format this way

Expand All @@ -127,7 +127,7 @@ Creating animation from predefined animations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The easiest thing is to change/add pre-defined animations.
See capther 9 of widget animation for more info on this:
http://docs.missionpinball.org/en/latest/displays/widgets/animation.html
http://docs.missionpinball.org/displays/widgets/animation.html

.. code-block:: python
Expand All @@ -149,7 +149,7 @@ http://docs.missionpinball.org/en/latest/displays/widgets/animation.html
Make sure that after defining the event you put the animations in a list ``[]``. And put every animation between brackets ``{}``.
``“named_animation”`` is called like that, you don’t need to change it in something else.
Creating/overriding animation from within the widget
Creating/overriding animation from within the widget
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When creating the animations within the widget, you want to make sure that you also want to create a list in here.
Expand Down
2 changes: 1 addition & 1 deletion mpf/modes/credits/config/credits.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ mode:
stop_on_ball_end: False

# Instructions on how to use this mode:
# http://docs.missionpinball.org/en/latest/game_logic/credits
# http://docs.missionpinball.org/game_logic/credits

# You can copy the sections below to your own machine config as a starting point

Expand Down
2 changes: 1 addition & 1 deletion mpf/modes/high_score/config/high_score.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ mode:
use_wait_queue: true

# Instructions on how to use this mode:
# http://docs.missionpinball.org/en/latest/game_logic/high_scores/index.html
# http://docs.missionpinball.org/game_logic/high_scores/index.html

high_score:
enter_initials_timeout: 60
Expand Down
2 changes: 1 addition & 1 deletion mpf/modes/tilt/config/tilt.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ mode:
stop_on_ball_end: False

# Instructions on how to use this mode:
# http://docs.missionpinball.org/en/latest/game_logic/tilt.html
# http://docs.missionpinball.org/game_logic/tilt.html

tilt:
tilt_warning_switch_tag: tilt_warning
Expand Down

0 comments on commit 35e94a9

Please sign in to comment.