Highscore Cards - syd711/vpin-studio GitHub Wiki

The term "frontend" in this section is used for PinUP Popper or PinballX.

The VPin Studio comes with a highscore card editor and generator. The highscore images are updated on every table start or exit if the user has generated a new highscore. If the table has not been exited before shutdown, the VPin Server will will re-check the highscore status, send Discord notifications if required and configured and re-generetes the highscore card.

The VPin Highscore Card Editor

The editor supports multiple editing options, like font types, font sizes, headlines and spacings. The check if the layout works, the editor provides a sample selectors which shows all tables that currently have a highscore.

Layer Editor

The card layout is built from independent layers, each with its own settings panel and an eye icon to toggle its visibility. Most layers share a position sub-editor (X/Y position, width/height, and horizontal/vertical alignment) which you can also adjust by dragging the layer directly on the card preview.

  • Background - a solid color, the table's default background, or a fallback image of your choice, with optional grayscale, alpha, brighten/darken and blur post-processing.

  • Frame - an optional border (size, radius, color) and margins around the card, plus zoom/pan controls for the background image and an optional frame overlay image.

  • Manufacturer - the manufacturer logo, with options to use the historical (year-appropriate) logo and to keep its aspect ratio.

  • Other Media - embeds one of the table's other frontend media screens (e.g. DMD, Topper, GameInfo) as an additional image on the card.

  • Overlay - plays a full-card video/image (e.g. a table's DMD screen) as an animated overlay while the card is shown.

  • Scores - the highscore list itself: font and color (with a separate color for friends' scores if VPin Mania social features are enabled), row spacing, maximum number of scores shown, and toggles for rendering raw/unformatted scores, friends' highscores, rank positions and score dates.

  • Table Name - font and color (or match the score color automatically), and whether to use the VPS name instead of the display name, optionally including manufacturer and year.

  • Title - a free-text title with its own font and color.

  • Wheel - size and position of the table's wheel icon (always kept square).

Use the "Apply selected font settings to all templates" option next to the Scores/Table Name/Title font pickers to copy a font choice across every template at once instead of one by one.

Note that for newly installed tables no highscore may be available until the table is played for the first time.

If you still miss a table here, check the "Tables" metadata section if the ROM name is configured properly and highscore data is available.

By default, the VPin Studio tries to resolve a default picture for every table. For more details about this resolving, see the Default Background section below.

The Default Background View

To enable the highscore generation, a valid frontend target screen must be selected in the preferences under Highscore Preferences -> Card Preferences.

If a screen has been selected, but the corresponding key binding isn't configured in PinUP Popper, an additional error messsage will be shown. In that case, open the PinUP Popper Config tool, select Popper Setup -> Controller Setup and add a key binding that matches the selected screen.

The card resolution is also configured here. It determines the output size of highscore cards and the background images extracted from backglass files and other media - changing it re-generates the default background of every table and may break existing highscore card layouts.

Highscore Card Resolution

Default Background

The "Default Background" section shows the background image that is used when a highscore card is generated for the table or when a competition image is generated. The default image is resolved in this order:

  • Check if the table is using a directb2s file. If the file is available, extract the background image from it.
  • If not directb2s file is found, the video or image of Popper's media configuration is taken from screen "Backglass". The VPin Studio Server extracts an image from the video if one is available there.
  • If none of the previous media is found, the PUP pack of the table (if available) is analyzed. If a default video for the backglass can be determined, an image is extracted from this video. (Because this can result in rather unexpected results, this is the last option).

Alternatively, the upload action can be used to set a default image manually.