Skip to content

Step By Step

Jump to bottom
stoj edited this page Mar 30, 2023 · 15 revisions

Installation and Setup

  1. Install the latest version from the releases page.
  2. Run the application via the Start Menu short cut.
  3. Update your settings..
    1. Specify the required folders. Note, the 'Auto Assign' button will update the front end media folders to the default locations.
    2. 'Trainer Wheels' is on by default, this ensures no files will be modified on your system. Be sure to turn off this feature when you're ready to take the plunge.
  4. Back to the home page (the settings are saved automatically).

1. Cleaner

  1. Select Cleaner button and configure as required. It should be self evident, but if in doubt hover the mouse over the checkboxes to get some help.
  2. 'Multiple match preference' is particularly useful to decide the preferred action when you have multiple matching files. For example, during your first run or after a rebuild.
  3. Select 'Start'. Depending on how many files and how fast your PC is, this typically only takes a few seconds.

2. Merger

  1. Select Merger button and configure as required. It should be self evident, but if in doubt hover the mouse over the checkboxes to get some help.

3. Feeder

  1. Select Feeder button and configure as required. It should be self evident, but if in doubt hover the mouse over the checkboxes to get some help. This will make a call to a website (github) that hosts the VPS feed.
  2. Results window..

    1. Criteria (LHS panel)

      • Filter the content based on useful criteria, e.g. exclude original, update date range, manufacturer date range, etc.
      • Sort results by clicking table header
      • Update database entries (PinballY/PinballX only)..
        • Individual tables..
          • Add new tables via the '+' icon.
          • Update existing tables via the 'refresh' icon.
        • All tables..
          • 'Add Missing Info' button to populate missing info, e.g. IPDB links, manufacturer year, etc.
          • 'Overwrite All Info' button to synchronise your local database to the online sources. _Highly recommended!
          • Note: under normal circumstances the following is NOT required as the fuzzy matching logic will automatically link your local table with the online source, but under rare circumstances (e.g. table name is too short to correctly match) then this may not be possible and the following fields can be updated (via the update screen) to ensure a successful match to the online source.._
            • Name
            • Manufacturer
            • Year

    2. Local File Matching (LHS panel)

      • View button: select to view the (fuzzy) matching local database entry. Requires PinballX/Y database setup to be correctly configured.
      • Add button: currently disabled (pending feature implementation).

    3. Hardware (centre top panel)

      • Navigate to IPDB for further table info.

    4. Software (top RHS panel)

      • Summary information for the content contained in this table

    5. Files (centre lower panel

      • Select desired content type via the tab menu. If a type is disabled this is because there is no available content.
      • Check for desired author, version, last update time, etc
      • Click green button(s) to open the browser to the web site hosting the content.

Explorer

  1. Inspect details of your collection.
    1. Lists ALL of the tables referenced in your front end database.
    2. Links to the IPDB entry if either entries exist in the DB..
      1. IpdbId - used by PinballY
      2. IpdbNr - used by PinballX
    3. Tables that are identified..
      1. ✔️ = table is completely clean (valid).
      2. ❗ = table needs some TLC (aka fixing).
    4. Open media files (uses your default application)
    5. Sort and re-order table columns

Merger Results

  1. For each table with matches.. shows files.
  2. Usage..
    1. Use the filter criteria (text search, content, and criteria) to find any specific table content you wna to review.
    2. Expand the table to inspect any issues.
    3. Right click the issues to get some nifty context features.. open file, show in explorer, copy path, etc.

Cleaner Results

  1. For each table with matches.. shows issues and fixes.
  2. Usage..
    1. Use the filter criteria (text search, content, and criteria) to find any specific table content you wna to review.
    2. Expand the table to inspect any issues.
    3. Right click the issues to get some nifty context features.. open file, show in explorer, copy path, etc.

Statistics Window

  1. Top section - if you're super keen, you can review the breakdown of each checked criteria against every checked content type
    1. Format: xxx/yyy [()]: www (), zzz ()
      • xxx = tables that have matching content type for the specific criteria
      • yyy = all possible tables defined in your PinballX database file. n/a for unknown and unsupported, i.e. since there was no corresponding database table entry.
      • = either..
        • ignored = files that were ignored, e.g. for merger didn't satisfy the 'ignore criteria'
        • renamed = files that were incorrectly named and have been renamed
        • removed = files that were not required and have been removed
        • merged = files that were added (merger only)
      • xxx = count of files matching the action
      • = total size of the relevant files
  2. Bottom section - when you just want a quick summary of what happened. Information is contextual.
    1. Cleaner
      1. Totals
        • Available Tables = total number of tables defineed in your PinballX database.
        • Possible Content = (total number of tables) X (total number of possible content types)
        • Checked Content = (total number of tables) X (total number of configured content types)
      2. All Files - the size of your VP collection including ALL files, i.e. before any fixes were applied.
      3. Valid Files..
        1. Format: ()
        2. Collection: number of actual files relevant to the number of possible files. A commplete set would have this number at 100%. Good luck!!
      4. Fixed and Fixable Files - a quick summary of what's been fixed (or would of been fixed if 'Trainer Wheels' was enabled) broken down into..
        1. renamed - files that were incorrectly named and have been renamed (original file copied to the backup folder)
        2. removed - files that were not required and have been removed (moved to the backup folder)
        3. renamable and removed - files that would of been fixed if the relevant 'Fix' criteria option(s) were selected.
      5. Time taken - nope, it's not broken.. it really was that quick!!
    2. Merger
      1. Source Files - files from the source folder
        • Total = files that were reviewed for merging
        • Matched = files that matched the criteria
        • Unknown & Unsupported = files that were not matched, i.e. no matching PinballX database entry could be found
      2. Destination files - files in the destination folder
        • Merged = files that were merged, i.e. matched AND did not fall foul of the ignore criteria
        • Ignored = files that were NOT merged, i.e. didn't match OR matched but fell foul of the ignore criteria
      3. Time taken - nope, it's not broken.. it really was that quick!!

Logs Window

  • Very useful for inspecting and understanding why the file operations (keep, merge, move, or delete) were performed.
  • Enable "diagnostic logging" from the settings page to include additional logging (for the curious and debugging).

ClrVpin v7

Clone this wiki locally