Adding VPinballX.ini Tooltips - surtarso/vpx-gui-tools GitHub Wiki

Adding VPinballX.ini explanations to the Configuration GUI menu

1. Create a fork of this repository and edit src/utils/vpx_tooltips.h with any text editor.

2. Follow the structure of items already there.

3. Create a Pull Request.

4. Get a cookie.

Structure

[!IMPORTANT] This is the accepted structure

{"FlexDMDWindow",
       "Controls the visibility of the FlexDMD (Dot Matrix Display) window.\n"
       "0 - Turns the DMD window off: Disables the FlexDMD window, which is often used for displaying the score and game information.\n"
       "1 - Turns the DMD window on: Enables the FlexDMD window to display relevant game information. (Default is 1)"
},

• Every new variable explanation is a key-value pair in the VPX_TOOLTIPS map: {"<variable name>", "<explanation>"}
• Both the variable name and explanation must be quoted.

[!CAUTION] Make sure the variable name is EXACTLY like the vpinballx.ini, case sensitive, or it won't show up.

• End each entry with a comma " , " unless it’s the last entry in the map.
• Use \n to break to a new line within the explanation.

[!TIP] Use the find tool with the tooltip string so you don't add repeated values.