Skip to content

Commit bc59b1b

Browse files
authored
Merge pull request #89 from DevYukine/docs/playmatch-update
docs(playmatch): update description and document manual match suggestions
2 parents 2fea79d + 7bccc22 commit bc59b1b

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

docs/about/credits.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ This stack stands on an enormous amount of open-source work. In rough order of "
4646
- [RetroAchievements](https://retroachievements.org/)
4747
- [SteamGridDB](https://www.steamgriddb.com/)
4848
- [Hasheous](https://hasheous.org/)
49-
- [PlayMatch](https://github.com/RetroRealm/playmatch)
49+
- [Playmatch](https://github.com/RetroRealm/playmatch)
5050
- [LaunchBox Games Database](https://gamesdb.launchbox-app.com/)
5151
- [TheGamesDB](https://thegamesdb.net/)
5252
- [Flashpoint Archive](https://flashpointproject.github.io/flashpoint-database/)

docs/getting-started/metadata-providers.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ Here are some combinations you can use based on your needs:
2929

3030
![Hasheous + IGDB + SteamGridDB + Retroachievements](../resources/metadata_providers/2dcovers.png)
3131

32-
#### The Twitch Fanboy: [IGDB](#igdb) + [PlayMatch](#playmatch)
32+
#### The Twitch Fanboy: [IGDB](#igdb) + [Playmatch](#playmatch)
3333

3434
- Supports the 200+ systems available on IGDB
3535
- Provides titles, descriptions, cover art and related games from IGDB
36-
- PlayMatch adds hash-based matching for unmatched files
36+
- Playmatch adds hash-based matching for unmatched files
3737
- **Use this if you want a single-provider solution**
3838

3939
#### The Quick Starter: [Hasheous](#hasheous)
@@ -97,11 +97,13 @@ You must run a LaunchBox metadata update (either manually, or scheduled via cron
9797

9898
Simply set `HASHEOUS_API_ENABLED=true` in your environment variables, and future scans will start using the [Hasheous API](https://hasheous.org/swagger/index.html).
9999

100-
### PlayMatch
100+
### Playmatch
101101

102-
[PlayMatch](https://github.com/RetroRealm/playmatch) is a hash-based matching service used in conjunction with IGDB to provide better matching for games, hosted by a member of our community.
102+
[Playmatch](https://github.com/RetroRealm/playmatch) is a free, open source and community driven hash based matching service supporting multiple metadata providers such as IGDB, ScreenScraper, SteamGridDB, Retroachievements and more, hosted by a member of our community.
103103

104-
To enable PlayMatch, set `PLAYMATCH_API_ENABLED=true` in your environment variables.
104+
To enable Playmatch, set `PLAYMATCH_API_ENABLED=true` in your environment variables.
105+
106+
When Playmatch is enabled, manually matching a ROM through the edit dialog also forwards the ROM's hashes, filename, filesize and resolved provider IDs as a suggestion to Playmatch. Suggestions are reviewed manually before being added to the Playmatch database, which helps improve match quality for the wider community over time.
105107

106108
### SteamGridDB
107109

0 commit comments

Comments
 (0)