Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 43 additions & 0 deletions docs/Getting-Started/Configuration-File.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,49 @@ 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" }
```

---

<!-- prettier-ignore -->
!!! tip
You can find examples of full binded <a href="https://github.com/rommapp/romm/blob/master/examples/config.batocera-retrobat.yml" target="_blank" rel="noopener noreferrer">batocera</a> or <a href="https://github.com/rommapp/romm/blob/master/examples/config.es-de.example.yml" target="_blank" rel="noopener noreferrer">es-de</a> config files.
Expand Down
23 changes: 23 additions & 0 deletions docs/Getting-Started/Metadata-Providers.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,3 +123,26 @@ To avoid unneccessary API calls, a cached file with the RA database is stored in
??? 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.

### 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.
4 changes: 3 additions & 1 deletion docs/Usage/LibraryManagement.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,4 +142,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.