For all platforms, document and link number formats for

• switches
• matrix_lights
• coils
• leds

P-Roc (switches, leds, coils, matrix_lights):
a) WPC syntax
b) Custom; direct and matrix switches; lamp matrix
c) PDB syntax (optional)
P3-Roc (switches, leds, coils, matrix_lights):
a) PDB syntax
Snux (coils, switches):
Fast (switches, leds, coils, matrix_lights):
a) WPC
b) PDB syntax / fast syntax
OPP (switches, leds, coils, matrix_lights):
Fadecandy (leds):

Probably good to break out PDB and WPC (Partly here: http://docs.missionpinball.org/en/stable/machines/wpc.html) config styles.

@HarryXS Not sure what this problem might be, but when I follow the steps to test that video works in the RPi install instructions, I get a Kivy error that says it's looking for mpf_video_small_test.png even though I typed in mpf_video_small_test.mp4. The player still appears, but no video plays.

I've attached a screenshot. I ran it directly from the tests/machine_files/video/videos folder in this example, but I tried the full command as you wrote in the instructions, too.

By the way - nice find with KivyPie. I'm very hopeful that this will work!

Lots of research and I can't figure out how to do this, so I'm posting it here so I can remember to come back and look at it some other time. I want to add a few things:

• Logo
• Version of MPF that the PDF is for
• Note that the PDF is formatted for the screen, but we can generate versions for suitable for printing if people want them.

int_list is one.. possibly others

There is some kind of layout/CSS error/incompatibility in Chrome on Android that causes the majority of the page to be off the left side of the screen and no ability to scroll to see it. It makes it almost impossible to navigate to any other page and not possible to read the content. Working fine in Chrome on my desktop. I hate finding and fixing these device compatibility issues!

Screenshot attached:

Chrome 50.0.2661.89 on Android 6.0.1

Are there differences between Mac an PC?
Can some definitions be added for what each COM port refers to?

# ports for PC
ports: com3, com4, com5 

# ports for MAC
ports: /dev/tty.usbserial-1413B, /dev/tty.usbserial-1413C 

reference page:
http://docs.missionpinball.org/en/0.30/hardware/configuring_fast_hardware.html

The section: "What if your flippers coils only have one winding?" in the tutorial step 3 links back to itself with: 'make sure you’ve read our documentation on flipper devices_ for all the details about how that works.

The link to the macos installer on the page http://mpf.readthedocs.io/en/stable/install/mac.html is broken (link to https://missionpinball.com/Mission%20Pinball%20Framework.dmg)

Currently it only works to generate new RSTs.

Also make it automatically add "version added" and "deprecations"

Provide a way to test snippets in config. We should supply a few templates:

• Raw - Use just this snippet
• Machine - Basic machine config + this snippet
• Mode - Basic machine config with a mode and snippet in mode

Support a way to hide stuff from rendering in the docs which is needed for config validation.

Widgets documentations look complete (for example: http://docs.missionpinball.org/en/stable/displays/widgets/widget/image.html ) but some (most ?) pages are actually "only" the part inherited from the common widget. It has been quite confusing to me.

What about adding an information about that fact (like "inhereted from common" ) or removing the duplicated doc and giving a link to it ?

See here: http://tex.stackexchange.com/questions/341897/include-title-page-in-numbering-via-preamble-settings-only

Actually the problem with the PDF from RTD is they are off by more than one. They're off by the total number of pages in the TOC

ValueError: "slide_frame" is not a valid MPF display widget type.

Per this refactor, it would appear slide_frame has been replaced in v0.50.

I'd like to update the documentation for logic_blocks to correctly reflect the behavior of player_variable, but am uncertain as to where the documentation/code might be incorrect.

player_variable:

By default, the current "state" (or progress) of sequence logic blocks
are stored in a :doc:`player variable </game_logic/players/index>` called
*<counter_name>_count*.
For example, a logic block called "logic_block_1" would store its state
in a player variable called *logic_block_1_count*.

However, you can use the ``player_variable:`` setting to change this to
any player variable you want.

The main difference between the documentation and code is that the code only stores the logic block in a player variable if persist_state: true is set. Without persist_state, the variable is stored only internally to the logic block. However, any attempt to access a player variable automatically instantiates that variable, so to the user it may appear as though the player variable exists with a value of 0 when in fact it was only created by the attempt to access it. Unfortunately this player value will remain at zero while the logic block value changes, which can be confounding.

if self.config['persist_state']:
    if not player.is_player_var(self.player_state_variable):
        player[self.player_state_variable] = LogicBlockState(self.get_start_value())
    self._state = player[self.player_state_variable]
else:
  self._state = LogicBlockState(self.get_start_value())

I would like to update the documentation to reflect this behavior if it is the desired behavior, otherwise I would like to update the code to instantiate and maintain the default player variable. In either case, I'd also like to note in the documentation that the default player variable name ends in _state for all logic block types and that the value of the logic block is accessible for dynamic values via devices.<blocktype>.<name>.value.

The instructions for installing pypinproc 2.1 (http://docs.missionpinball.org/en/latest/hardware/multimorphic/mac.html) direct users to a system install. Given that the tutorial has you set up a virtualenv, makes more sense to install there, yeah?

INFO : SwitchController : <<<<< switch: s_left_inlane_e, State:1 >>>>>
ERROR : root : Can't convert 'NoneType' object to str implicitly
Traceback (most recent call last):
File "/usr/local/lib/python3.4/dist-packages/mpf/commands/game.py", line 130, in init
MachineController(mpf_path, machine_path, vars(args)).run()
File "/usr/local/lib/python3.4/dist-packages/mpf/core/machine.py", line 540, in run
self._run_loop()
File "/usr/local/lib/python3.4/dist-packages/mpf/core/machine.py", line 563, in _run_loop
self.process_frame()
File "/usr/local/lib/python3.4/dist-packages/mpf/core/machine.py", line 575, in process_frame
self.default_platform.tick(self.clock.frametime)
File "/usr/local/lib/python3.4/dist-packages/mpf/platforms/fast/fast.py", line 465, in tick
self.process_received_message(self.receive_queue.get(False))
File "/usr/local/lib/python3.4/dist-packages/mpf/platforms/fast/fast.py", line 141, in process_received_message
self.fast_commandscmd
File "/usr/local/lib/python3.4/dist-packages/mpf/platforms/fast/fast.py", line 236, in receive_nw_closed
platform=self)
File "/usr/local/lib/python3.4/dist-packages/mpf/core/switch_controller.py", line 249, in process_switch_by_num
self.process_switch(name=switch.name, state=state, logical=logical)
File "/usr/local/lib/python3.4/dist-packages/mpf/core/switch_controller.py", line 341, in process_switch
self.call_handlers(name, state)
File "/usr/local/lib/python3.4/dist-packages/mpf/core/switch_controller.py", line 400, in call_handlers
entry'callback'
File "/usr/local/lib/python3.4/dist-packages/mpf/devices/shot.py", line 486, in hit
group.hit(mode, profile, state)
File "/usr/local/lib/python3.4/dist-packages/mpf/devices/shot_group.py", line 136, in hit
self.machine.events.post(self.name + '' + profile + '' + state +
TypeError: Can't convert 'NoneType' object to str implicitly

config_version=4

shots:
left_outlane_t:
switch: s_kickback_t
show_tokens:
led: l_left_outlane_t
left_inlane_e:
switch: s_left_inlane_e
show_tokens:
led: l_left_inlane_e
right_inlane_c:
switch: s_right_inlane_c
show_tokens:
led: l_right_inlane_c
right_outlane_h:
switch: s_right_outlane_h
#profile: quick_flash
show_tokens:
led: l_right_outlane_h

shot_groups:
tech_lanes:
shots:
- left_outlane_t
- left_inlane_e
- right_inlane_c
- right_outlane_h

shot_profiles:
quick_flash:
states:
- name: unlit
show: off
- name: hit
show: quick_flash

shows:
quick_flash:
- leds:
(leds): white
- leds:
(leds): off

Under 'Config File Reference', related events should be added to appropriate entries. This will help people understand what events are created based on their config entry and how they relate.

Example... under 'score_reel_groups:', the following events are created for each entry:
scorereelgroup_(name)resync
scorereelgroup(name)rollover
scorereelgroup(name)_valid

This suggestion was discussed with Brian M (Sept 21.2016).

http://docs.missionpinball.org/en/stable/install/raspberry.html

This page is out of date. hold_power is now a decimal value between 0.0 and 1.0 that defaults to 0.0 - and results in the error "Cannot enable driver with hold_power 0.0" in that scenario.

Could there be a more reasonable default? Or is choosing any non-zero value potentially dangerous?

The PDF generated by RTD is pretty ugly. At minimum I'd like to:

1. Get rid of all the heading numbers (except maybe the H1s)
2. Change the fonts
3. Change heading formatting
4. Maybe something with images so they're not always maxed out?
5. Line justification is weird in a lot of cases. Implement word breaking or left justify.

Starting points here: http://stackoverflow.com/questions/9745854/sphinx-pdf-themes

Hi,
I tried to add aomething to the page:
https://github.com/missionpinball/mpf-docs/edit/latest/tutorial/3_get_flipping.rst

In line 53ff you can add Notepad++ like:
If you use Sublime or Notepad++ as your editor, it just
does this automatically. Other editors might require plugins. (For
example, you can add this functionality to Atom with a free package
called "autocomplete-plus".)

Maybe helpful to add Virtual Pinball (I'm using) in line 468ff:
7b. Using Virtual Pinball as "virtual" hardware

In case you are using Virtual Pinball the config file will look like:

.. code-block:: mpf-config

    hardware:
        platform: virtual_pinball

See also:
* :doc:`The Virtual Pinball (VPX) Platform </hardware/virtual/virtual_pinball_vpx>`

Currently they use some format that's different than the rest of the pages

The page numbers for the chapter headings are indented too far to the right.
Also the space between the chapter numbers and the words is too small for chapters 10 and higher.

http://docs.missionpinball.com/0.30/howto/display/animate_widgets.html

Has references to old "entrance" animation event which is not there anymore.

In file_shows.rst the example provided to demonstrate that MPF is case insensitive is incorrect and could be misinterpreted by the reader. The example provided compares 'YouShow.yaml' and 'yourshow.yaml'. The first example should be 'YourShow.yaml', the 'r' in your is missing.

From @Wolfmarsh:

When trying to define multiball_locks in the machine config, you get the following error: "Found a "multiball_locks:" section in config file C:\spaceballs\config\multiballs.yaml, but that section is not valid in machine config files."

According to the docs at http://docs.missionpinball.org/en/latest/config/multiball_locks.html it is valid in machine configs.

Now that fast, opp, and proc all have power filter boards with enable switches, we should probably add them to the docs.

To allow flexible ball save with add time via event/switch.

mpf-docs/events/extra_ball_group_name_lit.rst:29: WARNING: unknown document: extra_ball_lit_awarded
mpf-docs/game_logic/players/index.rst:63: WARNING: unknown document: /events/player_add_success
mpf-docs/game_logic/players/index.rst:65: WARNING: unknown document: /events/player_turn_start
mpf-docs/game_logic/players/index.rst:69: WARNING: unknown document: /events/player_turn_stop
mpf-docs/mechs/switches/index.rst:87: WARNING: unknown document: /events/sw_tag_name

Hi,
I just get an error with an wrong link. Could you please check and correct it. Appered because I did something wrong in the config.yaml file.

Using MPF v0.53.2 and VP 10.6.0

Wrong link that is shown:
https://docs.missionpinball.org/en/0.53/logs/CFE-ConfigValidator-6.html

Error message from MPF:
Shutting down...
Event: ======'shutdown'====== Args={}
Shutdown because of an exception:
Runtime Exception
Traceback (most recent call last):
File "c:\program files\python36\lib\site-packages\mpf\core\machine.py", line 765, in _run_loop
raise self._exception['exception']
File "c:\program files\python36\lib\asyncio\events.py", line 145, in _run
self._callback(*self._args)
File "c:\program files\python36\lib\site-packages\mpf\core\events.py", line 102, in _async_handler_done
future.result()
File "c:\program files\python36\lib\site-packages\mpf\core\device_manager.py", line 114, in _load_device_modules
await self.machine.mode_controller.load_mode_devices()
File "c:\program files\python36\lib\site-packages\mpf\core\mode_controller.py", line 90, in load_mode_devices
await mode.load_mode_devices()
File "c:\program files\python36\lib\site-packages\mpf\core\mode.py", line 438, in load_mode_devices
settings = device.validate_and_parse_config(settings, True, "mode:" + self.name)
File "c:\program files\python36\lib\site-packages\mpf\core\device.py", line 104, in validate_and_parse_config
self.config_section, config, self.name, "device", prefix=debug_prefix)
File "c:\program files\python36\lib\site-packages\mpf\core\config_validator.py", line 281, in validate_config
validation_failure_info=(validation_failure_info, k))
File "c:\program files\python36\lib\site-packages\mpf\core\config_validator.py", line 328, in validate_config_item
new_list.append(self.validate_item(i, validation, validation_failure_info))
File "c:\program files\python36\lib\site-packages\mpf\core\config_validator.py", line 757, in validate_item
return self.validator_list[validator](item, validation_failure_info=validation_failure_info, param=param)
File "c:\program files\python36\lib\site-packages\mpf\core\config_validator.py", line 477, in _validate_type_machine
6)
File "c:\program files\python36\lib\site-packages\mpf\core\config_validator.py", line 776, in validation_error
item, msg), 5 if code is None else code, self.log.name)
mpf.exceptions.config_file_error.ConfigFileError: Config File Error in ConfigValidator: Config validation error: Entry mode:base:shots:rollover_a:switch = "s_top_rollover_a" is not valid. Device s_top_rollover_a of type switches not defined Error Code: CFE-ConfigValidator-6 (https://docs.missionpinball.org/en/0.53/logs/CFE-ConfigValidator-6.html)
MPF run loop ended.

And link it everything where we use it

I'm just a beginner on MPF. Maybe I have overseen something on tags, then this issue is obsolate.

I think it would be good to have a "tag reference"-page for reserved tags with sections for

• Special-purpose tags: home, drain, trough, no-eject-on-ballsearch, aso.
• common tags for switches
  ...

Related links:
http://docs.missionpinball.org/en/latest/config/instructions/tags.html#reserved-tags-in-mpf
http://docs.missionpinball.org/en/latest/config/ball_devices.html#tags

The inline code is rendered with a different font, but it needs more to stand out, like a box around it or a gray background or something.

Seems to be that the more specific logic_block types are moving up to the root level of modes and logic_blocks are going away. Maybe this is only for modes? This came up here while trying to migrate a config from v0.33 to dev (v0.50). In any case, the content in this doc and those referencing it (accruals, counters, sequences) should be updated.

On the toc pages, there's a header which says "Overview" would should be removed.

The headers are coming from the first section (Overview), but really that section shouldn't start until after the TOC.

Example here:

And here:

This is just for the section names in the TOC

device --> playfield parts

Add a section called "electronics" to contain the stuff dealing with P-ROC, FAST, OPP, etc.

For single-would coils, there is a comment in the snippet for #P-ROC / P3-ROC only

It's unclear what the user should do if using another platform like FAST.

The page headings are the format CHAPTER NAME (Section).

But if there is no section, the parenthesis are still there since they're hard coded, like this:

I need to learn how to make it so the parentheses don't render if there is no section

Users tend to copy the mode without understanding overwrite in this context. See: https://groups.google.com/forum/#!topic/mpf-users/C6tdM4rkGTw

Great job with the docs guys. I just noticed that Pinball Life is spelled as 1 word on this page by the mechanical modern troughs.

https://github.com/missionpinball/mpf-docs/blob/latest/mechs/troughs/index.rst

Thanks!