Skip to content

Dashboard

Matthias Faust edited this page Jul 26, 2024 · 22 revisions

The VPin-Studio comes with an overlay app that can be bound to a key and invoked anytime the frontend is running.

The overlay app or dashboard gives you a brief summary about the "status" of your VPin. It includes the active competitions, player ranking and and latest scores, depending on the layout selected in the preferences.

The VPin Studio Dashboard

Overlay App

The dashboard can not only be bound to a key, but also be started as a separate game out of the frontend. For PinUP Popper, you have to perform the following steps for this.

  1. Open the Windows explorer and visit the installation folder of the VPin-Studio server.

  2. Right click the VPin-Studio-App.exe file and create a symbolic link.

  3. Copy the newly created link file into the game directory that is configured for you PC Games emulator. Make sure that the PC Games emulator is enabledi in Popper and also check if the symbolic link has the correct file suffix.

  4. Import the symoblic link as game into PinUP Popper

  5. Open Games Manager in PinUP Popper and filter for PC Games. The important configuration you have to set here is settings the field "Custom Launch Param" to "VPin Studio Overlay" !!!. PinUP Popper uses this parameter so that the app is properly terminated when the ESC key is pressed.

You can now add the game to a playlist (e.g. Home) and launch the PinUP menu. Configure the app in the media manager by adding proper wheel icon. You can download the following icon for this:

When done, your Popper game select should contain an entry like this and you can start and exit the dashboard overlay.

Dashboard Customization

While the dashboard itself cannot be customized, you can select from a list of predefined layouts in the preferences. Depending on the features you are using, different widgets are shown for each layout.

Dashboard Widgets

External Page

Embedding external pages into the dashboard is usedfull when you use a software like iScored. You can embed your iScored scoreboard then and show it together with the dashbaord.

Latest Highscore Widget

The latest highscores widget shows the recently created highscore, sorted by date.

Latest Highscore Widget

Player Ranking Widget

The player ranking widget calculates the players rank, depending on how namy first, second and third places the player has achieved.

Player Ranking Widget

The total score of the player is calculated by a certain amount of points for every score position. Additionally, the amount of competitions won by the player can also be taken into account.

These points can be customized in the Settings: Players Prefernces -> Ranking

Player Ranking Points

Offline / Online Competition Widget

The dashboard shows two type of competition widgets: offline competition and Discord (online) competition. The widgets shows all mandatory information about an active competition such as the name, start- and end-date and the current highscore.

When the widget is used on for the VPin overlay, the widgets shows an additionial row with the first place and some other additional data:

_Competition Widget Full View_

When used inside the VPin Studio, a compact view is used (the lower part is not visible):

_Competition Widget Compact View_
Clone this wiki locally