User Tools

Site Tools


config_xml

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
config_xml [2024/04/11 00:44] – [Table] johnsancconfig_xml [2025/04/27 20:46] (current) – [Table] johnsanc
Line 68: Line 68:
 |              | [[#Global Settings|<CacheSaveTimerEnabled>]]                                                                                                     ||| Enables auto-saving the cache at regular intervals during a scan or fix                     | Yes                 | |              | [[#Global Settings|<CacheSaveTimerEnabled>]]                                                                                                     ||| Enables auto-saving the cache at regular intervals during a scan or fix                     | Yes                 |
 |              | [[#Global Settings|<CacheSaveTimePeriod>]]                                                                                                       ||| Time in minutes between cache backups                                                       | Yes                 | |              | [[#Global Settings|<CacheSaveTimePeriod>]]                                                                                                       ||| Time in minutes between cache backups                                                       | Yes                 |
-|              | [[#Game List Filters|<chkBoxShowCorrect>]]                                                                                                       ||| Last game grid filter value for "Show correct sets                                        | Yes                 | +|              | [[#Game List Filters|<chkBoxShowComplete>]]                                                                                                      ||| Last game grid filter value for "Show Complete                                            | Yes                 | 
-|              | [[#Game List Filters|<chkBoxShowMissing>]]                                                                                                       ||| Last game grid filter value for "Show incomplete sets                                     | Yes                 | +|              | [[#Game List Filters|<chkBoxShowPartial>]]                                                                                                       ||| Last game grid filter value for "Show Partial"                                              | Yes                 | 
-|              | [[#Game List Filters|<chkBoxShowFixed>]]                                                                                                         ||| Last game grid filter value for "Show sets with fixes                                     | Yes                 |+|              | [[#Game List Filters|<chkBoxShowEmpty>]]                                                                                                         ||| Last game grid filter value for "Show Empty                                               | Yes                 | 
 +|              | [[#Game List Filters|<chkBoxShowFixes>]]                                                                                                         ||| Last game grid filter value for "Show Fixes                                               | Yes                 |
 |              | [[#Game List Filters|<chkBoxShowMIA>]]                                                                                                           ||| Last game grid filter value for "Show MIA"                                                  | Yes                 | |              | [[#Game List Filters|<chkBoxShowMIA>]]                                                                                                           ||| Last game grid filter value for "Show MIA"                                                  | Yes                 |
-|              | [[#Game List Filters|<chkBoxShowMerged>]]                                                                                                        ||| Last game grid filter value for "Show merged deduped                                    | Yes                 |+|              | [[#Game List Filters|<chkBoxShowMerged>]]                                                                                                        ||| Last game grid filter value for "Show Merged Deduped                                    | Yes                 | 
 +|              | [[#Game List Filters|<FixDatOutPath>]]                                                                                                           ||| Last directory chosen when saving FixDATs                                                   | Yes                 |
 |              | [[#DATVault Settings|<DATUpdateKey>]]                                                                                                            ||| Your personal DATVault key - Keep this safe and do not share                                | Yes                 | |              | [[#DATVault Settings|<DATUpdateKey>]]                                                                                                            ||| Your personal DATVault key - Keep this safe and do not share                                | Yes                 |
 |              | [[#Global Settings|<MIAAnon>]]                                                                                                                   ||| Enables anonymous "MIA Found" reporting - Only relevant for DATVault users                  | Yes                 | |              | [[#Global Settings|<MIAAnon>]]                                                                                                                   ||| Enables anonymous "MIA Found" reporting - Only relevant for DATVault users                  | Yes                 |
 |              | [[#Global Settings|<MIACallback>]]                                                                                                               ||| Enables "MIA Found" reporting back to the DatVault server                                   | Yes                 | |              | [[#Global Settings|<MIACallback>]]                                                                                                               ||| Enables "MIA Found" reporting back to the DatVault server                                   | Yes                 |
 +|              | [[#Global Settings|<DoNotReportFeedback>]]                                                                                                       ||| Disables crash reporting sent to GordonJ                                                    | Yes                 |
 |              | [[#DATVault Settings|<DeleteOldCueFiles>]]                                                                                                       ||| Automatically deletes old cue packs downloaded by DatVault                                  | Yes                 | |              | [[#DATVault Settings|<DeleteOldCueFiles>]]                                                                                                       ||| Automatically deletes old cue packs downloaded by DatVault                                  | Yes                 |
 |              | [[#Global Settings|<Darkness>]]                                                                                                                  ||| Enables Dark Mode                                                                           | Yes                 | |              | [[#Global Settings|<Darkness>]]                                                                                                                  ||| Enables Dark Mode                                                                           | Yes                 |
Line 81: Line 84:
 |              | [[#Global Settings|<zstdCompCount>]]                                                                                                             ||| Specifies the maximum number of zstd workers to spawn per compression stream                | Yes                 | |              | [[#Global Settings|<zstdCompCount>]]                                                                                                             ||| Specifies the maximum number of zstd workers to spawn per compression stream                | Yes                 |
 |              | [[#Global Settings|<sevenZDefaultStruct>]]                                                                                                       ||| Specifies the default 7z archive structure for archives that need to be repacked in ToSort  | Yes                 | |              | [[#Global Settings|<sevenZDefaultStruct>]]                                                                                                       ||| Specifies the default 7z archive structure for archives that need to be repacked in ToSort  | Yes                 |
 +|              | [[#Global Settings|<ParallelZipScan>]]                                                                                                           ||| Enables parallel archive scanning (experimental)                                            | No                  |
 ^ </Settings>                                                                                                                                                    |||^                                                                                                                 ^ ^ </Settings>                                                                                                                                                    |||^                                                                                                                 ^
  
Line 87: Line 91:
 The following settings are controllable through the RomVault UI from the **Settings > RomVault Settings** menu. The following settings are controllable through the RomVault UI from the **Settings > RomVault Settings** menu.
  
-^ XML Setting            ^ UI Mapping                         ^ Accepted Values                                                                               ^ +^ XML Setting            ^ UI Mapping                               ^ Accepted Values                                                                               ^ 
-| DatRoot                | DAT Root Directory                 | Any valid relative or absolute path                                                           | +| DatRoot                | DAT Root Directory                       | Any valid relative or absolute path                                                           | 
-| FixLevel               | Fixing Level                       | ''level1'', ''level2'', or ''level3''                                                         | +| FixLevel               | Fixing Level                             | ''Level1'', ''Level2'', or ''Level3''                                                         | 
-| IgnoreFiles            | Filenames not to remove from Dirs  | Refer to [[global_settings#filenames_not_to_remove_from_dirs|Global Settings documentation]] +| IgnoreFiles            | Filenames not to remove from Dirs        | Refer to [[global_settings#filenames_not_to_remove_from_dirs|Global Settings documentation]] 
-| DoubleCheckDelete      | Double Check Delete                | ''true'' or ''false''                                                                         | +| DoubleCheckDelete      | Double Check Delete                      | ''true'' or ''false''                                                                         | 
-| DebugLogsEnabled       | Debug Logs Enabled                 | ''true'' or ''false''                                                                         | +| CacheSaveTimerEnabled  | Save Cache On Timer...                   | ''true'' or ''false''                                                                         | 
-| DetailedFixReporting   | Detailed Fix Reporting             | ''true'' or ''false''                                                                         | +| CacheSaveTimePeriod    | ...Every XX Minutes                      | Integer number greater than ''5''                                                             
-| CacheSaveTimerEnabled  | Save Cache On Timer...             | ''true'' or ''false''                                                                         | +| Darkness               | Dark Mode (restart required)             | ''true'' or ''false''                                                                         
-| CacheSaveTimePeriod    | ...Every XX Minutes                | Integer number greater than ''5''                                                             | +| zstdCompCount          | Max ZSTD workers                         | ''0 - 64''. A vaule of 0 is Auto which is detected CPU cores minus 2                          | 
-| zstdCompCount          | Max ZSTD workers                   | ''0 - 64''. A vaule of 0 is Auto which is detected CPU cores minus 2                          | +| sevenZDefaultStruct    | Default 7Z type                          | ''0 - 3''. 0 = LZMA Solid, 1 = LZMA Non-Solid, 2 = ZSTD Solid, 3 = ZSTD Non-Solid             
-| sevenZDefaultStruct    | Default 7Z type                    | ''0 - 3''. 0 = LZMA Solid, 1 = LZMA Non-Solid, 2 = ZSTD Solid, 3 = ZSTD Non-Solid             |+| MIACallback            | Send Found MIA notifications             | ''true'' or ''false''                                                                         | 
 +| MIAAnon                | Send anonymously                         | ''true'' or ''false''                                                                         | 
 +| DeleteOldCueFiles      | Delete previous cue file zips in ToSort  | ''true'' or ''false''                                                                         | 
 +| DetailedFixReporting   | Detailed Fix Reporting                   | ''true'' or ''false''                                                                         | 
 +| DebugLogsEnabled       | Debug Logs Enabled                       | ''true'' or ''false''                                                                         | 
 +| DoNoteReportFeedback   | Do not report feedback                   | ''true'' or ''false''                                                                         |
  
 For additional information, refer to the [[global_settings|Global Settings documentation]]. For additional information, refer to the [[global_settings|Global Settings documentation]].
Line 103: Line 112:
 \\  \\ 
 ===== DAT Rules ===== ===== DAT Rules =====
-The following settings are controllable through the RomVault UI from the **Settings > Directory Settings** menu.+The following settings are controllable through the RomVault UI from the **Settings > Directory DAT Rules** menu.
  
-^ XML Setting              ^ UI Mapping                                              ^ Accepted Values                                                                                        +^ XML Setting              ^ UI Mapping                                              ^ Accepted Values                                                                                                                      
-| DirKey                   | Rule Path                                               | Auto-generated DATRoot path                                                                            | +| DirKey                   | Rule Path                                               | Auto-generated DATRoot path                                                                                                          
-| DirPath                  | Dir Location                                            | Valid relative or absolute directory path                                                              +| Compression              | Archive Type                                            | ''Dir'', ''Zip'', ''SevenZip'', or ''FileOnly''                                                                                      
-| Compression              | Archive Type                                            | ''Dir'', ''Zip'', or ''SevenZip''                                                                      +| CompressionOverrideDAT   | Archive Type Override DAT                               | ''true'' or ''false''                                                                                                                | 
-| CompressionOverrideDAT   | Archive Type Override DAT                               | ''true'' or ''false''                                                                                  +| CompressionSub           | Compression Type                                        | ZIP: ''ZipTrrnt'' or ''ZipZSTD'', 7Z: ''SevenZipSLZMA'', ''SevenZipNLZMA'', ''SevenZipSZSTD'', or ''SevenZipNZSTD'', Else: ''None'' 
-| Merge                    | Merge Type                                              | ''None'', ''Split'', ''Merge'', or ''NonMerged''                                                       +| ConvertWhileFixing       | Convert when fixing                                     | ''true'' or ''false''                                                                                                                
-| Filter                   | ROM/CHD Filter                                          | ''KeepAll'', ''RomsOnly'', or ''CHDsOnly''                                                             +| Merge                    | Merge Type                                              | ''None'', ''Split'', ''Merge'', or ''NonMerged''                                                                                     
-| HeaderType               | Header Type                                             | ''Optional'', ''Headered'', or ''Headerless''                                                          +| Filter                   | ROM/CHD Filter                                          | ''KeepAll'', ''RomsOnly'', or ''CHDsOnly''                                                                                           
-| MergeOverrideDAT         | Merge Type Override DAT                                 | ''true'' or ''false''                                                                                  +| HeaderType               | Header Type                                             | ''Optional'', ''Headered'', or ''Headerless''                                                                                        
-| SingleArchive            | Single Archive                                          | ''true'' or ''false''                                                                                  +| MergeOverrideDAT         | Merge Type Override DAT                                 | ''true'' or ''false''                                                                                                                
-| SubDirType               | Single Archive setting                                  | ''KeepAllSubDirs'', ''RemoveAllSubDirs'', ''RemoveAllIfNoConflicts'', or ''RemoveSubIfSingleFiles''                                                                                              +| SingleArchive            | Single Archive                                          | ''true'' or ''false''                                                                                                                
-| MultiDATDirOverride      | Don't auto add DAT directories                          | ''true'' or ''false''                                                                                  +| SubDirType               | Single Archive setting                                  | ''KeepAllSubDirs'', ''RemoveAllSubDirs'', ''RemoveAllIfNoConflicts'', ''RemoveSubIfSingleFiles'', or ''RemoveSubIfNameMatches''      
-| UseDescriptionAsDirName  | Use description (instead of name) for auto added paths  | ''true'' or ''false''                                                                                  +| MultiDATDirOverride      | Don't auto add DAT directories                          | ''true'' or ''false''                                                                                                                
-| IgnoreFiles              | Filenames not to remove from RomDirs                    | Refer to [[directory_settings#filenames_not_to_remove_from_romdirs|Directory Settings documentation]]  |+| UseDescriptionAsDirName  | Use description (instead of name) for auto added paths  | ''true'' or ''false''                                                                                                                | 
 +| AddCategorySubDirs       | Add Category Sub Directories                            | ''true'' or ''false''                                                                                                                | 
 +| CategoryOrder            | Category Priority                                       | Possible values are pre-defined based on Redump and No-Intro, can be customized with XML edits.                                      | 
 +| UseIdForName             | Use ID for Numbered DAT Names (No-Intro DATs)           | ''true'' or ''false''                                                                                                                | 
 +| CompleteOnly             | Only Keep Complete Sets                                 | ''true'' or ''false''                                                                                                                
 +| IgnoreFiles              | Filenames not to remove from RomDirs                    | Refer to [[directory_settings#filenames_not_to_remove_from_romdirs|Directory Settings documentation]]                                |
  
 <WRAP tip>RomVault will process all descendent DATs and update the cache every time you update a Directory Rule in the UI. This can take a significant amount of time if you have a very large collection. If you need to make several changes you can edit the XML directly while RomVault is closed. If you take this approach to updating, be sure to **Refresh All DATs** to ensure all directory rules are processed.</WRAP> <WRAP tip>RomVault will process all descendent DATs and update the cache every time you update a Directory Rule in the UI. This can take a significant amount of time if you have a very large collection. If you need to make several changes you can edit the XML directly while RomVault is closed. If you take this approach to updating, be sure to **Refresh All DATs** to ensure all directory rules are processed.</WRAP>
  
-For additional information, refer to the [[directory_settings|Directory Settings documentation]].+For additional information, refer to the [[directory_settings|DAT Rules documentation]]. 
 + 
 +\\  
 +===== Directory Mappings ===== 
 +The following settings are controllable through the RomVault UI from the **Settings > Directory Mappings** menu. 
 +^ XML Setting  ^ UI Mapping    ^ Accepted Values                                                                      ^ 
 +| DirKey       | Rule Path     | Auto-generated DATRoot path                                                          | 
 +| DirPath      | Dir Location  | Directory location on your filesystem, can be absolute or relative to RomVault exe.  |
  
 \\  \\ 
Line 128: Line 149:
 The following settings are controllable through the DatVault UI from the **Update DATs > DatVault Update** menu. The following settings are controllable through the DatVault UI from the **Update DATs > DatVault Update** menu.
  
-^ XML Setting                   ^ UI Mapping                                                 ^ Accepted Values        ^ +^ XML Setting                   ^ UI Mapping                                      ^ Accepted Values        ^ 
-| DATUpdateKey                  | Login                                                      | Valid DATVault key     | +| DATUpdateKey                  | Login                                           | Valid DATVault key     | 
-| bUseDefaultMasterDirectories  | Add Selected > Use Default Master Directories              | ''true'' or ''false'' +| bUseDefaultMasterDirectories  | Add Selected > Use Default Master Directories   | ''true'' or ''false'' 
-| bUseDefaultSubDirectories     | Add Selected > Use Default Sub Directories                 | ''true'' or ''false'' +| bUseDefaultSubDirectories     | Add Selected > Use Default Sub Directories      | ''true'' or ''false'' 
-| bImportNewDATsWithJsonSeeds   | Add Selected > Import new DATs with JSON Seeds             | ''true'' or ''false'' +| bImportNewDATsWithJsonSeeds   | Add Selected > Import new DATs with JSON Seeds  | ''true'' or ''false''  |
-| MIACallback                   | Global Settings > Send Found MIA notifications             | ''true'' or ''false'' +
-| MIAAnon                       | Global Settings > Send anonymously                         | ''true'' or ''false'' +
-| DeleteOldCueFiles             | Global Settings > Delete previous cue file zips in ToSort  | ''true'' or ''false''  |+
  
  
Line 141: Line 159:
 ===== Game List Filters ===== ===== Game List Filters =====
 The following filters are controllable through the RomVault UI in the upper right corner of the Info Panel. The following filters are controllable through the RomVault UI in the upper right corner of the Info Panel.
-^ XML Setting        ^ UI Mapping             ^ Accepted Values        ^ +^ XML Setting         ^ UI Mapping             ^ Accepted Values        ^ 
-chkBoxShowCorrect  | Show Complete Sets     | ''true'' or ''false'' +chkBoxShowComplete  | Show Complete          | ''true'' or ''false'' 
-chkBoxShowMissing  | Show Incomplete Sets   | ''true'' or ''false'' +chkBoxShowPartial   | Show Partial           | ''true'' or ''false'' 
-chkBoxShowFixed    | Show Sets with fixes   | ''true'' or ''false'' +| chkBoxShowMissing   | Show Missing           | ''true'' or ''false'' 
-| chkBoxShowMIA      | Show MIA               | ''true'' or ''false'' +chkBoxShowFixes     | Show Fixes             | ''true'' or ''false'' 
-| chkBoxShowMerged   | Show Merged / Deduped  | ''true'' or ''false''  |+| chkBoxShowMIA       | Show MIA               | ''true'' or ''false'' 
 +| chkBoxShowMerged    | Show Merged / Deduped  | ''true'' or ''false''  |
  
  
config_xml.1712796291.txt.gz · Last modified: 2024/04/11 00:44 by johnsanc