From e3dd719239948446afed18cd326d1ce28269ccf8 Mon Sep 17 00:00:00 2001 From: FallenWyvern Date: Mon, 29 Sep 2025 00:15:05 -0400 Subject: [PATCH 1/4] Updating some documentation for 4.3 Updating some documentation for 4.3: * Library Management now mentions the HLTB tab. * Metadata providers updated for HLTB and Flashpoint * Configuration-FIle updated with examples for priority. --- docs/Getting-Started/Configuration-File.md | 39 ++++++++++++++++++++++ docs/Getting-Started/Metadata-Providers.md | 20 +++++++++++ docs/Usage/LibraryManagement.md | 4 ++- 3 files changed, 62 insertions(+), 1 deletion(-) diff --git a/docs/Getting-Started/Configuration-File.md b/docs/Getting-Started/Configuration-File.md index 2fc9d904..c419e0ee 100644 --- a/docs/Getting-Started/Configuration-File.md +++ b/docs/Getting-Started/Configuration-File.md @@ -88,6 +88,45 @@ filesystem: { roms_folder: "my_roms" } --- +### `scan` + +The metadata scanners can have their priority changed by your config.yaml file. See the [config.example.yaml](https://github.com/rommapp/romm/blob/master/examples/config.example.yml) for the default values. + +```yaml +priority: { "metadata", "artwork", "region", "language" } +``` + +- **metadata** + Changes the metadata provider preferred order for metadata sources. + Example: + + ```yaml + metadata: { "igdb", "moby", "ss", "ra", "lb", "hasheous", "flashpoint", "hltb" } + ``` + +- **artwork** + Changes the metadata provider preferred order for cover art and screenshots. + Example: + ```yaml + 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: + ```yaml + region: { "us", "wor", "ss", "eu", "jp" } + ``` + +- **language** + Changes the metadata provider preferred language for cover art and game title (only used by Screenscraper) + Example: + ```yaml + language: { "en", "fr" } + ``` + +--- + !!! tip You can find examples of full binded batocera or es-de config files. diff --git a/docs/Getting-Started/Metadata-Providers.md b/docs/Getting-Started/Metadata-Providers.md index de237a28..eeafb462 100644 --- a/docs/Getting-Started/Metadata-Providers.md +++ b/docs/Getting-Started/Metadata-Providers.md @@ -119,6 +119,26 @@ After that, each user need to set their own username in their profile and sync i To avoid unneccessary API calls, a cached file with the RA database is stored in RomM. Refresh time for that cache file can be changed with the env variable `REFRESH_RETROACHIEVEMENTS_CACHE_DAYS` +### Flashpoint +The [Flashpoint Project Database](https://flashpointproject.github.io/flashpoint-database/) is a project that enables metadata for 180,000+ flash and browser-based games. Enable this metadata source with the `FLASHPOINT_API-ENABLED=true` envrionment variable. If you are adding this provider to an existing RomM setup, perform a *partial search* with Flashpoint selected to update an existing platform. + +### How Long To Beat +The [How Long To Beat](https://howlongtobeat.com/) project provides game completion times for more than 84,000 games. Enable this metadata source with the `HLTB_API-ENABLED=true` envrionment variable. If you are adding this provider to an existing RomM setup, perform a *partial search* with Flashpoint selected to update an existing platform. + +Game completion times will be added to a new tab on the details page for supported matched games. + +## Metadata Tags in Filenames +Scans will now parse custom metadata tags in the filename that match specific patterns, and use them to fetch game metadata for the specified ID. The supported tags are: + +(igdb-xxxx) for [IGDB](https://www.igdb.com/) +(moby-xxxx) for [MobyGames](https://www.mobygames.com/) +(ra-xxxx) for [RetroAchievements](https://retroachievements.org/) +(ssfr-xxxx) for [ScreenScraper](https://screenscraper.fr/) +(launchbox-xxxx) for [Launchbox](https://gamesdb.launchbox-app.com/) +(hltb-xxxx) for [HowLongToBeat](https://howlongtobeat.com/) + +Filenames will not be renamed by RomM to add tags, as they are a non-standard formatting system and could create conflicts with other software. + ??? Screenshots ![RA API key](../resources/metadata_providers/1-ra.png) diff --git a/docs/Usage/LibraryManagement.md b/docs/Usage/LibraryManagement.md index 6ba14dca..5efd323d 100644 --- a/docs/Usage/LibraryManagement.md +++ b/docs/Usage/LibraryManagement.md @@ -136,4 +136,6 @@ The Details tab includes metadata for the game. This will show where the data co The Game Data tab includes save files and save states, the ability to upload and download them, as well as delete them. This data is personal to the logged in user. -Finally the personal tab has check boxes denoting if a game is backlogged, being played, or if it should be hidden. User data such as rating, difficulty, % completed, and the status of the game can also be set here. Retroachievements can be viewed from this tab. +Finally the Personal tab has check boxes denoting if a game is backlogged, being played, or if it should be hidden. User data such as rating, difficulty, % completed, and the status of the game can also be set here. Retroachievements can be viewed from this tab for supported matched games. + +If How Long To Beat is enabled as a metadata provider, there will also be a tab here for viewing that data as well. \ No newline at end of file From d87636ae6cb52738b19854c15cc898d468d54ccf Mon Sep 17 00:00:00 2001 From: FallenWyvern Date: Mon, 29 Sep 2025 00:27:06 -0400 Subject: [PATCH 2/4] Corrected api env var Corrected api env var --- docs/Getting-Started/Metadata-Providers.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/Getting-Started/Metadata-Providers.md b/docs/Getting-Started/Metadata-Providers.md index eeafb462..36324c03 100644 --- a/docs/Getting-Started/Metadata-Providers.md +++ b/docs/Getting-Started/Metadata-Providers.md @@ -120,10 +120,10 @@ After that, each user need to set their own username in their profile and sync i To avoid unneccessary API calls, a cached file with the RA database is stored in RomM. Refresh time for that cache file can be changed with the env variable `REFRESH_RETROACHIEVEMENTS_CACHE_DAYS` ### Flashpoint -The [Flashpoint Project Database](https://flashpointproject.github.io/flashpoint-database/) is a project that enables metadata for 180,000+ flash and browser-based games. Enable this metadata source with the `FLASHPOINT_API-ENABLED=true` envrionment variable. If you are adding this provider to an existing RomM setup, perform a *partial search* with Flashpoint selected to update an existing platform. +The [Flashpoint Project Database](https://flashpointproject.github.io/flashpoint-database/) is a project that enables metadata for 180,000+ flash and browser-based games. Enable this metadata source with the `FLASHPOINT_API_ENABLED=true` envrionment variable. If you are adding this provider to an existing RomM setup, perform a *partial search* with Flashpoint selected to update an existing platform. ### How Long To Beat -The [How Long To Beat](https://howlongtobeat.com/) project provides game completion times for more than 84,000 games. Enable this metadata source with the `HLTB_API-ENABLED=true` envrionment variable. If you are adding this provider to an existing RomM setup, perform a *partial search* with Flashpoint selected to update an existing platform. +The [How Long To Beat](https://howlongtobeat.com/) project provides game completion times for more than 84,000 games. Enable this metadata source with the `HLTB_API_ENABLED=true` envrionment variable. If you are adding this provider to an existing RomM setup, perform a *partial search* with Flashpoint selected to update an existing platform. Game completion times will be added to a new tab on the details page for supported matched games. From eb1292a7abc97656e3689fc9188e6bce4306e047 Mon Sep 17 00:00:00 2001 From: FallenWyvern Date: Mon, 29 Sep 2025 09:49:29 -0400 Subject: [PATCH 3/4] Update Metadata-Providers.md Pushed metadata tag organization below the screenshots to maintain retroarch continuity. --- docs/Getting-Started/Metadata-Providers.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Getting-Started/Metadata-Providers.md b/docs/Getting-Started/Metadata-Providers.md index 36324c03..e29a3a80 100644 --- a/docs/Getting-Started/Metadata-Providers.md +++ b/docs/Getting-Started/Metadata-Providers.md @@ -119,6 +119,11 @@ After that, each user need to set their own username in their profile and sync i To avoid unneccessary API calls, a cached file with the RA database is stored in RomM. Refresh time for that cache file can be changed with the env variable `REFRESH_RETROACHIEVEMENTS_CACHE_DAYS` + +??? Screenshots + ![RA API key](../resources/metadata_providers/1-ra.png) + ![RA details](../resources/metadata_providers/2-ra.png) + ### Flashpoint The [Flashpoint Project Database](https://flashpointproject.github.io/flashpoint-database/) is a project that enables metadata for 180,000+ flash and browser-based games. Enable this metadata source with the `FLASHPOINT_API_ENABLED=true` envrionment variable. If you are adding this provider to an existing RomM setup, perform a *partial search* with Flashpoint selected to update an existing platform. @@ -138,8 +143,3 @@ Scans will now parse custom metadata tags in the filename that match specific pa (hltb-xxxx) for [HowLongToBeat](https://howlongtobeat.com/) Filenames will not be renamed by RomM to add tags, as they are a non-standard formatting system and could create conflicts with other software. - - -??? Screenshots - ![RA API key](../resources/metadata_providers/1-ra.png) - ![RA details](../resources/metadata_providers/2-ra.png) From d8d58afcec8b318bdf9a27f109752bcfc73cb5dd Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Mon, 29 Sep 2025 11:24:57 -0400 Subject: [PATCH 4/4] run trunk fmt --- docs/Getting-Started/Configuration-File.md | 10 +++++++--- docs/Getting-Started/Metadata-Providers.md | 9 ++++++--- docs/Usage/LibraryManagement.md | 2 +- 3 files changed, 14 insertions(+), 7 deletions(-) diff --git a/docs/Getting-Started/Configuration-File.md b/docs/Getting-Started/Configuration-File.md index c419e0ee..642821f0 100644 --- a/docs/Getting-Started/Configuration-File.md +++ b/docs/Getting-Started/Configuration-File.md @@ -93,7 +93,7 @@ filesystem: { roms_folder: "my_roms" } The metadata scanners can have their priority changed by your config.yaml file. See the [config.example.yaml](https://github.com/rommapp/romm/blob/master/examples/config.example.yml) for the default values. ```yaml -priority: { "metadata", "artwork", "region", "language" } +priority: { "metadata", "artwork", "region", "language" } ``` - **metadata** @@ -101,19 +101,23 @@ priority: { "metadata", "artwork", "region", "language" } Example: ```yaml - metadata: { "igdb", "moby", "ss", "ra", "lb", "hasheous", "flashpoint", "hltb" } + metadata: + { "igdb", "moby", "ss", "ra", "lb", "hasheous", "flashpoint", "hltb" } ``` - **artwork** Changes the metadata provider preferred order for cover art and screenshots. Example: + ```yaml - artwork: { "igdb", "moby", "ss", "ra", "lb", "hasheous", "flashpoint", "hltb" } + 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: + ```yaml region: { "us", "wor", "ss", "eu", "jp" } ``` diff --git a/docs/Getting-Started/Metadata-Providers.md b/docs/Getting-Started/Metadata-Providers.md index e29a3a80..80cfb2fa 100644 --- a/docs/Getting-Started/Metadata-Providers.md +++ b/docs/Getting-Started/Metadata-Providers.md @@ -125,14 +125,17 @@ To avoid unneccessary API calls, a cached file with the RA database is stored in ![RA details](../resources/metadata_providers/2-ra.png) ### Flashpoint -The [Flashpoint Project Database](https://flashpointproject.github.io/flashpoint-database/) is a project that enables metadata for 180,000+ flash and browser-based games. Enable this metadata source with the `FLASHPOINT_API_ENABLED=true` envrionment variable. If you are adding this provider to an existing RomM setup, perform a *partial search* with Flashpoint selected to update an existing platform. + +The [Flashpoint Project Database](https://flashpointproject.github.io/flashpoint-database/) is a project that enables metadata for 180,000+ flash and browser-based games. Enable this metadata source with the `FLASHPOINT_API_ENABLED=true` envrionment variable. If you are adding this provider to an existing RomM setup, perform a _partial search_ with Flashpoint selected to update an existing platform. ### How Long To Beat -The [How Long To Beat](https://howlongtobeat.com/) project provides game completion times for more than 84,000 games. Enable this metadata source with the `HLTB_API_ENABLED=true` envrionment variable. If you are adding this provider to an existing RomM setup, perform a *partial search* with Flashpoint selected to update an existing platform. -Game completion times will be added to a new tab on the details page for supported matched games. +The [How Long To Beat](https://howlongtobeat.com/) project provides game completion times for more than 84,000 games. Enable this metadata source with the `HLTB_API_ENABLED=true` envrionment variable. If you are adding this provider to an existing RomM setup, perform a _partial search_ with Flashpoint selected to update an existing platform. + +Game completion times will be added to a new tab on the details page for supported matched games. ## Metadata Tags in Filenames + Scans will now parse custom metadata tags in the filename that match specific patterns, and use them to fetch game metadata for the specified ID. The supported tags are: (igdb-xxxx) for [IGDB](https://www.igdb.com/) diff --git a/docs/Usage/LibraryManagement.md b/docs/Usage/LibraryManagement.md index d482d4c5..4307f3ed 100644 --- a/docs/Usage/LibraryManagement.md +++ b/docs/Usage/LibraryManagement.md @@ -144,4 +144,4 @@ The Game Data tab includes save files and save states, the ability to upload and Finally the Personal tab has check boxes denoting if a game is backlogged, being played, or if it should be hidden. User data such as rating, difficulty, % completed, and the status of the game can also be set here. Retroachievements can be viewed from this tab for supported matched games. -If How Long To Beat is enabled as a metadata provider, there will also be a tab here for viewing that data as well. \ No newline at end of file +If How Long To Beat is enabled as a metadata provider, there will also be a tab here for viewing that data as well.