rommapp_docs/docs/Getting-Started/Configuration-File.md

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:

  platforms: ["ps", "ngc", "gba"]
  

• 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:

      extensions: ["xml", "txt"]
      

    • names: Exclude files by name or pattern (supports Unix wildcards). Example:

      names: ["info.txt", "._*", "*.nfo"]
      

  • multi_file Applies to ROMs stored as folders (multi-disc, with DLC, etc.).

    • names: Exclude entire folders by name. Example:

      names: ["final fantasy VII", "DLC"]
      

    • parts: Exclude specific files inside multi-file ROM folders.
      • names: Exclude files by name or pattern. Example:

        names: ["data.xml", "._*"]
        

      • extensions: Exclude files by extension. Example:

        extensions: ["xml", "txt"]
        

---

system

Customize how RomM interprets your folder and platform names.

• platforms Map your custom folder names to RomM's recognized platform names. Example:

  platforms: { gc: "ngc", psx: "ps" }
  

  This treats a gc folder as GameCube (ngc) and psx as PlayStation (ps).

• versions Associate a platform with its main version. This also tells RomM to fetch medatata from the main version source. Example:

  versions: { naomi: "arcade" }
  

---

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:

filesystem: { roms_folder: "my_roms" }

---

scan

The metadata scanners can have their priority changed by your config.yaml file. See the config.example.yaml for the default values.

priority: { "metadata", "artwork", "region", "language" }

• metadata Changes the metadata provider preferred order for metadata sources. Example:

  metadata:
      { "igdb", "moby", "ss", "ra", "lb", "hasheous", "flashpoint", "hltb" }
  

• artwork Changes the metadata provider preferred order for cover art and screenshots. Example:

  artwork:
      { "igdb", "moby", "ss", "ra", "lb", "hasheous", "flashpoint", "hltb" }
  

• region Changes the metadata provider preferred region for cover art and game title (only used by Screenscraper) Example:

  region: { "us", "wor", "ss", "eu", "jp" }
  

• language Changes the metadata provider preferred language for cover art and game title (only used by Screenscraper) Example:

  language: { "en", "fr" }
  

---

!!! tip You can find examples of full binded batocera or es-de config files.

!!! 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.