From d8d58afcec8b318bdf9a27f109752bcfc73cb5dd Mon Sep 17 00:00:00 2001 From: Georges-Antoine Assi Date: Mon, 29 Sep 2025 11:24:57 -0400 Subject: [PATCH] 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 c419e0e..642821f 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 e29a3a8..80cfb2f 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 d482d4c..4307f3e 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.