Skip to content

docs(playmatch): update description and document manual match suggestions #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gantoine merged 1 commit into from
May 27, 2026
+8 −6
Merged

docs(playmatch): update description and document manual match suggestions #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/about/credits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This stack stands on an enormous amount of open-source work. In rough order of "
- [RetroAchievements](https://retroachievements.org/)
- [SteamGridDB](https://www.steamgriddb.com/)
- [Hasheous](https://hasheous.org/)
- [PlayMatch](https://github.com/RetroRealm/playmatch)
- [Playmatch](https://github.com/RetroRealm/playmatch)
- [LaunchBox Games Database](https://gamesdb.launchbox-app.com/)
- [TheGamesDB](https://thegamesdb.net/)
- [Flashpoint Archive](https://flashpointproject.github.io/flashpoint-database/)
Expand Down
12 changes: 7 additions & 5 deletions docs/getting-started/metadata-providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ Here are some combinations you can use based on your needs:

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

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

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

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

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).

### PlayMatch
### Playmatch

[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.
[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.

To enable PlayMatch, set `PLAYMATCH_API_ENABLED=true` in your environment variables.
To enable Playmatch, set `PLAYMATCH_API_ENABLED=true` in your environment variables.

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.

### SteamGridDB

Expand Down
Loading