config

The config.yml file defines how ROMSearch will do the run. As such, it has quite a number of options.

As a note on includes, this will match something from the start of the string. So “Game Title VII” would include “Game Title VII”, “Game Title VIII”, but not “Game Title Anthology - Game Title VII”, for example.

Syntax:

dirs:
  raw_dir: [raw_dir]                # Raw directory to download ROM files using ROMDownloader
  rom_dir: [rom_dir]                # Final output directory for ROMs. Will automatically subdivide by platform
  dat_dir: [dat_dir]                # Directory to place raw .dat files
  parsed_dat_dir: [parsed_dat_dir]  # Directory to place parsed .dat files, as well as clonelists
  dupe_dir: [dupe_dir]              # Directory to place dupe files
  log_dir: [log_dir]                # Directory to place logs
  cache_dir: [cache_dir]            # Directory to place cache files

platforms:                          # List of platforms to download ROMs for
  - [platform]

region_preferences:                 # List of regions, in preference order
  - [most_preferred_region]
  - [next_preferred_region]

language_preferences:               # List of languages, in preference order
  - [most_preferred_language]
  - [next_preferred_language]

include_games:                      # OPTIONAL. Use this to trim down the number of ROMs downloaded
  [platform]:
    - [game]

romsearch:                          # ROMSearch specific options
  method: 'filter_then_download'    # OPTIONAL. Method to use, option are 'filter_then_download', or
                                    #           'download_then_filter'. Defaults to 'filter_then_download'
  run_romdownloader: true           # OPTIONAL. Whether to run ROMDownloader. Defaults to true
  run_datparser: true               # OPTIONAL. Whether to run DATParser. Defaults to true
  run_dupeparser: true              # OPTIONAL. Whether to run DupeParsed. Defaults to true
  run_romchooser: true              # OPTIONAL. Whether to run ROMChooser. Defaults to true
  run_rommover: true                # OPTIONAL. Whether to run ROMMover. Defaults to true
  dry_run: false                    # OPTIONAL. Set to true to not make any changes to filesystem. Defaults to false

romdownloader:                      # ROMDownloader specific options
  dry_run: false                    # OPTIONAL. Set to true to not make any changes to filesystem. Defaults to false
  remote_name: 'rclone_remote'      # Rclone remote name
  use_absolute_url: false           # OPTIONAL. If true, will assume the path is an absolute URL for the rclone
                                    #           remote. Set to false if using an HTTP remote!
  sync_all: false                   # OPTIONAL. If true, will download everything that rclone finds. Set to false to
                                    #           use the include_games above

dupeparser:                         # DupeParser specific options
  use_dat: true                     # OPTIONAL. Whether to use .dat files or not. Defaults to true
  use_retool: true                  # OPTIONAL. Whether to use retool clonelists or not. Defaults to true

gamefinder:                         # GameFinder specific options
  filter_dupes: true                # OPTIONAL. Whether to filter dupes or not. Defaults to true

romparser:                          # ROMParser specific options
  use_dat: true                     # OPTIONAL. Whether to parse properties from .dat files. Defaults to true
  use_filename: true                # OPTIONAL. Whether to parse properties from filename. Defaults to true

romchooser:                         # ROMChooser specific options
  dry_run: false                    # OPTIONAL. Set to true to not make any changes to filesystem. Defaults to false
  use_best_version: true            # OPTIONAL. Whether to choose only what ROMChooser decides is the best version.
                                    #           Defaults to true
  allow_multiple_regions: false     # OPTIONAL. If true, will allow files from multiple regions, else will choose the
                                    #           highest region in the list. Defaults to false
  filter_regions: true              # OPTIONAL. Whether to filter by region or not. Defaults to true
  filter_languages: true            # OPTIONAL. Whether to filter by language or not. Defaults to true
  bool_filters: "all_but_games"     # OPTIONAL. Can filter out non-games by various dat categories. If you want to
                                    #           include e.g. just games and applications, set to
                                    #           ['games', 'applications']. Defaults to 'all_but_games', which will
                                    #           remove everything except games

discord:                            # OPTIONAL. If defined, supply a webhook URL so that ROMSearch can post Discord
  webhook_url: [webhook_url]        #           notifications

logger:
  level: info                       # OPTIONAL. If defined, can set the log level to be printed to terminal and
                                    #           logs

Sample

dirs:
  raw_dir: 'F:\Emulation\raw'
  rom_dir: 'F:\Emulation\ROMs'
  dat_dir: 'F:\Emulation\data\dats'
  parsed_dat_dir: 'F:\Emulation\data\dats_parsed'
  dupe_dir: 'F:\Emulation\data\dupes'
  log_dir: 'F:\Emulation\data\logs'
  cache_dir: 'F:\Emulation\data\cache'

platforms:
  - Nintendo - Super Nintendo Entertainment System

region_preferences:
  - USA

language_preferences:
  - English

include_games:
  SNES:
    - "Chrono Trigger"

romsearch:
  method: "filter_then_download"
  run_romdownloader: true
  run_datparser: true
  run_dupeparser: true
  run_romchooser: true
  run_rommover: false
  dry_run: false

romdownloader:
  dry_run: false
  remote_name: 'rclone_remote'
  sync_all: false

dupeparser:
  use_dat: true
  use_retool: true

gamefinder:
  filter_dupes: true

romparser:
  use_dat: true
  use_filename: true

romchooser:
  dry_run: false
  use_best_version: true
  allow_multiple_regions: false
  filter_regions: true
  filter_languages: true
  bool_filters: "all_but_games"

discord:
  webhook_url: "https://discord.com/api/webhooks/discord_url"

logger:
  level: debug