<commit_before>Mission Pinball Framework |version| documentation
=================================================

.. toctree::
   :hidden:
   :caption: User Documentation

   Getting Started </start/index>
   Compatible Hardware </hardware/index>
   Compatible Pinball Machines </machines/index>
   Installation </install/index>
   Running MPF </running/index>
   Tutorial </tutorial/index>
   How to Guides / "Cookbook" </howto/index>
   Devices </devices/index>
   Game Logic </game_logic/index>
   Game Modes </modes/index>
   Displays, DMDs, & Graphics </displays/index>
   Sounds & Audio </sound/index>
   Shows </shows/index>
   Assets </assets/index>
   Config Players </config_players/index>
   Machine Management </machine_management/index>

.. toctree::
   :hidden:
   :caption: MPF Architecture

   Core Modules </core/index>
   Flowcharts </flowcharts/index>

.. toctree::
   :hidden:
   :caption: Developer Documentation

   Extending MPF with Custom Code </code/index>
   BCP Protocol </bcp/index>
   API Reference </api/index>

.. toctree::
   :hidden:
   :caption: Reference Material

   Events Reference </events/event_reference>
   Config File Reference </config/index>

.. toctree::
   :hidden:
   :caption: About MPF

   Documentation Authors </about/authors>
   License </about/license>
   FAQ </faq/index>
   Glossary </glossary/index>
   Contributing to MPF </contribute/index>
   MPF Version History </version_history/index>

Welcome! This is the documentation for the Mission Pinball Framework (MPF)
|release|, last updated |today|.

MPF is free & open source software you can use to run a real pinball machine,
whether it's a new "home brew" machine you built yourself or whether you want
to rewrite the rules for an existing commercial pinball machine. Read more
about MPF at `missionpinball.com <http://missionpinball.com/mpf>`_.

MPF has a lot of documentation. Here are some of the big parts you can explore
now. Or view the tree menu on the left (or the "hamburger" menu in the top menu
bar if you're on a mobile device).

:doc:`First Steps with MPF </start/index>`
------------------------------------------
Start here.

:doc:`Installing MPF </install/index>`
--------------------------------------
Getting MPF up and running on your computer.

:doc:`Running MPF </running/index>`
-----------------------------------
How to actually launch the MPF software

:doc:`Tutorial </tutorial/index>`
---------------------------------
Walks you through building a new game, getting flipping, setting the display,
a base mode, scoring, and playing.

:doc:`FAQ </faq/index>`
-----------------------
Answers to common questions about MPF & custom pinball machines

`API Reference & Developer's Guide <mpf.readthedocs.org/projects/mpf-api>`_
---------------------------------------------------------------------------
If you're a programmer or want to extend what's possible with MPF's config
files, the API / Developer's Reference is at api.missionpinball.com.

`Support Forum <https://groups.google.com/forum/#!forum/mpf-users>`_
--------------------------------------------------------------------
We have an active user support forum on Google Groups.

`Community & Social Media <https://missionpinball.com/community>`_
------------------------------------------------------------------
Follow us, get involved, get help.

:doc:`/contribute/index`
------------------------
Wanna help? We'd love it! (Even if you can't write code, you can help with the
documentation.)

:doc:`License & Copyright </about/license>`
-------------------------------------------
It's liberal and free. Go nuts!
<commit_msg>fixed api link<commit_after>Mission Pinball Framework |version| documentation
=================================================

.. toctree::
   :hidden:
   :caption: User Documentation

   Getting Started </start/index>
   Compatible Hardware </hardware/index>
   Compatible Pinball Machines </machines/index>
   Installation </install/index>
   Running MPF </running/index>
   Tutorial </tutorial/index>
   How to Guides / "Cookbook" </howto/index>
   Devices </devices/index>
   Game Logic </game_logic/index>
   Game Modes </modes/index>
   Displays, DMDs, & Graphics </displays/index>
   Sounds & Audio </sound/index>
   Shows </shows/index>
   Assets </assets/index>
   Config Players </config_players/index>
   Machine Management </machine_management/index>

.. toctree::
   :hidden:
   :caption: MPF Architecture

   Core Modules </core/index>
   Flowcharts </flowcharts/index>

.. toctree::
   :hidden:
   :caption: Developer Documentation

   Extending MPF with Custom Code </code/index>
   BCP Protocol </bcp/index>
   API Reference </api/index>

.. toctree::
   :hidden:
   :caption: Reference Material

   Events Reference </events/event_reference>
   Config File Reference </config/index>

.. toctree::
   :hidden:
   :caption: About MPF

   Documentation Authors </about/authors>
   License </about/license>
   FAQ </faq/index>
   Glossary </glossary/index>
   Contributing to MPF </contribute/index>
   MPF Version History </version_history/index>

Welcome! This is the documentation for the Mission Pinball Framework (MPF)
|release|, last updated |today|.

MPF is free & open source software you can use to run a real pinball machine,
whether it's a new "home brew" machine you built yourself or whether you want
to rewrite the rules for an existing commercial pinball machine. Read more
about MPF at `missionpinball.com <http://missionpinball.com/mpf>`_.

MPF has a lot of documentation. Here are some of the big parts you can explore
now. Or view the tree menu on the left (or the "hamburger" menu in the top menu
bar if you're on a mobile device).

:doc:`First Steps with MPF </start/index>`
------------------------------------------
Start here.

:doc:`Installing MPF </install/index>`
--------------------------------------
Getting MPF up and running on your computer.

:doc:`Running MPF </running/index>`
-----------------------------------
How to actually launch the MPF software

:doc:`Tutorial </tutorial/index>`
---------------------------------
Walks you through building a new game, getting flipping, setting the display,
a base mode, scoring, and playing.

:doc:`FAQ </faq/index>`
-----------------------
Answers to common questions about MPF & custom pinball machines

`API Reference & Developer's Guide <http://mpf.readthedocs.org/projects/mpf-api>`_
----------------------------------------------------------------------------------
If you're a programmer or want to extend what's possible with MPF's config
files, the API / Developer's Reference is at mpf.readthedocs.org/projects/mpf-api.

`Support Forum <https://groups.google.com/forum/#!forum/mpf-users>`_
--------------------------------------------------------------------
We have an active user support forum on Google Groups.

`Community & Social Media <https://missionpinball.com/community>`_
------------------------------------------------------------------
Follow us, get involved, get help.

:doc:`/contribute/index`
------------------------
Wanna help? We'd love it! (Even if you can't write code, you can help with the
documentation.)

:doc:`License & Copyright </about/license>`
-------------------------------------------
It's liberal and free. Go nuts!

{'fraction_non_alphanumeric': 0.22757862930916084, 'fraction_numerical': 0.0, 'mean_word_length': 2.323596531264263, 'pattern_counts': {'":': 0, '<': 81, '<?xml version=': 0, '>': 81, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1480940', 'n_tokens_mistral': 2043, 'n_tokens_neox': 1911, 'n_words': 712}