Skip to content

Commit 8a0df10

Browse files
committed
docs: list retroachievements provider in readme and env example
1 parent 1baac70 commit 8a0df10

2 files changed

Lines changed: 11 additions & 0 deletions

File tree

.env.example

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,16 @@ MOBYGAMES_API_KEY=YOUR_MOBYGAMES_API_KEY
4949
# release asset when omitted.
5050
# OPENVGDB_METADATA_URL=https://github.com/OpenVGDB/OpenVGDB/releases/latest/download/openvgdb.zip
5151

52+
# RetroAchievements requires a username + web API key (free; get one from
53+
# https://retroachievements.org/controlpanel.php). Both must be set together.
54+
# When enabled the provider bulk-imports every RA system, game, and MD5 hash
55+
# once per cycle (one API call per system, ~70 calls total with a 1s courtesy
56+
# delay between calls) and matches local ROMs by MD5 hash first then by name.
57+
# Custom-hash consoles (PS1, GameCube/DS, Dreamcast/Saturn, PCE-CD, 3DO,
58+
# Arcade) only match by name; plain-MD5 consoles match by hash.
59+
# RETROACHIEVEMENTS_USERNAME=YOUR_RA_USERNAME
60+
# RETROACHIEVEMENTS_API_KEY=YOUR_RA_WEB_API_KEY
61+
5262
# Pepper used for HMAC-SHA256 hashing of API keys. Generate with `openssl rand -hex 32`.
5363
# Must be at least 16 raw bytes (32 hex chars). Treat like a production secret.
5464
API_KEY_PEPPER=REPLACE_WITH_OUTPUT_OF_openssl_rand_hex_32

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ The public API is available at [playmatch.retrorealm.dev](https://playmatch.retr
2828
- [x] Support for LaunchBox as metadata provider (bulk metadata import, opt-in via `LAUNCHBOX_ENABLED`)
2929
- [x] Support for OpenVGDB as metadata provider (offline SQLite hash matching, opt-in via `OPENVGDB_ENABLED`)
3030
- [x] Support for EmuReady as metadata provider (id-mapping only, opt-in via `EMUREADY_ENABLED`)
31+
- [x] Support for RetroAchievements as metadata provider (bulk import via API, MD5 hash matching plus name fallback, opt-in via `RETROACHIEVEMENTS_USERNAME` + `RETROACHIEVEMENTS_API_KEY`)
3132

3233
### Planned
3334

0 commit comments

Comments
 (0)