Skip to content

Common Use Cases

stoj edited this page Oct 18, 2021 · 19 revisions

#1 - Audit Collection

  • With trainer wheels ON, run scanner with relevant content types selected.
  • Examine the output windows to review the audit:
    • Statistics: review totals of missing files, percentage missing, etc.
    • Results: using the filter options, review the missing items for each table
    • Explorer: click the icons to open the content (e.g. tables, graphics, video, sounds, etc)
    • Logs: examine in detail why content has been marked as dirty or missing.

#2 - Clean Collection

  • With trainer wheels OFF, run scanner with relevant content types selected.
  • The content identified during the audit will be fixed, e.g. files renamed, redundant files moved to backup folder, etc.

#3 - Merging New Content

  • Download your new content into separate folders based on the content type. Ideally name the folders to match the content type so ClrVpin will automatically assign the content type when merging (next step), e.g. "launch audio", "backglasses", "tables", etc.
  • Step 1: run re-builder on content type 'tables'
    • Recommend this is done as a 2 pass..
      • 1st pass: trainer wheel ON to confirm the merging behaviour works as desired.
      • 2nd pass: trainer wheels OFF to do the actual merge.
  • Step 2: review remaining 'tables' files that weren't merged..
    • Unwanted tables: delete the files manually
    • Unmatched tables: rename the files manually to match the table description. Ideally, these should be few as the 'fuzzy matching' logic will take care of the common mismatch scenarios (refer here)
    • New tables: manually run the usual workflow for importing new table files..
      • Not essential, but recommended to rename the file in the 'standard' format: "<table> (<manufacturer> <year>).vpx"
      • Move the files manually into the 'table' installation folder.
      • Run your frontend (e.g. PinballY) to add the tables to your database. For recreation tables, recommend using a tool that harvests information from IPDB
  • Step 3: run re-builder for ALL other content types, e.g. launch audio, wheels, backglasses, etc.

#4 - Manually Updating Database (Advanced Users)

  • If you manually update your database (i't an xml file) to change the with table/game name or description.
  • Run scanner to fix (rename) the existing content files to match the updated database entries.