Skip to content

Commit 722ef43

Browse files
committed
docs: list openvgdb and emuready providers in readme and env example
1 parent 91a5363 commit 722ef43

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

.env.example

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,18 @@ MOBYGAMES_API_KEY=YOUR_MOBYGAMES_API_KEY
3737
# exposed by playmatch for this provider.
3838
# EMUREADY_ENABLED=true
3939

40+
# OpenVGDB is a bulk metadata source distributed as a small SQLite snapshot
41+
# (~9 MB zip). Setting OPENVGDB_ENABLED=true enables a daily download of the
42+
# OpenVGDB release zip and the import of its ROMs and RELEASES tables into
43+
# local Postgres tables. Matching is hash-first (CRC, MD5, SHA1) against the
44+
# imported tables; no calls leave the box at match time. The dataset is
45+
# updated infrequently upstream, so the md5-skip check normally short-circuits
46+
# subsequent imports at no cost.
47+
# OPENVGDB_ENABLED=true
48+
# Optional override for the release zip URL. Defaults to the GitHub latest
49+
# release asset when omitted.
50+
# OPENVGDB_METADATA_URL=https://github.com/OpenVGDB/OpenVGDB/releases/latest/download/openvgdb.zip
51+
4052
# Pepper used for HMAC-SHA256 hashing of API keys. Generate with `openssl rand -hex 32`.
4153
# Must be at least 16 raw bytes (32 hex chars). Treat like a production secret.
4254
API_KEY_PEPPER=REPLACE_WITH_OUTPUT_OF_openssl_rand_hex_32

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@ The public API is available at [playmatch.retrorealm.dev](https://playmatch.retr
2626
- [x] Support for ScreenScraper as metadata provider
2727
- [x] Support for MobyGames as metadata provider
2828
- [x] Support for LaunchBox as metadata provider (bulk metadata import, opt-in via `LAUNCHBOX_ENABLED`)
29+
- [x] Support for OpenVGDB as metadata provider (offline SQLite hash matching, opt-in via `OPENVGDB_ENABLED`)
30+
- [x] Support for EmuReady as metadata provider (id-mapping only, opt-in via `EMUREADY_ENABLED`)
2931

3032
### Planned
3133

0 commit comments

Comments
 (0)