rommapp/docs
1
0
Fork 0
mirror of https://github.com/rommapp/docs.git synced 2026-04-23 06:54:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor API key documentation: update MobyGames section and clarify IGDB and Screenscraper keys

Browse Source
This commit is contained in:
zurdi
2025-05-13 08:56:16 +00:00
parent 5695dde972
commit 0d1efeedff
2 changed files with 10 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Getting-Started/Generate-API-Keys.md
+8 -8
View File
@@ -16,14 +16,6 @@ Note the client ID and secret that appear on screen, and use them to set `IGDB_C
| ![IGDB Creation](https://github.com/rommapp/romm/assets/3247106/7a93bf68-f6d9-46a5-ab72-719f2d5ec9d3) | ![IGDB Secret](https://github.com/rommapp/romm/assets/3247106/7a9dc056-52be-41c4-aec5-e2758aa520b5) |
| ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
## MobyGames
To access the MobyGames API, [create a MobyGames account](https://www.mobygames.com/user/register/) 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`.
<!-- prettier-ignore -->
!!! important
MobyGames API became a [paid feature](https://www.mobygames.com/info/api/#non-commercial). Any existing key can be used as usual, but any new API key created will be under a paywall
## ScreenScraper
To access the ScreenScraper API, create a [ScreenScraper](https://www.screenscraper.fr/membreinscription.php) and copy the **user** and **password** you just created to `SCREENSCRAPER_USER` and `SCREENSCRAPER_PASSWORD` respectively.
@@ -31,3 +23,11 @@ To access the ScreenScraper API, create a [ScreenScraper](https://www.screenscra
## SteamGridDB
To access steamGridDB API, you need to login into their [website](https://www.steamgriddb.com/) with a [steam account](https://store.steampowered.com/join). Once logged in, go to your [API tab under the preferences page](https://www.steamgriddb.com/profile/preferences/api). Copy the key shown and use it to set `STEAMGRIDDB_API_KEY`.
## MobyGames
To access the MobyGames API, [create a MobyGames account](https://www.mobygames.com/user/register/) 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`.
<!-- prettier-ignore -->
!!! important
MobyGames API became a [paid feature](https://www.mobygames.com/info/api/#non-commercial).
docs/Getting-Started/Quick-Start-Guide.md
+2 -3
View File
@@ -15,16 +15,15 @@ This guide will assume that you already have the following done, if not - stop h
- 2-factor authentication set up on your Twitch account
- _This is required to get a developer account and an IGDB key_
- A [Screenscraper](https://www.screenscraper.fr/) account (optional)
- A [MobyGames](https://www.mobygames.com/) account (optional)
- Your ROMs organized in the correct format
<!-- prettier-ignore -->
!!! warning
Not setting up RomM with a metadata API will work for basic operation but can cause issues with, for instance, the Playnite plugin. It is recommended to setup IGDB API keys to avoid issues during setup.
### Twitch and MobyGames API Keys
### IGDB and Screenscraper API Keys
Head over to [API key docs](../Getting-Started/Generate-API-Keys.md) to get your Twitch and/or Screenscraper and/or MobyGames keys, then come back here
Head over to [API key docs](../Getting-Started/Generate-API-Keys.md) to get your IGDB and/or Screenscraper keys, then come back here
## Build