From 0d1efeedff62637739eee21d23487bc8af5e2a2a Mon Sep 17 00:00:00 2001 From: zurdi Date: Tue, 13 May 2025 08:56:16 +0000 Subject: [PATCH] Refactor API key documentation: update MobyGames section and clarify IGDB and Screenscraper keys --- docs/Getting-Started/Generate-API-Keys.md | 16 ++++++++-------- docs/Getting-Started/Quick-Start-Guide.md | 5 ++--- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/Getting-Started/Generate-API-Keys.md b/docs/Getting-Started/Generate-API-Keys.md index 9ff2a33..3483e45 100644 --- a/docs/Getting-Started/Generate-API-Keys.md +++ b/docs/Getting-Started/Generate-API-Keys.md @@ -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`. - - -!!! 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`. + + +!!! important + MobyGames API became a [paid feature](https://www.mobygames.com/info/api/#non-commercial). diff --git a/docs/Getting-Started/Quick-Start-Guide.md b/docs/Getting-Started/Quick-Start-Guide.md index 358186b..13e2bee 100644 --- a/docs/Getting-Started/Quick-Start-Guide.md +++ b/docs/Getting-Started/Quick-Start-Guide.md @@ -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 !!! 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