Skip to content

An extension for Visual Pinball players using PinUP Popper, provides highscore card generation, etc.

License

Notifications You must be signed in to change notification settings

syd711/vpin-extensions

Repository files navigation

VPin Extensions

VPin Extensions provides an easy generation of highscore cards for Visual Pinball tables running with VPX and PinUP Popper. A user interface allows you customize the size, color, fonts and design of highscore cards, which are generated everytime a highscore changes.

  • Overview
  • Installation
  • Configure Highscore Overlay
  • Configure Highscore Cards
  • Configure DOF Rules
  • Table Overview

Overview

This section gives a brief overview about the functionality provided by this project.

Configuration screen for highscore card generation.

Samples generated with the highscore card generator.

Additionally, the service runner provides the generation of a global highscore card which includes multiple tables. This overlay can be opend via configurable shortcut.

Configuration screen for overlay screen generation.

The DOF Event Rules sections allows to trigger DOF commands based on events emitted by the system or PinUP Popper:

Configuration screen for DOF rules.

The Table Overview gives an overview about all tables installed in PinUP Popper and their VPin Extensions support status.

Configuration screen for the table overview.

Installation

Check https://github.com/syd711/vpin-extensions/releases for latest releases and download the VPinExtensions.zip file there.

Copy the file next to your PinUP Popper (Baller) installation like shown below and extract the zip file there.

In the extracted VPinExtensions folder, execute the install.bat file via double-click.

Once the installation is completed (including a JDK download), the folder should look like this:

Configure Highscore Overlay

Configure Highscore Cards

The highscore card generation is enabled once a PinUP Popper screen has been selected. Currently, the screens Other2, GameInfo and GameHelp are supported. Be aware that if the VPin Extensions Service is started, existing media in the corresponding PinUP Popper folder will be overwritten. An additional warning of this is visible in the UI for this.

If no screen is selected, not highscore card is generation is disabled.

For testing the generator output, a sample table can be selected and the button Generate Sample Card will generate a sample highscore image and preview it in the right panel of the editor.

Be careful when selecting another background image. The selected image is not scaled or cropped in any form. It's recommend to select a matching size with a fix ratio of 16:9 or 4:1, because these are the ratios supported by the PinUP popper screen configuration.

Screen Setup in PinUP Popper

There is already a good documentation for this available at https://www.nailbuster.com/wikipinup/doku.php. The basic steps to show the generated highscore cards are explained here again nonetheless. The given screenshots are showing the setup where highscore cards are shown on the Other 2 screen.

Make sure that the screen is active in the global settings:

Also check that the screen is visible in the screen settings...

...and that the screen ratio matches the one selected for the card background image.

In the controller section, make sure that you have a shortcut defined for showing the highscore card.

If everything is configured properly, you can press the configured control for the "Show Other 2" screen and the generated highscore card should pop up (if already been generated!).

Configure DOF Rules

About

An extension for Visual Pinball players using PinUP Popper, provides highscore card generation, etc.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published