WOVP Integration ‐ World Of Virtual Pinball Challenges - syd711/vpin-studio GitHub Wiki

This articles describes how to setup the VPin Studio so that you can participate in World Of Virtual Pinball (WOVP) challenges. For this setup, you need a WOVP account, which you can create here: https://worldofvirtualpinball.com/

Get an API Key

In order to let you cabinet communicate with the WOVP website, you need an API key. You find this key by clicking on your profile and got to the settings.

There you find the API key section. Copy the key to your clipboard, and open the VPin Studio next.

Configure WOVP in Studio

Open the preferences in the VPin Studio and scroll down to the World Of Virtual Pinball section. On this preferences page you can paste the API key for all of you players. The integration supports up to five players, so you can also register account for your whole family and friends.

The preferences page has some additional settings. We strongly recommend to auto-subscribe to new tables and also to automatically reset highscores for the participated tables. Note that this highscore reset does not delete you highscores. When a table is used for a WOVP challenge and the scores are resetted, a backup is created first which you can restore at any time.

Configure Pause Menu

You highcores are submitted via the Pause Menu. We need to configure these next. Note that you find a link to the "Pause Menu Preferences" also on the preferences page of WOVP.

Before configuring the Pause Menu, make sure you have configured the controller bindings in the section Controller Setup.

When configuring the Pause Menu, take care of the preferences how screenshots are taken. Depending on your setup, you may only want to take a screenshot of the primary window (desktop mode) or from all screens. The important thing here, is that the screen contains the highscore you achieved.

Highscores are send to WOVP via screenshots. An AI analysis the screenshot for the numeric score value and submit them by identifying your account by the API key that was used.

Real DMD Support

If you have a read DMD on your cabinet, no screenshot can be taken from this of course. But thanks to the freezy DMD device software, the VPin Studio can grep grep the frames from the DMD and use these as screenshot. To allow the Studio to read these frame captures, you need to enable the network stream in the DMD Device preferences. You screenshots created in the pause menu should contain your DMD then too!

Configure Challenged Tables

Once everything is set up, you find the new competitions tab "WOVP competitions in the Competition area of the Studio.

Note that you do not need to add tables to the challenges yourself. The matching happens automatically and is explained in the next section.

You can always press the reload button on the WOVP competitions view to synchronize the view again!

Submit Scores

Highscores are submitted by the pause menu. Sending them is very easy. When you game is finished AND the highscore is visible on any screen, press the pause menu button. The pause menu takes a screenshot then and shows it in the WOVP pause menu item entry. You can submit it from the by pressing the start button. If you have multiple players set up, you can also choose for which player you would like to submit the score for.

Table Mapping and Troubleshooting

The matching between your tables and the tables that are competed on WOVP are linked by the Virtual Pinball Spreadsheet database: https://virtualpinballspreadsheet.github.io/

In order to detect if your cabinet has the corresponding table installed, the table needs to have the correct VPS mapping set! Below you find an example for JP's Deadpool. The VPS mapping matches with the one on the WOVP website, therefore the table is automatically "activated" and part of the challenges.

If you have selected the correct VPS entry and your table is still not matching, then you very likely have not downloaded the correct VPX file for this table. An additional check is performed on the script source of every table, if it matches with the one that is expected.

To sum this up. A table matches for the WOVP challenge if...

it has the correct VPS matching.
it has the correct table script / is the correct VPX file.