Skip to content

Commit 232c257

Browse files
authored
ZX-Spectrum: change worldofspectrum.org to zxinfo.dk (web API). (#154)
- Updated documentation for new changed scraping site for ZX-Spectrum. - Fixes #122
1 parent 5964145 commit 232c257

15 files changed

Lines changed: 411 additions & 245 deletions

docs/CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,11 @@ humans](https://keepachangelog.com).
1717
is now optional. It gets added automagically when no other query keyword is
1818
applied.
1919
- Updated: `mamemap.csv` for MAME 0.275
20-
- Fixed: TGDB scraper now tries harder to get wheel/logo mediafiles.
20+
- Fixed: (#122) Updated ZX-Spectrum scraper module. It uses now the site
21+
`zxinfo.dk` and a web API. The API provides at least the same information as
22+
the defunct search on `worldofspectrum.org`. Check out the added `--query=`
23+
options for the [ZXInfo scraper](CLIHELP.md#-query-string).
24+
- Fixed: (#136) TGDB scraper now tries harder to get wheel/logo mediafiles.
2125
Thanks for reporting, @joyrider3774.
2226

2327
### Version 3.16.0 (2025-03-10)

docs/CLIHELP.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -686,25 +686,32 @@ If you apply the query option with a game filename, the flag `--refresh` (see be
686686

687687
Not all of the scraping modules are search name based. For instance, the `screenscraper` module can use a variety of different search methods. So for screenscraper you also have the option of overriding the checksums it uses to search for a game. This is especially convenient in cases where a filename exists multiple times in their database and your own local file doesn't match with any of the connected checksums (maybe you've compressed the rom yourself). In this case you can look up one of the working checksums on the Screenscraper website (screenscraper.fr) and override the checksum.
688688

689-
You can use any combination of `crc=<CHECKSUM>`, `md5=<CHECKSUM>`, `sha1=<CHECKSUM>` and `romnom=<FILENAME>` (without the `<` and `>`! Also "romnom" is "rom name" in French - Screenscraper is operated from France). Most times you only need one of these, but you can combine them by separating them with a `&`.
689+
You can use any combination of `crc=<CHECKSUM>`, `md5=<CHECKSUM>`, `sha1=<CHECKSUM>` and `romnom=<FILENAME>` (without the `<` and `>`! Also "romnom" is "rom name" in French - Screenscraper is operated from France). From Skyscraper 3.17 onwards you can also omit the `romnom=` search keyword when using the title search. Most times you only need one of these, but you can combine them by separating them with a `&`.
690690

691-
The Mobygames scraper supports the romname directly in the `--query` parameter, but also accepts the game id from the mobygames site which you can find when manually looking up a game in the "Identifiers" section of the game details page (lower third of page).
691+
The `mobygames` scraper supports the romname directly in the `--query` parameter, but also accepts the game id from the mobygames site which you can find when manually looking up a game in the _"_Identifiers_"_ section of the game details page (lower third of page).
692+
693+
The `zxinfo` (formerly `worldofspectrum`) scraper supports the romname directly in the `--query` parameter, but also accepts the game id from the ZXInfo site in URL of the detail page of a game. E.g., `https://zxinfo.dk/details/0001303`, has the id `1303` in the URL path, valid queries with id are either `--query="id=1303"` or `--query="01303"`. Note the heading `0` in the latter case, if it is missing Skyscraper will search with a game title containing _1303_. Also you can search by MD5 or SHA512 (sic!) hash of your local ZX-Spectrum game file. To do so, provide either the 32 character hexstring of `md5sum <gamefile>` hash or the 128 character hexstring of `sha512sum <gamefile>`.
692694

693695
For other scraping module's query capabilities see the [overview page](SCRAPINGMODULES.md#recognized-keywords-in-query).
694696

695697
!!! tip
696698

697-
The `--query` option is an advanced option, but it's very useful to get results for those last difficult roms missing in your gamelist.
699+
The `--query` option is an advanced option, but it's very useful to get results for those last difficult roms missing in your gamelist. You may also want to add `--flags interactive` to overrule the automatic matching of gametitle and gamefile of Skyscraper.
698700

699701
**Example(s)**
700702

701703
```
702704
$ Skyscraper -p snes -s thegamesdb --query "rick+dangerous" /absolute/or/relative/path/to/rom.zip
703705
$ Skyscraper -p snes -s screenscraper --query "md5=<CHECKSUM>" /absolute/or/relative/path/to/rom.zip
704-
$ Skyscraper -p snes -s screenscraper --query "romnom=file%20name.zip" /absolute/or/relative/path/to/rom.zip
705-
$ Skyscraper -p snes -s screenscraper --query "sha1=<CHECKSUM>&romnom=file%20name.zip" /absolute/or/relative/path/to/rom.zip
706+
$ Skyscraper -p snes -s screenscraper --query "<game title> or <romfile>" /absolute/or/relative/path/to/rom.zip
707+
$ Skyscraper -p snes -s screenscraper --query "sha1=<CHECKSUM>&romnom=yaddayadda" /absolute/or/relative/path/to/rom.zip
708+
# 14576 is the MobyGames Game Id
706709
$ Skyscraper -p ports -s mobygames --query "14576" "~/RetroPie/roms/ports/Head over Heels.sh"
707710
$ Skyscraper -p zxspectrum -s gamebase --query "*Deathc*" --verbosity 3 "~/RetroPie/roms/zxspectrum/game.tzx
711+
# 1303 is the ZXInfo / World of Spectrum Game Id
712+
$ Skyscraper -p zxspectrum -s zxinfo --query "01303" "~/RetroPie/roms/zxspectrum/Deathchase.zip
713+
# 4443397... is the MD5 hashsum of Deathchase.zip for example
714+
$ Skyscraper -p zxspectrum -s zxinfo --query "4443397ad973cc066e06d9854cc69035" "~/RetroPie/roms/zxspectrum/Deathchase.zip
708715
```
709716

710717
### --refresh

docs/IMPORT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The following describes how to import your own custom textual, artwork and / or
88

99
!!! info
1010

11-
Be sure to also check the `--cache edit` option [here](CLIHELP.md#--cache-editnewtype).
11+
Be sure to also check the `--cache edit` option [here](CLIHELP.md#-cache-editnewtype).
1212

1313
### Images, Videos and Game Manuals
1414

0 commit comments

Comments
 (0)