User Tools

Site Tools

Trace:
directory_settings

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
directory_settings [2022/11/20 11:19] – johnsancdirectory_settings [2024/04/10 18:27] (current) – johnsanc
Line 1: Line 1:
-====== Directory Rules ====== +====== DAT Rules ====== 
-Directory rules allow you to define locations for your ROMs and settings for how you want those ROMs stored. These settings offer a lot of flexibility and control over your collection. To get the most value out of RomVault its best to spend time understanding exactly what options are available and how they work.+DAT rules allow you to define locations for your ROMs and settings for how you want those ROMs stored. These settings offer a lot of flexibility and control over your collection. To get the most value out of RomVault its best to spend time understanding exactly what options are available and how they work.
  
-<WRAP round alert>The RomVault UI will allow you map multiple DATs to a single directory. Do NOT map multiple DATs to the same ROM directory. Doing so may result in unintentional file deletions during a fix operation if the "[[global_settings#double_check_delete|Double Check Delete]]" global setting is disabled.</WRAP>+<WRAP alert>The RomVault UI will allow you map multiple DATs to a single directory. Do NOT map multiple DATs to the same ROM directory. Doing so may result in unintentional file deletions during a fix operation if the "[[global_settings#double_check_delete|Double Check Delete]]" global setting is disabled.</WRAP>
  
-<WRAP round important>Directory rules can only be applied to standard directories, not auto-created virtual directories in the DatRoot. If you place multiple DATs into a single directory, you cannot apply a rule to an individual DAT within that directory. If you need to apply a directory rule to a specific DAT, then the DAT should reside in its own directory in the DatRoot.</WRAP>+<WRAP important>Directory rules can only be applied to standard directories, not auto-created virtual directories in the DatRoot. If you place multiple DATs into a single directory, you cannot apply a rule to an individual DAT within that directory. If you need to apply a directory rule to a specific DAT, then the DAT should reside in its own directory in the DatRoot.</WRAP>
  
 The directory settings can be accessed in two ways: The directory settings can be accessed in two ways:
Line 13: Line 13:
 {{:settings:directory-rule.png?nolink&600 |}} {{:settings:directory-rule.png?nolink&600 |}}
 \\ \\
- 
  
 ----- -----
- +===== Rule Path and Directory Location ===== 
-===== Rule Path =====+\\ 
 +{{:settings:directory-paths.png?nolink&600 |}} 
 +\\ 
 +\\ 
 +==== Rule Path ====
 This field is for reference and is not editable. The root of your entire setup is always called "RomVault". "RomVault" is mapped to where ever you keep all of your ROMs. This field is for reference and is not editable. The root of your entire setup is always called "RomVault". "RomVault" is mapped to where ever you keep all of your ROMs.
  
Line 23: Line 26:
  
  
-===== Dir Location =====+==== Dir Location ====
 The Dir Location is the path to your ROMs. The folder icon allows you to choose the location by browsing. The Dir Location is the path to your ROMs. The folder icon allows you to choose the location by browsing.
  
Line 32: Line 35:
   * ''\\?\UNC\Server\Share\''   * ''\\?\UNC\Server\Share\''
  
-<WRAP round important>It's recommended to use regular UNC paths or drive letters to ensure support with chdman.exe for CHD verification. chdman.exe does not support long path syntax.</WRAP> +----- 
- +===== Directory / Merge Rules ===== 
- +\\ 
-===== Don't Auto Add DAT Directories ===== +{{:settings:directory-rule-main.png?nolink&600 |}} 
-If two or more DATs share a directory then RomVault will automatically create a subdirectory for each DAT so that they do not conflict with each other. If the "Don't Auto Add DAT Directories" option is __enabled__ then these directories will not be automatically created and the contents of the DATs will be effectively merged together. The result is that all of your ROMs from these DATs will be placed in the same directory.+\\ 
 +\\ 
 +==== Don't Auto Add DAT Directories ==== 
 +If two or more DATs share a directory in the DATRoot then RomVault will automatically create a virtual subdirectory for each DAT so they don't conflict with each other. If the "Don't Auto Add DAT Directories" option is __enabled__ then these directories will not be automatically created and the contents of the DATs will be effectively merged together. The result is that all of your ROMs from these DATs will be placed in the same directory.
  
-<WRAP round info>Because this option causes DATs to be merged its likely you may encounter a DAT merge conflict if used haphazardly. This option is only useful under very specific circumstances.</WRAP>+<WRAP info>Because this option causes DATs to be merged its likely you may encounter a DAT merge conflict if used haphazardly. This option is only useful under very specific circumstances.</WRAP>
  
  
-===== Archive Type =====+==== Archive Type ====
 This option allows you to specify your preferred way packaging your ROMs. Options include: This option allows you to specify your preferred way packaging your ROMs. Options include:
   * **File** - Sets will be stored uncompressed   * **File** - Sets will be stored uncompressed
Line 50: Line 56:
  
  
-===== Merge Type =====+==== Merge Type ====
 This option allows you to specify your preferred way of merging your ROMs. This is primarily used for MAME DATs. Options include: This option allows you to specify your preferred way of merging your ROMs. This is primarily used for MAME DATs. Options include:
   * **Nothing** - No preference, generally used for non-MAME sets where merging does not apply   * **Nothing** - No preference, generally used for non-MAME sets where merging does not apply
Line 62: Line 68:
  
  
-===== ROM/CHD Filter =====+==== ROM/CHD Filter ====
 This option allows you to specify what types of files to allow. This is primarily used for MAME DATs. Options include: This option allows you to specify what types of files to allow. This is primarily used for MAME DATs. Options include:
   * **ROMs & CHDs** - Both ROMs and CHDs will be included. This option should be used in most cases.   * **ROMs & CHDs** - Both ROMs and CHDs will be included. This option should be used in most cases.
Line 69: Line 75:
  
  
-===== Header Type =====+==== Header Type ====
 This option allows you to specify how you want to handle ROM headers. This option allows you to specify how you want to handle ROM headers.
   * **Optional** - Both headered and headerless ROMs will be allowed if a header skipper is declared in the DAT.   * **Optional** - Both headered and headerless ROMs will be allowed if a header skipper is declared in the DAT.
Line 75: Line 81:
   * **Headerless** - Only ROMs without headers will be included.   * **Headerless** - Only ROMs without headers will be included.
  
-<WRAP round info>The "Headered" setting applies to all files in the DAT, even files where a header would not apply such as BIOS files. This means you may have missing ROMs if the DAT includes both types of files. This is normal and currently by design.</WRAP>+<WRAP info>The "Headered" setting applies to all files in the DAT, even files where a header would not apply such as BIOS files. This means you may have missing ROMs if the DAT includes both types of files. This is normal and currently by design.</WRAP>
  
-===== Single Archive =====+==== Single Archive ====
 Enabling this option will turn the DATs in these directories into single archives. If enabled, this option allows you to specify how to handle subdirectories. The options are: Enabling this option will turn the DATs in these directories into single archives. If enabled, this option allows you to specify how to handle subdirectories. The options are:
   * **Add SubDirs**   * **Add SubDirs**
Line 89: Line 95:
  
  
-===== Use description (instead of name) for auto added paths ===== +==== Use description (instead of name) for auto added paths ==== 
-If two or more DATs share a directory then RomVault will automatically create a subdirectory for each DAT so that they do not conflict with each other. If the "Use description (instead of name) for auto added paths" option is __disabled__ then these subdirectories will be named as follows:+If two or more DATs share a directory in the DATRoot then RomVault will automatically create a virtual subdirectory for each DAT so they don't conflict with each other. If the "Use description (instead of name) for auto added paths" option is __disabled__ then these subdirectories will be named as follows:
   * The value of the ''<name>'' tag in the DAT header   * The value of the ''<name>'' tag in the DAT header
   * If no ''<name>'' tag is present, then the DAT filename will be used   * If no ''<name>'' tag is present, then the DAT filename will be used
Line 99: Line 105:
   * If no ''<name>'' tag exists, then the DAT filename will be used   * If no ''<name>'' tag exists, then the DAT filename will be used
  
 +-----
 +
 +===== Advanced Options =====
 +\\
 +{{:settings:directory-rule-advanced.png?nolink&600 |}}
 +\\
 +\\
 +==== Use ID for Numbered DAT Names (No-Intro DATs) ====
 +This option will prefix the set name with the value of the id attribute in the DAT. This is typically only applicable for No-Intro DATs that have release numbers.
 +
 +==== Only Keep Complete Sets ====
 +This option will prevent incomplete sets. This is useful when you only want to collect a subset of games in DAT or you want to ensure everything you collect has all files for playability in a frontend.
 +
 +-----
 +===== Filename Exclude =====
 +\\
 +{{:settings:directory-rule-exclude.png?nolink&600 |}}
 +\\
  
-===== Filenames not to remove from RomDirs =====+==== Filenames not to remove ====
 This setting allows you to specify rules for files to ignore. Any ignored files are still scanned by RomVault, but they are flagged with an "ignore" status and will not be removed due to being unneeded according to the DAT. This setting is useful for ignoring a specific filenames or matching on patterns using wildcards or regex. Some examples include: This setting allows you to specify rules for files to ignore. Any ignored files are still scanned by RomVault, but they are flagged with an "ignore" status and will not be removed due to being unneeded according to the DAT. This setting is useful for ignoring a specific filenames or matching on patterns using wildcards or regex. Some examples include:
  
Line 106: Line 130:
 |Exact|''_readme_.txt''|Ignores the file named exactly ''_readme_.txt''| |Exact|''_readme_.txt''|Ignores the file named exactly ''_readme_.txt''|
 |Wildcard|''*.sbi''|Ignores all .sbi files which are sometimes packaged with PS1 dumps| |Wildcard|''*.sbi''|Ignores all .sbi files which are sometimes packaged with PS1 dumps|
-|Regex|''regex:(/.stignore|/.stfolder)''|Ignores .stfolder and .stignore files which may be present if you sync a directory with syncthing to another location|+|Regex|''regex:(\.stignore|\.stfolder)''|Ignores .stfolder and .stignore files which may be present if you sync a directory with syncthing to another location|
  
-<WRAP round info>Each ignore rule must be on its own line. Wildcard rules support ''?'' to match a single character and ''*'' to match any number of characters. Regex rules must be prefixed with ''regex:''</WRAP>+<WRAP info>Each ignore rule must be on its own line. Wildcard rules support ''?'' to match a single character and ''*'' to match any number of characters. Regex rules must be prefixed with ''regex:''</WRAP>
  
-<WRAP round tip>For assistance with regex, try [[https://regex101.com/|regex101.com]]</WRAP>+<WRAP tip>For assistance with regex, try [[https://regex101.com/|regex101.com]]</WRAP>
  
 ----- -----
 \\ \\
-====== Cascading Directory Rules ======+===== Cascading Directory Rules =====
 Settings for a directory will cascade to all of that directory's descendants until overwritten by a higher priority rule. Rules for descendant directories are always a higher priority than the rules for ancestor directories. Settings for a directory will cascade to all of that directory's descendants until overwritten by a higher priority rule. Rules for descendant directories are always a higher priority than the rules for ancestor directories.
  
Line 126: Line 150:
  
 If ''**Redump**'' had its own directory rule, then ''**Sony - PlayStation**'' would inherit that rule instead of the rule from ''**RomVault**''. If ''**Redump**'' had its own directory rule, then ''**Sony - PlayStation**'' would inherit that rule instead of the rule from ''**RomVault**''.
 +
 +===== Video Tutorial =====
 +{{youtube>IdHdIopxNDU?full}}
directory_settings.1668971966.txt.gz · Last modified: 2022/11/20 11:19 by johnsanc