mirror of
https://github.com/rommapp/docs.git
synced 2026-04-23 06:54:41 +00:00
run trunk fmt
This commit is contained in:
@@ -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" }
|
||||
```
|
||||
|
||||
@@ -125,14 +125,17 @@ To avoid unneccessary API calls, a cached file with the RA database is stored in
|
||||

|
||||
|
||||
### 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/)
|
||||
|
||||
@@ -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.
|
||||
If How Long To Beat is enabled as a metadata provider, there will also be a tab here for viewing that data as well.
|
||||
|
||||
Reference in New Issue
Block a user