search

rommapp / romm

A beautiful, powerful, self-hosted rom manager
https://romm.app
GNU Affero General Public License v3.0
2.05k stars 88 forks source link

[Bug] Wiki: 2 SteamGridDB entries in Generate-API-Keys #1253

Closed nxadm closed 50 minutes ago

nxadm commented 2 hours ago

RomM version Live github version

Describe the bug In https://github.com/rommapp/romm/wiki/Generate-API-Keys there are 2 entries for SteamGridDB with the same information (but slightly different wording).

To Reproduce Steps to reproduce the behavior:

Go to https://github.com/rommapp/romm/wiki/Generate-API-Keys

Expected behavior Remove the first paragraph

Screenshots image

Desktop (please complete the following information): NA

Smartphone (please complete the following information): NA Additional context NA

nxadm commented 2 hours ago

Git diff:

diff --git a/Generate-API-Keys.md b/Generate-API-Keys.md
index d146074..180494f 100644
--- a/Generate-API-Keys.md
+++ b/Generate-API-Keys.md
@@ -1,6 +1,6 @@
 ## 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`.
+To access the SteamGridDB API, create an account by linking your Steam account, and head to your [API Preferences page](https://www.steamgriddb.com/profile/preferences/api). Copy (or generate) the API key and use it to set `STEAMGRIDDB_API_KEY`.

 ## Mobygames

@@ -15,7 +15,7 @@ To access the IGDB API you'll need a Twitch account and a valid phone number for
 * Category: `Application Integration`
 * Client Type: `Confidential`

-> [!IMPORTANT]
+> [!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.
@@ -23,3 +23,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)|
 |---|---|

+## 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`.
\ No newline at end of file
zurdi15 commented 50 minutes ago

Good catch! Fixed :). Updated the paywalled MobyGames API key info