You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Mobygames API v2 and scraper doc update
- fix to catch empty API key for Mobygames
- fix edge case on tgdb scraper
- update map files (JSON files) for api scrapers
- added more libpng warnings to mute
- moved readJson() to parent class
Copy file name to clipboardExpand all lines: docs/PLATFORMS.md
+15-8Lines changed: 15 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ maintain local changes to the `platforms_idmap.csv` in a separate file with a
58
58
`peas.json` overwrites the one from `peas.json`. The same applies for the
59
59
platforms ID-mapping (see next section).
60
60
61
-
!!! tip
61
+
!!! tip "Avoid Duplication"
62
62
63
63
If you need a specific folder name for a platform (on your setup or due to an
64
64
EmulationStation theme) use a symbolic link (for example `megadrive` (=folder)
@@ -72,16 +72,21 @@ The second file is used for to instruct scrapers to lookup games by the numeric
72
72
platform identifier the scraping site uses for queries. The file
73
73
`platforms_idmap.csv` defines exact platform id for the web APIs of
74
74
Screenscraper, MobyGames and the GamesDB. It is a CSV file which maps the
75
-
platform handle (e.g. `megadrive`) to the respective platform id of the scraping
75
+
platform handle (e.g. `c64`) to the respective platform id of the scraping
76
76
site (selected with the CLI option `-s`):
77
77
78
78
```csv
79
79
folder,screenscraper_id,mobygames_id,tgdb_id
80
80
[...]
81
-
megadrive,1,16,36
81
+
c64,66,27,40
82
82
[...]
83
83
```
84
84
85
+
!!! tip "The Games DB"
86
+
87
+
The game data at TGDB is in rare case in different platforms to be found. Prominent example is Sega's Genesis respecitve Mega Drive. For these edgecases you may find the platform ids in the `platforms_idmap.csv` separated with an `|`. This means all platform ids will be tried to find a match in left-to-right order of the definition.
88
+
89
+
85
90
You can display the number with their platform name on each of the three
86
91
scraping sites in a more readable format with the script
87
92
`peas_and_idmap_verify.py`. Find the script sibling to the Skyscraper
@@ -90,13 +95,15 @@ site):
90
95
91
96
```
92
97
[...]
93
-
├── megadrive
94
-
│ ├── ScrS 1: Megadrive
95
-
│ ├── Moby 16: Genesis
96
-
│ └── TGDB 36: Sega Mega Drive
98
+
├── c64
99
+
│ ├── ScrS 66: Commodore 64
100
+
│ ├── Moby 27: Commodore 64
101
+
│ └── TGDB 40: Commodore 64
97
102
[...]
98
103
```
99
104
105
+
After the platform id is the textual representation the scraper source uses.
106
+
100
107
## How to Change Platform Aliases or Gamefile Extensions
101
108
102
109
Follow instructions in this section if you only want to overwrite platform alias
@@ -166,7 +173,7 @@ If you have multiple platforms defined in your local file make sure the platform
166
173
blocks are separated by a comma `,`.
167
174
168
175
169
-
!!! tip
176
+
!!! tip "Case-sensitivity in EmulationStation Configuration"
170
177
171
178
On RetroPie you may also have to edit `~/.emulationstation/es_systems.cfg` and
|[Internet Game DB (IGDB)](#igdb)| ✓ {title='Internet Game DB (IGDB)'} | ✓ {title='Internet Game DB (IGDB)'} | ✓ {title='Internet Game DB (IGDB)'} | ✓ {title='Internet Game DB (IGDB)'} | ✓ {title='Internet Game DB (IGDB)'} | ✓ {title='Internet Game DB (IGDB)'} | ✓ {title='Internet Game DB (IGDB)'} | ✓ {title='Internet Game DB (IGDB)'} | ✓ {title='Internet Game DB (IGDB)'} | ✓ {title='Internet Game DB (IGDB)'} | ✓ {title='Internet Game DB (IGDB)'} | {title='Internet Game DB (IGDB)'} | {title='Internet Game DB (IGDB)'} | {title='Internet Game DB (IGDB)'} | {title='Internet Game DB (IGDB)'} | {title='Internet Game DB (IGDB)'} | {title='Internet Game DB (IGDB)'} |
|[The Games DB](#thegamesdb-tgdb)| ✓ {title='The Games DB'} | ✓ {title='The Games DB'} | ✓ {title='The Games DB'} | ✓ {title='The Games DB'} | ✓ {title='The Games DB'} | ✓ {title='The Games DB'} | ✓ {title='The Games DB'} | {title='The Games DB'} | ✓ {title='The Games DB'} | ✓ {title='The Games DB'} | ✓ {title='The Games DB'} | {title='The Games DB'} | ✓ {title='The Games DB'} | ✓ {title='The Games DB'} | {title='The Games DB'} | {title='The Games DB'} | ✓ {title='The Games DB'} |
¹ Skyscraper uses ArcadeDB's Flyer and as a failsafe the Title screen, as Arcade games usually where not sold in a box
30
30
² GameBase provides only an adult flag, thus it is either 18 or no age rating
31
-
³ The source zxinfo.dk provides only an x-rated flag, thus it is either 18 or no age rating
31
+
³ The source zxinfo.dk provides only an x-rated flag, thus it is either 18 or no age rating
32
+
⁴ Release date will contain the first release date worldwde with Hobbyist API subscription. Age Recommendation, Rating, Max. Players, Video and release date per platform require an APIv2 Bronze subscription or higher. Skyscraper supporting anything else than a Hobbyist subscription is very unlikely.
32
33
33
34
### Recognized Keywords in Query
34
35
@@ -39,11 +40,11 @@ over a table cell to display the scraper module as tooltip:
39
40
| gamebase | Game filename, Game title and Game CRC (automatically detected). Except for CRC, globbing patterns (`*` and `'?`) can be used. |
40
41
| igdb | Title or use id=... to query by IGDB game ID |
41
42
| import | No query supported |
42
-
| mobygames | Title or numeric MobyGames ID (see _Identifiers_ section their website / on game details) |
43
+
| mobygames | Title or numeric MobyGames ID (see _Moby ID:_ right below the title when displaying a game on the website)|
43
44
| openretro | Only title |
44
45
| screenscraper | romnom=, crc=, md5=, sha1=; see [Screenscraper documentation](https://www.screenscraper.fr/webapi2.php?alpha=0&numpage=0#jeuInfos) for description |
45
46
| thegamesdb, tgdb | Only title |
46
-
| zxinfo (worldofspectrum) | Title, game Id (id=...) or game filehash (MD5 or SHA512) |
47
+
| zxinfo (worldofspectrum) | Title, game Id (id=...) or game filehash (MD5 or SHA512) |
47
48
48
49
!!! tip "Aliases for Game Filenames"
49
50
@@ -143,7 +144,7 @@ The database also supports many non-Amiga platforms, but there's no doubt that A
- Type: _File name_ or _Moby Games ID_ search based
147
+
- Type: _File name_ or _MobyGames ID_ search based
147
148
- User credential support: _None required_
148
149
- API request limit: _1 request per 5 seconds (Hobbyist subscription)_
149
150
- Thread limit: _1_
@@ -153,9 +154,23 @@ The database also supports many non-Amiga platforms, but there's no doubt that A
153
154
-`Skyscraper -p fba -s mobygames <SINGLE FILE TO SCRAPE>`
154
155
-`Skyscraper -p fba -s mobygames --startat <FILE TO START AT> --endat <FILE TO END AT>`
155
156
156
-
MobyGames. What can I say. If you haven't heard about this database before you've been missing out. It's one of the best and oldest games databases on the internet. You'll probably come across references to MobyGames on other sites when searching for retro games. There's a reason for that - it's that good.
157
+
MobyGames APIv2 imposes more limits than APIv1. Not only you will need a payed
158
+
subscription (to get an API key), but even with the entry-level (=Hobbyist)
159
+
subscription you cannot scrape the same data as with APIv1. These are the
160
+
limitations:
157
161
158
-
There's a caveat to the module as it requires a subscription to get an API key, but you get well curated game information especially for hard to find titles. Examine the possible options: https://www.mobygames.com/api/subscribe/. Once you have obtained an API key add it to the [userCreds](CONFIGINI.md#usercreds) configuration (without any colon) in the [mobygames] INI section.
162
+
- Release date will contain only the first release date worldwde with Hobbyist API
163
+
subscription.
164
+
- Age Recommendation, Rating, Maximum of Players, Video and release date per
165
+
platform require an APIv2 Bronze subscription or higher.
166
+
167
+
Skyscraper supporting anything else than a Hobbyist subscription is very
168
+
unlikely. It is saddening to see the service of MobyGames degrading after the
169
+
acquisition by Atari SA.
170
+
171
+
However, once you have obtained an API key (starting with `moby_...`) add it to
172
+
the [userCreds](CONFIGINI.md#usercreds) configuration (without any colon) in the
0 commit comments