Skip to content

macsobel/VPX-Manager-for-ES-DE

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

212 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

VPX Manager for ES-DE

VPX Manager for ES-DE is a local web-based table and media management suite for Visual Pinball Standalone that handles table updates, media scraping, and support file management while integrating with EmulationStation Desktop Edition. The hobby has a steep learning curve, and VPX Manager tries to flatten it by walking you through each step of turning ES-DE into a polished virtual pinball frontend on macOS or Linux, whether on your desktop or powering a virtual pinball cabinet.

It automates scraping metadata and media from sources like ScreenScraper and VPinMediaDB, installs the scripts needed to launch VPX tables, and adds second-screen backglass support that ES-DE doesn't offer natively.

VPX Manager for ES-DE app icon

macOS 11+ Linux GPL-3.0 License


Features

Table & Media Management

  • Checks your .vpx files against the Visual Pinball Spreadsheet to automatically match and rename your files for consistency.
  • Monitors your table files for available updates.
  • Guides you through importing and updating everything a table needs to run: ROMs, backglass files, PUPacks, AltColor, and AltSound.
  • Downloads artwork for each table automatically (cabinet art, fanart, logos, and marquee images) and allows you to customize what media you want to use for each.
  • Packages tables for Visual Pinball on iOS and Android, including AirSync via Safari.
  • Provides an integrated game manual reader for reading the rules and reference material for each table in your collection.

Emulation Station DE Integration

  • Automates the process of enabling Visual Pinball as a system in ES-DE and keeps your table list current.
  • Provides a custom backglass art screen on a secondary monitor that syncs with whichever table you have selected in ES-DE.
  • Scripts a seamless return to ES-DE as soon as you close a Visual Pinball table.

Technical Features

  • Patches table scripts automatically using jsm174's standalone script repository so older tables work on macOS and Linux.
  • Automatically installs NVRAM files for Bally MPU 6803 and Gottlieb System 3 tables so they boot correctly.
  • Built-in settings editor for VPX config files (VBS, INI).
  • Runs natively on macOS and Linux.
  • Interface optimized for desktop and mobile

Screenshots

Dashboard Overview
Main dashboard overview showing library stats and available table updates.

Table Metadata
Table list view showing details, allowing users to launch VPX, and package tables for mobile.

Table Actions
Table card view showing installed features (e.g., PUPacks, AltColor, and AltSound).

Add Table Wizard
Guided new table installation page with links to VPS and automatic patching of VBS and NVRAM files.

Media Scrapers
Media file scraper for artwork from ScreenScraper and VPinMediaDB, with ability to rotate images and videos.

VBS Patch Manager
VBS manager for extracting and patching table scripts for standalone compatibility.

Manual Viewer
Integrated PDF viewer for reading game manuals and rule sheets.


Prerequisites

VPX Manager requires the following components have been installed and opened at least one time:

Installation

🍏 macOS

  1. Download the macOS app from the Releases page and move it to your Applications folder.

  2. Open Terminal and run the following command to clear the Gatekeeper quarantine flag:

    xattr -cr "/Applications/VPX Manager for ES-DE.app"

    Note: macOS may block the app on first launch with a "damaged and can't be opened" warning. The command above resolves this.

  3. Double-click VPX Manager for ES-DE to launch it.


🐧 Linux (Beta)

  1. Download the Linux app from the Releases page and extract it.

  2. Make the file executable:

    chmod +x VPX_Manager
  3. Launch it by double-clicking the file, or run it from the terminal:

    ./VPX_Manager

🌐 Getting Started Accessing the Web UI

  1. Launch VPX Manager for ES-DE from your Applications folder
  2. Click the pinball icon in your menu bar (macOS) or taskbar (Linux) and choose Open Web UI. You can also open it directly in any browser at: http://localhost:8746
    • Or use your machine's local hostname (e.g., http://macmini.local:8746).
  3. Navigate to Settings and set the absolute paths for the VPX executable and ES-DE application, as well as enter your ScreenScraper login information to obtain more access to media files.
  4. Perform an initial VPS database update and scan your tables in the Dashboard to index your .vpx collection.

On your initial visit, the First Run Setup Guide should walk you through each of the steps to get started. You can also visit the Documentation page at any time to revisit these steps.


Configuration

The app stores its configuration and database here:

Platform Path
macOS ~/Library/Application Support/VPX Manager for ES-DE/
Linux ~/.config/VPX Manager for ES-DE/

Acknowledgements

Thanks to the community members who make this hobby possible:


System Requirements

  • macOS: Version 11.0 (Big Sur) or newer.
  • Linux: Distribution with glibc 2.27 or higher (e.g., Ubuntu 20.04, Debian 11).
  • Backglass Companion: Requires SDL2 support and a secondary display output.

Running from Source

  1. Clone the repository: git clone https://github.com/macsobel/VPX-Manager-for-ES-DE
  2. Install dependencies: pip install -r requirements.txt
  3. Launch: python main.py

See CONTRIBUTING.md for detailed development setup and credential configuration instructions.

Troubleshooting

  • Gatekeeper (macOS): Right-click the app and select Open to bypass the developer verification warning.
  • Port Conflicts: The application server requires port 8746.
  • Display Detection: Use the Identify Monitors tool in Settings to verify the secondary display hardware ID.

License

This project is distributed under the GNU General Public License v3.0.

About

A user-friendly tool to manage Visual Pinball tables on macOS and Linux, optimized for Emulation Station - Desktop Edition. Easily manage your table files and build a pinball cabinet using your Mac or Linux PC.

Topics

Resources

License

Contributing

Stars

5 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors