Skip to content

Metadata Providers

General providers

IGDB

To access the IGDB API you'll need a Twitch account and a valid phone number for 2FA verification. Up-to-date instructions are available in the IGDB API documentation. When registering your application in the Twitch Developer Portal, fill out the form like so:

  • Name: Something unique or random like correct-horse-battery-staple or KVV8NDXMSRFJ2MRNPNRSL7GQT
  • OAuth Redirect URLs: localhost
  • Category: Application Integration
  • Client Type: Confidential

Important

The name you pick has to be unique! Picking an existing name will fail silently, with no error messages. We recommend using romm-<random hash>, like romm-3fca6fd7f94dea4a05d029f654c0c44b

Note the client ID and secret that appear on screen, and use them to set IGDB_CLIENT_ID and IGDB_CLIENT_SECRET in your environment variables.

IGDB Creation IGDB Secret

ScreenScraper

To access the ScreenScraper API, create a ScreenScraper and copy the user and password you just created to SCREENSCRAPER_USER and SCREENSCRAPER_PASSWORD respectively.

MobyGames

To access the MobyGames API, create a MobyGames account and then visit your profile page. Click the API link under your user name to sign up for an API key. Copy the key shown and use it to set MOBYGAMES_API_KEY.

Important

MobyGames API became a paid feature. RomM will still support it but we won't release any new feature for it.

Artwork providers

SteamGridDB

To access steamGridDB API, you need to login into their website with a steam account. Once logged in, go to your API tab under the preferences page. Copy the key shown and use it to set STEAMGRIDDB_API_KEY.

SteamGridDB only provides custom cover art for games or collections. It's not accessed through the scanner but from the search cover button when manually editing a game.

Achievements providers

Retroachievements

RomM is able to display your achievements from Retroachievements. To sync it with your RomM instance, you need to generate an API key from your Retroechievements account in your settings

RA API key

Copy the key shown and use it to set RETROACHIEVEMENTS_API_KEY and perform a partial scan targeting the platform you want to match with Retroachievements.

After that, each user need to set their own username in their profile and sync it with Retroachievements. A new retroachievements tab will appear in the personal tab in the game details.

RA details

To avoid unneccessary API calls, a cached file with the RA database is stored in RomM. Refresh time for that cache file can be changed with the env variable REFRESH_RETROACHIEVEMENTS_CACHE_DAYS