iScored - syd711/vpin-studio GitHub Wiki
The iScored integration of the VPin Studio allows you to automatically submit highscores to the game room of your or your friends' iScored account.
iScored Table Lineup
In oder to use iScored, the administrator of a competition first has to set up the line up of tables inside the iScored administration view:
The configuration of the lineup itself is pretty easy and well documented in iscored.info. The important part here are the tags.
An iScored table is linked with your cabinet VPX table though the Virtual Pinball Spreadsheet mapping.
To configure this mapping, you have to copy the VPS link of a table into the tags field of the iScored table. You find the copy button for this URL in various parts of the VPin Studio.
Do not copy the original VPS URL from the browser. Only the VPin-Studio URLs contains the table version(!) information.
Table Asset Manager
Use these actions to copy the correct VPS table URL:
VPS Section
VPS Table Overview Details
In case you have the table not installed yet, you can also copy the link from the VPS table overview:
iScored Options
In order to allow the score submissions, make sure that the game room is public and public score entries are allowed. Also remember the public URL of the game room.
VPin Studio Setup
You can now use the public game room URL for iScored subscriptions and tournaments. Open the preferences and go to the iScored game rooms section.
Add a new game room and paste the URL into the game room URL field. Make sure that there are no validation errors. If you select the "Synchronization" checkbox, all games room games will be automatically synchronized with the tables on your cabinet. This way, you don't have to deal with the subscription. The server will take care of that.
In addition to that, the playlist manager provides a template for iScored competed tables. You can select the template for SQL playlists in the playlist manager.
Disabling Tables
If you want temporarily disable the score submission to iScord for a specific table, you can add the tag vps:disabled to the list of tags in the lineup section of iScored. The VPin Studio will ignore score submissions when this flag is set.
Single Score Submissions
If you want to allow only score submission for a table for every user, you can add the tag vps:singlescore to the list of tags in the lineup section of iScored. The VPin Studio will check if the user has an existing score and will post no further updates until the flag has or the existing highscore has been removed.
Multi Score Submissions
iScored allows a player to submit multiple scores. If you want to multi-score submission for a table for every user, you can add the tag vps:multiscore to the list of tags in the lineup section of iScored. The VPin Studio will skip the check if the user has an existing score then.
My highscores are not submitted to the iScored Game Room!
The highscore submission to iScored may fail for various reasons.
- You need to create a new highscore. So once you see the highscore on the newly generated highscore card or you see the corresponding notification on table exit, the iScored highscore submission is triggered too.
- The highscore submission to iScored is skipped if you already have a higher score on the Game Room board and the multi-scoring is not enabled (default)...
- or the highscore submission to iScored is skipped if only a single score submission is allowed.
- The table's VPS mapping does not map with the VPS url the Game Room table is tagged with.
For an easier troubleshooting, go to the table overview and select Event Log from the table you want to check the highscore for. It will show the log of the last "session" with this table and should reveal why or why not a score was posted to iScored.