Wiki/wiki-rtd/docs/wiki_system_guides/es-de/esde-scraping.md

140 lines
6 KiB
Markdown
Raw Normal View History

2025-01-14 08:49:40 +00:00
# ES-DE Scraping
<img src="../../../wiki_icons/pixelitos/folder-blue-downloads.png" width="50">
2024-05-23 05:26:17 +00:00
Scraping is done via [Screenscraper](https://www.screenscraper.fr/) or [TGBD](https://thegamesdb.net/) in the ES-DE interface under scraping.
2025-01-14 08:49:40 +00:00
Scraping allows you to make the games look "pretty" with coverarts, icons, discimages and more.
Read up on the ES-DE userguide on scraping here:
[ES-DE Scraper guide](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#scraping)
### Quick tips
- On most occasions you want to use ScreenScraper and not TheGamesDB. But for PC titles scraping from TheGamesDB might be better.
- You will need to register an account on [ScreenScraper.fr](https://www.screenscraper.fr/) to scrape (support them on Patreon for faster downloads, more scrapes per day and priority scraping).
- Login to your Screenscraper.fr account inside of the ES-DE interface in RetroDECK
- Choose what content you want to scrape (remember that each content you choose could take up several mb of data per game).
- Do an initial scrape of all the games you want to scrape.
- If some games are missed do a more narrow scraping by enabling `Scraper -> Other Settings -> Interactive Mode -> On`& Scraper -> `Other Settings -> Auto-Accept Single Game Matches -> On` and choose to scrape by games missing metadata. This will allow you to select each game from a list and also tweak the searches of the missing games.
- In some cases you need to remove certain aspects of the name like if a rom comes both with a Japanese name and English name, you could try to remove one of the names to find a better result.
2024-05-23 05:26:17 +00:00
## Where is my scraped data?
In: `~/retrodeck/ES-DE/downloaded_media` folder.
## Can I add my own images, manuals, or other media?
2024-12-28 13:24:13 +00:00
The ES-DE Wiki has [Instructions: Manually copying game media files](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md?ref_type=heads#manually-copying-game-media-files) on adding your own media.
There's a handy spreadsheet that explains each media type:
[Spreadsheet: Media Types in ES-DE](https://docs.google.com/spreadsheets/d/18VJAL44aNxsFOd4pVAONmdWwa7srCSzr2Z2SJEiNKnE/edit?gid=1812680930#gid=1812680930)
2024-12-29 11:51:48 +00:00
Check the following guide.
2024-12-28 13:24:48 +00:00
2024-12-29 11:51:48 +00:00
### Guide: Manually adding game media files
2024-12-28 13:24:13 +00:00
If you already have a library of game media (images, videos and PDF manuals) you can manually copy these files into RetroDECK (ES-DE).
2024-12-29 13:18:48 +00:00
**Requirements & Tips:**
2024-12-28 13:24:13 +00:00
- Remember that on Linux filenames are case sensitive.
- The file extensions must be in lower case in ES-DE (`.png` instead of `.PNG` / `.Png`).
- The media files names must correspond exactly to the game files name.
- For directories interpreted as files games (like ScummVM) you will need to add the folder file extension to the media file name example: `dig.scummvm.png`.
- Supported image file extensions are: `.jpg` and `.png`.
2024-12-29 13:18:48 +00:00
- Supported document file extensions are: `.pdf`.
2024-12-28 13:24:13 +00:00
- Supported video file extensions are: `.avi` , `.mkv` , `.mov` , `.mp4` and `.wmv`.
The default media directory is: `~/retrodeck/ES-DE/downloaded_media/<system name>/<media type>/<files goes here>`
The following media type directories are supported:
2025-01-14 08:51:36 +00:00
```
3dboxes
backcovers
covers
custom
fanart
manuals
marquees
miximages (The miximages are generated by ES-DE)
physicalmedia
screenshots
titlescreens
videos
```
2024-12-28 13:24:13 +00:00
### Example adding media files to games
**A multi-disk game or a single game:**
You want to add a screenshot and a video to the game:
`~/retrodeck/roms/c64/Multidisk/Last Ninja 2/Last Ninja 2.m3u`
Then the media files structure needs to be the following:
2024-12-29 15:34:54 +00:00
Screenshots: `~/retrodeck/ES-DE/downloaded_media/c64/screenshots/Multidisk/Last Ninja 2/Last Ninja 2.jpg`
Videos: `~/retrodeck/ES-DE/downloaded_media/c64/videos/Multidisk/Last Ninja 2/Last Ninja 2.mp4`
2024-12-28 13:24:13 +00:00
**A Directories interpreted as files game:**
You want to add a screenshot and a video to the game:
`~/retrodeck/roms/scummvm/dig.scummvm`
The media files for this directory which is interpreted as a file will be:
2024-12-29 15:34:54 +00:00
Screenshots: `~/retrodeck/ES-DE/downloaded_media/scummvm/screenshots/dig.scummvm.png`
2024-12-28 13:24:13 +00:00
2024-12-29 15:34:54 +00:00
Videos: `~/retrodeck/ES-DE/downloaded_media/scummvm/videos/dig.scummvm.mp4`
2024-12-28 13:24:13 +00:00
2025-01-14 08:49:40 +00:00
## ES-DE Scraping FAQ
### I got some weird error message about quota after scraping!
2024-05-23 05:26:17 +00:00
The error message mentions something about quota. You have a quota limit on how much you can scrape each day from [Screenscraper](https://www.screenscraper.fr/) where each item you scrape counts as 1 quota of the daily total.
You can pay them to get a bit more daily quota and show your support or just wait 24 hours.
2025-01-14 08:49:40 +00:00
### The Scraper said: The Server or Service is down?
2024-05-23 05:26:17 +00:00
The service is down, check [Screenscraper](https://www.screenscraper.fr/) when they get back up.
2025-01-14 08:49:40 +00:00
### Can I only scrape one game or can I narrow down the scraping method?
2024-05-23 05:26:17 +00:00
Yes, check the `Guides - ES-DE Frontend 🤖` for more details.
2025-01-14 08:49:40 +00:00
### Can I move the downloaded_media folder?
2024-05-23 05:26:17 +00:00
You can move it with the the move RetroDECK option inside the configurator.
2025-01-14 08:49:40 +00:00
### Can I copy the downloaded_media folder to another device?
2024-05-23 05:26:17 +00:00
Yes, just copy it into the other device RetroDECK folder.
2025-01-14 08:49:40 +00:00
### I have donated to Screenscraper how do I get faster scraping?
2024-05-23 05:26:17 +00:00
You have to associate your Screenscraper Account with your Pateron Account.
Check [Screenscraper Pateron](https://www.patreon.com/screenscraper) for instructions.
2025-01-14 08:49:40 +00:00
### The scraping is very slow...
2024-05-23 05:26:17 +00:00
[Screenscraper](https://www.screenscraper.fr/) offers different types of donations that can increase your speed with extra threads.
2025-01-14 08:49:40 +00:00
### My systems storage ran out after scraping...
2024-05-23 05:26:17 +00:00
You can clean out images and videos that takes a lot of space under: `~/retrodeck/downloaded_media`.
2025-01-14 08:49:40 +00:00
#### But I still want them...
2024-05-23 05:26:17 +00:00
The only way to still keep them is either delete something else from the storage or buy more storage.
2025-01-14 08:49:40 +00:00
### Can I launch a speicifc game with another emulator then default, but keep the rest on the default?
2024-05-23 05:26:17 +00:00
Yes, if you want for example launch one of the PSX games with Duckstation instead of RetroArch.
First navigate to the game in the gamelist, then open the `Gamelist Options Menu` - `Edit This Game's Metadata` - `Alternative Emulator` - `Set the emulator here`.