config.example.yml

# This is a generic example of a configuration file
# Rename this file to `config.yml`, copy it to a `config` folder, and mount that folder as per the docker-compose.example.yml
# Only uncomment the lines you want to use/modify, or add new ones where needed

# exclude:
#   # Exclude platforms to be scanned
#   platforms:
#     - excluded_folder_a
#     - excluded_folder_b

#   # Exclude ROMs or parts of ROMs to be scanned
#   roms:
#     # Single file games section.
#     # Will not apply to files that are in sub-folders (multi-disc ROMs, games with updates, DLC, patches, etc.)
#     single_file:
#       # Exclude all files with certain extensions to be scanned
#       extensions:
#         - xml
#         - txt

#       # Exclude matched file names to be scanned
#       # Supports unix filename pattern matching
#       names:
#         - 'info.txt'
#         - '._*'
#         - '*.nfo'

#     # Multi files games section
#     # Will apply to files that are in sub-folders (multi-disc ROMs, games with updates, DLC, patches, etc.)
#     multi_file:
#       # Exclude matched 'folder' names to be scanned (RomM identifies folders as multi file games)
#       # Common ES-DE media folders are listed below
#       names:
#         - 3dboxes
#         - backcovers
#         - covers
#         - fanart
#         - manuals
#         - marquees
#         - miximages
#         - physicalmedia
#         - screenshots
#         - titlescreens
#         - videos
#         - downloaded_media
#         - media

#       # Exclude files within sub-folders.
#       parts:
#         # Exclude matched file names to be scanned from multi file roms
#         # Keep in mind that RomM doesn't scan folders inside multi files games,
#         # so there is no need to exclude folders from inside of multi files games.
#         names:
#           - 'data.xml'
#           - '._*' # Supports unix filename pattern matching

#         # Exclude all files with certain extensions to be scanned from multi file roms
#         extensions:
#           - xml
#           - txt

# system:
#   # Asociate different platform names to your current file system platform names
#   # [your custom platform folder name]: [RomM platform name]
#   # In this example if you have a 'gc' folder, RomM will treat it like the 'ngc' folder
#   platforms:
#     gc: ngc
#     ps1: psx

#   # Asociate one platform to it's main version (IGDB only)
#   versions:
#     naomi: arcade

# filesystem:
#   # Custom games folder name only (eg. `retro_games/`)
#   roms_folder: 'roms'
#   # Skip file hash calculations on low power devices (eg. Raspberry PI)
#   skip_hash_calculation: false

# scan:
#   # Metadata priority during scans
#   priority:
#     # Below are the default priority values used
#     metadata: # Top-level metadata source priority
#       - igdb # IGDB (highest priority)
#       - moby # MobyGames
#       - ss # Screenscraper
#       - ra # RetroAchievements
#       - launchbox # Launchbox
#       - gamelist # ES-DE gamelist.xml
#       - hasheous # Hasheous
#       - flashpoint # Flashpoint Project
#       - hltb # HowLongToBeat (lowest priority)
#     artwork: # Cover art and screenshots (fallback for the fields below)
#       - igdb # IGDB
#       - moby # MobyGames
#       - ss # Screenscraper
#       - ra # RetroAchievements
#       - launchbox # Launchbox
#       - libretro # Libretro
#       - gamelist # ES-DE gamelist.xml
#       - hasheous # Hasheous
#       - flashpoint # Flashpoint Project
#       - hltb # HowLongToBeat
#     # Optional per-field overrides. Each falls back to "artwork" when omitted,
#     # so you can, for example, keep original box art while pulling screenshots
#     # from a different source.
#     cover: # Cover art only
#       - igdb
#       - ss
#     screenshot: # Screenshots only
#       - ss
#       - igdb
#     manual: # Game manuals only
#       - launchbox
#     region: # Used by IGDB and ScreenScraper for regional variants
#       - us
#       - wor
#       - ss
#       - eu
#       - jp
#     language: # Used by ScreenScraper for descriptions
#       - en
#       - fr
#     # Media assets to download
#     # Only used by Screenscraper and ES-DE gamelist.xml
#   media:
#     # Used as alternative cover art
#     - box2d  # Normal cover art (always enabled)
#     - box3d  # 3D box art
#     - miximage  # Mixed image of multiple media (v1 / mixrbv1)
#     - miximage_v2  # Mixed image of multiple media (v2 / mixrbv2)
#     - physical  # Disc, cartridge, etc.
#     # Added to the screenshots carousel
#     - screenshot  # Screenshot (enabled by default)
#     - title_screen  # Title screen
#     - fanart  # User uploaded artwork
#     # Bezel displayed around the emulatorjs window
#     - bezel
#     # Manual in PDF format
#     - manual # Manual (enabled by default)
#     # Gameplay video
#     - video  # Video (warning: large file size)
#     - video_normalized  # Normalized video (smaller file size than video)
#     # Media used for batocera gamelist.xml export
#     - box2d_back  # Back cover art
#     - box2d_side  # Box spine (enables the interactive 3D box on detail pages)
#     - logo  # Transparent logo
#     # Other media assets (might be used in the future)
#     - marquee  # Custom marquee
#   # Auto-export metadata files after scan completes
#   gamelist:
#     export: false # Whether to export gamelist.xml for ES-DE/Batocera/RetroBAT
#     media:
#       # Select a media type from the list above (eg. box2d, screenshot, etc.)
#       thumbnail: box2d # Use as the <thumbnail> tag in the exported gamelist.xml
#       image: screenshot  # Use as the <image> tag in the exported gamelist.xml
#   pegasus:
#     export: false # Whether to export metadata.pegasus.txt for Pegasus

# EmulatorJS per-core options
# emulatorjs:
#   debug: true # Available options will be logged to the browser console
#   cache_limit: null # Cache limit per ROM (in bytes)
#   disable_batch_bootup: false
#   disable_auto_unload: false
#   settings:
#     parallel_n64: # Use the exact core name
#       vsync: disabled
#     snes9x:
#       snes9x_region: ntsc
#     default: # These settings apply to all cores
#       fps: show
#   netplay:
#     enabled: true
#     ice_servers:
#       - urls: "stun:stun.relay.metered.ca:80"
#       - urls: "turn:global.relay.metered.ca:80"
#         username: "<username>"
#         credential: "<password>"
#   controls: # https://emulatorjs.org/docs4devs/control-mapping/
#     snes9x:
#       0: # Player 1
#         0: # A MAPPING FOR EACH BUTTON MUST BE SET!
#           value: x # Mapping for keyboard
#           value2: BUTTON_2 # Mapping for connected controller
#       1: # Player 2
#       2: # Player 3
#       3: # Player 4

# streaming:
#   enabled: true
#   containers:
#     - platform: ps2
#       # Browser-facing Selkies web UI, MUST be served over https
#       # (use a reverse proxy or the built in self signed cert for linuxserver)
#       # can also be a FQDN eg. https://your.example.com
#       host: https://192.168.1.51:3001
#
#       # server-to-broker URL does NOT need to be served over https
#       # If pcsx2 emulator is on a different host, use its LAN IP.
#       # If on the same Docker network, use the container name: http://pcsx2:8000
#       broker_host: http://192.168.1.51:8000
#       # what shows up on the play button
#       label: PCSX2
#
#     # Add more emulator containers here as needed:
#     # - platform: psx
#     #   host: http://192.168.1.51:3002
#     #   broker_host: http://192.168.1.51:8001
#     #   label: DuckStation