working on a new config file

config-example.yml

@@ -0,0 +1,166 @@
+# 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
+#       - "igdb" # IGDB
+#       - "moby" # MobyGames
+#       - "ss" # Screenscraper
+#       - "ra" # RetroAchievements
+#       - "launchbox" # Launchbox
+#       - "gamelist" # ES-DE gamelist.xml
+#       - "hasheous" # Hasheous
+#       - "flashpoint" # Flashpoint Project
+#       - "hltb" # HowLongToBeat
+#     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
+#     - 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
+#     - logo  # Transparent logo
+#     # Other media assets (might be used in the future)
+#     - marquee  # Custom marquee
+
+# 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

config.yml

@@ -1,97 +1,64 @@
-emulatorjs:
+# exclude:
-  cache_limit: null
+#   # Exclude platforms to be scanned
-  controls: {}
+#   platforms:
-  debug: false
+#     - excluded_folder_a
-  disable_auto_unload: false
+#     - excluded_folder_b
-  disable_batch_bootup: false
+
-  netplay:
+#   # Exclude ROMs or parts of ROMs to be scanned
-    enabled: false
+#   roms:
-    ice_servers: []
+#     # Single file games section.
-  settings: {}
+#     # Will not apply to files that are in sub-folders (multi-disc ROMs, games with updates, DLC, patches, etc.)
-exclude:
+#     single_file:
-  platforms: &id001
+#       # Exclude all files with certain extensions to be scanned
-  - '@eaDir'
+#       extensions:
-  - __MACOSX
+#         - xml
-  - $RECYCLE.BIN
+#         - txt
-  - .Trash-*
+
-  - .stfolder
+#       # Exclude matched file names to be scanned
-  - .Spotlight-V100
+#       # Supports unix filename pattern matching
-  - .fseventsd
+#       names:
-  - .DocumentRevisions-V100
+#         - 'info.txt'
-  - System Volume Information
+#         - '._*'
-  roms:
+#         - '*.nfo'
-    multi_file:
+
-      names: *id001
+#     # Multi files games section
-      parts:
+#     # Will apply to files that are in sub-folders (multi-disc ROMs, games with updates, DLC, patches, etc.)
-        extensions:
+#     multi_file:
-        - db
+#       # Exclude matched 'folder' names to be scanned (RomM identifies folders as multi file games)
-        - ini
+#       # Common ES-DE media folders are listed below
-        - tmp
+#       names:
-        - bak
+#         - 3dboxes
-        - lock
+#         - backcovers
-        - log
+#         - covers
-        - cache
+#         - fanart
-        - crdownload
+#         - manuals
-        names: &id002
+#         - marquees
-        - .DS_Store
+#         - miximages
-        - .localized
+#         - physicalmedia
-        - .Trashes
+#         - screenshots
-        - .stfolder
+#         - titlescreens
-        - '@SynoResource'
+#         - videos
-        - gamelist.xml
+#         - downloaded_media
-    single_file:
+#         - media
-      extensions:
+
-      - db
+#       # Exclude files within sub-folders.
-      - ini
+#       parts:
-      - tmp
+#         # Exclude matched file names to be scanned from multi file roms
-      - bak
+#         # Keep in mind that RomM doesn't scan folders inside multi files games,
-      - lock
+#         # so there is no need to exclude folders from inside of multi files games.
-      - log
+#         names:
-      - cache
+#           - 'data.xml'
-      - crdownload
+#           - '._*' # Supports unix filename pattern matching
-      names: *id002
+
-filesystem:
+#         # Exclude all files with certain extensions to be scanned from multi file roms
-  firmware_folder: bios
+#         extensions:
-  roms_folder: roms
+#           - xml
-scan:
+#           - txt
-  export_gamelist: false
+
-  media:
-  - box2d
-  - screenshot
-  - manual
-  priority:
-    artwork:
-    - igdb
-    - moby
-    - ss
-    - ra
-    - launchbox
-    - gamelist
-    - hasheous
-    - tgdb
-    - flashpoint
-    - hltb
-    language:
-    - en
-    - fr
-    metadata:
-    - igdb
-    - moby
-    - ss
-    - ra
-    - launchbox
-    - gamelist
-    - hasheous
-    - tgdb
-    - flashpoint
-    - hltb
-    region:
-    - us
-    - wor
-    - ss
-    - eu
-    - jp
  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:
     Atari 2600: atari2600
     Atari 5200: atari5200
@@ -146,4 +113,101 @@ system:
     Sony Playstation Vita:
     WonderSwan: wonderswan
     WonderSwan Color: wonderswan-color
-  versions: {}
+ 
+#   # 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
+#       - "igdb" # IGDB
+#       - "moby" # MobyGames
+#       - "ss" # Screenscraper
+#       - "ra" # RetroAchievements
+#       - "launchbox" # Launchbox
+#       - "gamelist" # ES-DE gamelist.xml
+#       - "hasheous" # Hasheous
+#       - "flashpoint" # Flashpoint Project
+#       - "hltb" # HowLongToBeat
+#     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
+#     - 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
+#     - logo  # Transparent logo
+#     # Other media assets (might be used in the future)
+#     - marquee  # Custom marquee
+
+# 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