User documentation for the Mission Pinball Framework.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_doc_tools explain priorites in event handlers Dec 24, 2018
_not_updated_yet document multiballs with multiple lock devices Dec 28, 2018
_static Show version in title, not sidebar May 10, 2017
about Fix some documentation typos Oct 31, 2018
assets Add bitmap fonts to docs Apr 27, 2018
config Merge pull request #195 from colemanomartin/patch-9 Jan 9, 2019
config_players document subscribed config players Dec 12, 2018
cookbook Replaced my email with the link to the forum post Oct 27, 2018
developer moved api and dev docs to new developer site May 8, 2017
displays more details about multi display setups Dec 9, 2018
events/overview example for conditionals in log Jan 9, 2019
example_games Various 0.50-related doc updates Dec 5, 2017
faq drop Python 3.4 support Sep 13, 2018
finalization eject_timeouts tuning for ball_devices Sep 24, 2018
flowcharts document more stuff May 30, 2018
game_design document multiballs with multiple lock devices Dec 28, 2018
game_logic fix warning Jan 19, 2019
glossary added watch dog to the glossary Nov 9, 2016
hardware Merge pull request #198 from aaronmatthies/patch-2 Jan 13, 2019
install Update windows.rst Oct 21, 2018
machine_management add todos and references Dec 14, 2017
machine_vars updated machine vars Jul 12, 2017
machines update existing machines section Aug 4, 2018
mechs document up-down ramps Jan 20, 2019
player_vars fix link Dec 10, 2017
running fix link Sep 2, 2018
shows Merge pull request #190 from colemanomartin/patch-8 Dec 14, 2018
sound more snippets Apr 16, 2018
start document virtual segment displays and move all displays stuff to one … Dec 7, 2018
testing add todos and references Dec 14, 2017
tools document device_size in monitor Dec 1, 2018
troubleshooting add tutorial on troubleshooting yaml files Dec 16, 2018
tutorial restructure tutorial and link yaml debugging Dec 16, 2018
versions fix formatting Nov 24, 2018
.editorconfig added rst .editorconfig Nov 4, 2016
.gitignore revert gitignore changes Oct 27, 2018
.travis.yml test show and slide player Apr 15, 2018
LICENSE.md Added license & cleaned up appveyor config Apr 21, 2016
Makefile add make unit target for config tests Jul 14, 2018
MpfDocsTestCase.py changed config and show versions from 4 to 5 Jul 11, 2017
README.md Add instructions for building docs locally Mar 20, 2018
conf.py increase version of mpf Nov 24, 2018
index.rst document virtual segment displays and move all displays stuff to one … Dec 7, 2018
make.bat Added initial sphinx config Mar 26, 2016
not_updated_yet.rst some more snippets under test Apr 16, 2018
requirements.txt correct requirements Nov 24, 2017
setup.py add empty setup.py to make RTD happy Nov 24, 2017

README.md

Mission Pinball Framework Documentation (mpf-docs)

This repo is the documentation for the Mission Pinball Framework.

Docs are hosted by Read the Docs at http://docs.missionpinball.org. You can download PDF, HTML, and Epub versions.

The "latest" branch of these docs corresponds to the latest released branch recent version of MPF. (We note which features have been added, changed, and removed as needed.)

Building Docs Locally

You can build the docs using Sphinx. You will first need to install Python 3.x and pip. Then add these libraries:

pip install sphinx
pip install gitpython
pip install sphinx_rtd_theme

Compile the docs to ./_build/html/ with the command:

make html

Licensing

These docs are licensed CC BY 4.0. MPF and all code licensed MIT.