Configuration File
Below is a breakdown of each section of the config.yml
file and its purpose:
exclude
This section lets you tell RomM which platforms, ROMs, or files to ignore during scanning.
-
platforms Exclude entire platforms (folders) from being scanned. Example:
-
roms Fine-tune which ROMs or files are excluded.
-
single_file Applies to ROMs that are single files (not in subfolders).
- extensions: Exclude files by extension. Example:
- names: Exclude files by name or pattern (supports Unix wildcards). Example:
-
multi_file Applies to ROMs stored as folders (multi-disc, with DLC, etc.).
- names: Exclude entire folders by name. Example:
- parts: Exclude specific files inside multi-file ROM folders.
- names: Exclude files by name or pattern. Example:
- extensions: Exclude files by extension. Example:
system
Customize how RomM interprets your folder and platform names.
-
platforms Map your custom folder names to RomM's recognized platform names. Example:
This treats agc
folder as GameCube (ngc
) andpsx
as PlayStation (ps
). -
versions Associate a platform with its main version. This also tells RomM to fetch medatata from the main version source. Example:
filesystem
Specify the folder name where your ROMs are located if it differs from the default. For example, if your roms
folder it's named my_roms
(/home/user/library/my_roms
), set this accordingly.
Example:
Warning
Only uncomment or add the lines you need. Any omitted or empty sections will use RomM's defaults. For a full example, see the config.example.yml file.