Mania - syd711/vpin-studio GitHub Wiki

The VPin Mania services offer various features for your VPin and the VPin community. In order to use them, you have to register your cabinet in the VPin Studio client. You can then login at https://app.vpin-mania.net/ The services include:

  • storing your highscores online
  • global player rankings
  • global table highscore rankings
  • tables ranked by popularity

This page describes both the client-side setup (registration, privacy, synchronization) and the services themselves.

Registering Your Cabinet

Before you can use any of the services, you need an account. Create one at https://app.vpin-mania.net/ and copy your API key from your account settings there.

In the VPin Studio, click the VPin Mania button in the header toolbar. If your cabinet isn't registered yet, you'll be asked to confirm registration and then to paste the API key. The registration dialog then shows:

  • I understand, register my cabinet. - confirmation checkbox that unlocks the rest of the dialog.
  • Existing Cabinets - if your account already has cabinets registered (e.g. you reinstalled the Studio), you can pick one from this list to re-link it instead of creating a new one.
  • Privacy Settings - Submit Table Ratings, Submit Play Count and Submit Installed Tables, all enabled by default. These can be changed later in Privacy Settings.
  • Player Registration - one checkbox per locally configured player, letting you register some or all of them as VPin Mania accounts so their highscores can be synchronized.

Confirm with Register Cabinet. Once registered, the VPin Mania header button opens the Mania settings window directly instead of prompting for registration again.

API Key Registration Dialog

Cabinet Settings

The Mania settings window opens on Cabinet Settings by default, showing your Cabinet UUID (with a copy button) and a Delete Cabinet action. Deleting a cabinet removes it and all data linked to it - highscores and registered players - from the VPin Mania services. This cannot be undone and requires an explicit confirmation checkbox ("I understand, delete my account.") before it's enabled.

Mania Settings Navigation

Your cabinet name and avatar are not configured here - they're taken from the Cabinet Name and Avatar fields in the main VPin Studio Preferences, which are automatically pushed to VPin Mania whenever you change them.

Privacy Settings

Once registered, a Data & Privacy Settings entry appears in the Mania settings navigation.

Data Submission

  • Submit All Highscores - submits your highscores to vpin-mania.net so they can be ranked. This is mandatory if you want to take part in tournaments. Turning it on prompts you to synchronize immediately; a Synchronize Highscores button lets you re-trigger it later.
  • Submit Installed Tables - pushes the list of your installed VPX tables to VPin Mania for quicker highscore lookups. Enables a nested option, Submit Table Ratings, which contributes your ratings to the global table ratings anonymously. A Synchronize Ratings button re-triggers the table/ratings sync on demand.
  • Submit Play Count - contributes anonymized play-count data to the global table ratings.

Activities

  • Show Online Status - lets other people see whether your cabinet is currently online.
  • Share Activity Status - lets other people see which table you're currently playing. This is only available if Show Online Status is enabled.
  • Cabinet Search Enabled - allows other people to search for your cabinet by its id.

Players Privacy

Shows your own cabinet card together with one row per locally registered Mania player, each with a Public Player toggle. When enabled, that player is visible and ranked on vpin-mania.net and their highscores can be merged with friends'. When disabled, the player's data stays private to your own cabinet.

Data & Privacy Settings

A note on Friends: earlier versions of the VPin Studio had a dedicated Friends view for inviting other cabinets and managing pending invites (see the old Friends Menu page). That view has been removed from the current client - the "Cabinet Search Enabled" toggle above is what remains of it. If you're looking for the friend-invite flow described on that page, it is currently not available.

Synchronizing Tables & Scores

Besides the buttons in Privacy Settings, you can synchronize per table from the table overview:

VPin Mania Context Menu Entries

  • Open VPin Mania Entry (right-click a table, or from the Highscores tab in the Table Sidebar) - opens the table's page on vpin-mania.net in your browser.
  • Synchronize Scores with VPin Mania - submits the highscore(s) of the selected table(s) right away. From the table sidebar, this also opens a VPin Mania Synchronization Results dialog listing every submitted score, its matched account and whether it was accepted, denied (e.g. on a deny list) or skipped (e.g. no matching table found).

VPin Mania Synchronization Results

Both actions require the table to have a matching Virtual Pinball Spreadsheet entry.

Player Ranking

The player ranking is a list of all registered players, ranked by their number one, two and three highscores. The list is calculated with the following scoring (subject to change):

  • First place on a table: 4 points
  • Second place on a table: 2 points
  • Third place on a table: 1 points

Players can only submit 1x highscore for every table. Multiple score submissions are not supported and not intended!!!

Table Ranking

The table ranking gives you an overview of all tables available on the virtual pinball spreadsheet and the current global ranking of highscores for them.

Note that not all tables have a wheel icon yet.

Table Statistics

The table statistics view gives you an overview of all tables available on the virtual pinball spreadsheet, grouped by the amount of submitted scores. This way, tables are listed by popularity.