From 21987767327d2d3ebdf1a9e90cdceb81020edd3d Mon Sep 17 00:00:00 2001 From: romm Date: Thu, 29 May 2025 15:07:29 +0000 Subject: [PATCH] Deployed 4d4dae4 to 3.9.0 with MkDocs 1.6.1 and mike 2.1.3 --- 3.9.0/404.html | 24 + .../Getting-Started/Authentication/index.html | 24 + .../Configuration-File/index.html | 1842 +++++++++++++++++ .../Environment-Variables/index.html | 24 + .../Folder-Structure/index.html | 113 +- .../Generate-API-Keys/index.html | 48 +- .../Quick-Start-Guide/index.html | 24 + .../Getting-Started/Reverse-Proxy/index.html | 24 + 3.9.0/Integrations/Playnite-plugin/index.html | 24 + 3.9.0/Integrations/muOS-app/index.html | 24 + 3.9.0/Maintenance/Scheduled-Tasks/index.html | 24 + 3.9.0/Maintenance/Upgrading-to-3.0/index.html | 24 + .../Miscellaneous/Brand-Guidelines/index.html | 24 + 3.9.0/Miscellaneous/FAQs/index.html | 24 + 3.9.0/Navigation/index.html | 27 +- .../OIDC-Setup-With-Authelia/index.html | 24 + .../OIDC-Setup-With-Authentik/index.html | 24 + .../OIDC-Setup-With-PocketID/index.html | 24 + .../Custom-Platforms/index.html | 24 + .../EmulatorJS-Player/index.html | 24 + .../RuffleRS-Player/index.html | 24 + .../Supported-Platforms/index.html | 29 +- .../Synology-Setup-Guide/index.html | 24 + .../Tinfoil-Integration/index.html | 24 + .../TrueNAS-Setup-Guide/index.html | 24 + .../Unraid-Setup-Guide/index.html | 24 + .../Tools/Igir-Collection-Manager/index.html | 24 + .../Authentication-Issues/index.html | 24 + .../Kubernetes-Issues/index.html | 24 + .../Miscellaneous-Troubleshooting/index.html | 24 + .../Scanning-Issues/index.html | 24 + .../Synology-Issues/index.html | 24 + .../Getting-Started/Configuration-File.png | Bin 0 -> 37763 bytes 3.9.0/index.html | 24 + 3.9.0/search/search_index.json | 2 +- 3.9.0/sitemap.xml | 4 + 3.9.0/sitemap.xml.gz | Bin 600 -> 613 bytes 37 files changed, 2709 insertions(+), 28 deletions(-) create mode 100644 3.9.0/Getting-Started/Configuration-File/index.html create mode 100644 3.9.0/assets/images/social/Getting-Started/Configuration-File.png diff --git a/3.9.0/404.html b/3.9.0/404.html index d00262f..80cbe83 100644 --- a/3.9.0/404.html +++ b/3.9.0/404.html @@ -290,6 +290,8 @@ + + @@ -372,6 +374,28 @@ +
  • + + + + + Configuration File + + + + + +
    • + + + + + + + + + +
  • diff --git a/3.9.0/Getting-Started/Authentication/index.html b/3.9.0/Getting-Started/Authentication/index.html index 5435fca..424d6d2 100644 --- a/3.9.0/Getting-Started/Authentication/index.html +++ b/3.9.0/Getting-Started/Authentication/index.html @@ -338,6 +338,8 @@ + + @@ -420,6 +422,28 @@ +
  • + + + + + Configuration File + + + + + +
    • + + + + + + + + + +
  • diff --git a/3.9.0/Getting-Started/Configuration-File/index.html b/3.9.0/Getting-Started/Configuration-File/index.html new file mode 100644 index 0000000..f3ab819 --- /dev/null +++ b/3.9.0/Getting-Started/Configuration-File/index.html @@ -0,0 +1,1842 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Configuration File - RomM + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + + + + + + +
    + + +
    + +
    + + + + + + +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + + + + + + +

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

      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' }
+
    +
    +
    +

    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.

    +
    + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + + +
    + + + +
    + + + +
    +
    +
    +
    + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/3.9.0/Getting-Started/Environment-Variables/index.html b/3.9.0/Getting-Started/Environment-Variables/index.html index 92e4e33..a76f2e4 100644 --- a/3.9.0/Getting-Started/Environment-Variables/index.html +++ b/3.9.0/Getting-Started/Environment-Variables/index.html @@ -338,6 +338,8 @@ + + @@ -420,6 +422,28 @@ +
  • + + + + + Configuration File + + + + + +
    • + + + + + + + + + +
  • diff --git a/3.9.0/Getting-Started/Folder-Structure/index.html b/3.9.0/Getting-Started/Folder-Structure/index.html index 84c0df7..e47c0e5 100644 --- a/3.9.0/Getting-Started/Folder-Structure/index.html +++ b/3.9.0/Getting-Started/Folder-Structure/index.html @@ -18,7 +18,7 @@ - + @@ -338,6 +338,8 @@ + + @@ -449,6 +451,39 @@ +
    • + +
  • + + + Configuration file + + + +
    • + +
  • + + + Naming Convention + + + + +
    • @@ -466,6 +501,28 @@ +
  • + + + + + Configuration File + + + + + +
    • + + + + + + + + + +
  • @@ -1498,6 +1555,39 @@ +
    • + +
  • + + + Configuration file + + + +
    • + +
  • + + + Naming Convention + + + + +
    • @@ -1563,7 +1653,7 @@

    Tip

    -

    For folder naming conventions, review the Platform Support section. To override default system names in the folder structure (if your directories are named differently), see the Configuration File section.

    +

    For folder naming conventions, review the Platform Support section. To override default system names in the folder structure (if your directories are named differently), see the Configuration File section.

    @@ -1676,7 +1766,18 @@

    Note

    RomM can be setup without a prior folder structure. If files are manually uploaded from the webUI, RomM will automatically create the folder Structure A

    -
    + +

    Configuration file

    +

    RomM's behavior can be customized using a config.yml file or through the Library Management page in the Settings menu. You can grab the example config.example.yml file and adapt it to your library.

    +

    What is shown in the Library Management page is the content of the config.yml. For more details read the configuration file section.

    +

    Naming Convention

    +

    Tag Support

    +

    Games can be tagged with region, revision, or other tags by using parentheses in the file name. Additionally, you can set the region and language by adding a prefix: (USA), [reg-J], (French), [De].

    + +

    Tags can be used to search for games in the search bar. For example, searching for (USA) will return all games with the USA tag.

    @@ -1699,7 +1800,7 @@ - 2025-05-29 + 2025-05-29 @@ -1763,13 +1864,13 @@ - +
    Next
    - Generate API Keys + Configuration File
    diff --git a/3.9.0/Getting-Started/Generate-API-Keys/index.html b/3.9.0/Getting-Started/Generate-API-Keys/index.html index 6906a8a..e721cd2 100644 --- a/3.9.0/Getting-Started/Generate-API-Keys/index.html +++ b/3.9.0/Getting-Started/Generate-API-Keys/index.html @@ -15,7 +15,7 @@ - + @@ -338,6 +338,8 @@ + + @@ -418,6 +420,28 @@ + + +
  • + + + + + Configuration File + + + + + +
    • + + + + + + + + @@ -1589,24 +1613,12 @@

    The name you pick has to be unique! Picking an existing name will fail silently, with no error messages. We recommend using romm-<random hash>, like romm-3fca6fd7f94dea4a05d029f654c0c44b

    Note the client ID and secret that appear on screen, and use them to set IGDB_CLIENT_ID and IGDB_CLIENT_SECRET in your environment variables.

    -
    - - - - - - - - - - - - -
    IGDB CreationIGDB Secret
    +

    IGDB Creation IGDB Secret

    ScreenScraper

    To access the ScreenScraper API, create a ScreenScraper and copy the user and password you just created to SCREENSCRAPER_USER and SCREENSCRAPER_PASSWORD respectively.

    SteamGridDB

    To access steamGridDB API, you need to login into their website with a steam account. Once logged in, go to your API tab under the preferences page. Copy the key shown and use it to set STEAMGRIDDB_API_KEY.

    +

    SteamGridDB only provides custom cover art for games or collections. It's not accessed through the scanner but from the search cover button when manually editing a game.

    MobyGames

    To access the MobyGames API, create a MobyGames account and then visit your profile page. Click the API link under your user name to sign up for an API key. Copy the key shown and use it to set MOBYGAMES_API_KEY.

    @@ -1636,7 +1648,7 @@ - 2025-05-13 + 2025-05-29 @@ -1683,7 +1695,7 @@