Table Backups - syd711/vpin-studio GitHub Wiki
The Studio comes with it's own backup manager for VPX files. The backup manager works independently from the frontend and can be used by PinUP Popper and PinballX/Y users.
Note that the backups are only allowed for private backups. DO NOT SHARE OR PUBLISH THESE ARCHIVES.
Backups Overview
Authentication Providers
Before backups can be used, you have to configure an authentication provider which can be VPU or VPF. The authentication against one of these portals ensures that you backups have a unique signature. This should ensure that backups are not shared to the public. Once one of the providers is configured, all backup options are available.
Authentication Provider Selection
Backup Folders
The VPin Studio Server has one default backup folder where tables are exported to. It is located under ./resources/vpa in the installation folder of the VPin Studio Server. When the repository view is opened, this repository is selected by default:
Default Backup Folder
Additional backup folders can be configured in the preferences. The default folder is also listed there, but is not configurable. But if you plan to copy you backups to an USB stick, you can add the device data there and the Studio will detect the new backup location on reload in the backup manager.
Backup Folder Management
Backup Tables
Every table backup file contains the VPX table and additional required or mandatory assets, such as the ROM file, backglass, Pup Pack, music files, POV files and highscore data.
Highscores
The Studio supports the creation of backups and restoring all the following highscore types:
- EM highscore text files
- VPReg.stg highscore entries
- NVRam highscore files
Table Meta Data
For backup contains an additional JSON file contains the metadata of the table. This metadata contains the complete game info (manifest) which will be written to PinUP Popper when the archive is imported. The backup details view shows the details of the manifest data:
Table Meta Data
Asset Details
Additionally, the archive descriptor file contains information about it's own size and which assets have been added to the backup. This way, the user knows what the file contains before executing the actual import.
Backup Asset Details
Backup Upload
If you want to transfer backup files from one PC/VPin to another (e.g. prepage a table on your PC and transfer it to your VPin), you can use the upload function to upload backup files into the default repository. You can install the table afterwards or use the Table Manager to install them out of PinUP Popper.
Backup Upload
Create Backups
Backup can be triggered from the table overview. You can bulk backup a set of tables via multi-selection. Once the backup is started, you will noticed that the tables are backed-up one after another. The progress can be seen in the jobs drop-down menu in the upper right corner of the Studio window.
Restore Backups
Restoring a backup is pretty self-explaining. You only need to determine the emulator and the assets that should be restored. Once the restoring is triggered, the job is triggered to unpack the backup. Note that you have to refresh the table overview in order for the restored table to appear!
Backup Restore