# Scraping & Metadata Scraping downloads the information (name, description, release date, genre…) and the media (images, videos, manuals, maps…) of your games from online databases. ## Scraping services
ServiceAccount
ScreenScraper (default)Free account recommended (faster, fewer limits)
TheGamesDBNot required
HFSDBNot required
ArcadeDBNot required (arcade games only)
IGDBRequired: Client ID and Client Secret, see Setting up IGDB
## Information that can be scraped * Game information: name, description, release date, developer, publisher, genre, number of players, rating… * Images: box (2D or 3D), box backside, screenshot or title screen, logo (wheel or marquee), fan art, map, cartridge, bezel (16:9) * Video * Manual * PadToKey settings ## How to scrape * **All games or several systems**: see [Global scraping](../get-started/adding-a-game.md#global-scraping). * **One game**: see [Per-game scraping](../get-started/adding-a-game.md#per-game-scraping). ## The scraper menu Open **MAIN MENU** > **SCRAPER**. The menu has three tabs.
### SCRAPE tab
SettingDescription
SCRAPE FROMService to use
GAMES TO SCRAPE FORAll games, games missing any media, or games missing all media
IGNORE RECENTLY SCRAPED GAMESSkip the games scraped during the last day, week, month…
SYSTEMS INCLUDEDSystems to scrape
SCRAPE NOWStart scraping
### OPTIONS tab The available settings depend on the selected service.
SectionSettings
SettingsIMAGE SOURCE (screenshot, title screen, mix, box…), BOX SOURCE (2D or 3D box), LOGO SOURCE (wheel, HD wheel, marquee), PREFERED REGION, OVERWRITE NAMES / DESCRIPTIONS / MEDIAS
Scrape forMedia and information to download: short name, community rating, video, fan art, bezel (16:9), box backside, map, title shot, cartridge, manual, PadToKey settings
Manual scrapeINCLUDED SCRAPERS: services queried when you scrape a single game
{% hint style="info" %} Keep **OVERWRITE NAMES / DESCRIPTIONS / MEDIAS** disabled if you have edited your games manually: otherwise your changes will be replaced. {% endhint %} ### ACCOUNTS tab
SectionSettings
ScreenScraperUSERNAME and PASSWORD of your ScreenScraper account
IGDBCLIENT ID and CLIENT SECRET, see below
## Setting up IGDB IGDB belongs to Twitch: to use it, you need to create a (free) "application" on the Twitch developer website, which gives you a **Client ID** and a **Client Secret**. 1. **Create a Twitch account** on [twitch.tv](https://www.twitch.tv/) if you do not have one, and verify your email address. 2. **Enable two-factor authentication (2FA)**: Twitch **Settings** > **Security and Privacy** > **Set Up Two-Factor Authentication** (a phone number is required). The developer console does not work without 2FA. 3. Open the [Twitch developer console](https://dev.twitch.tv/console) and log in. 4. In the **Applications** tab, click **Register Your Application** and fill in the form: * **Name**: a unique name, for example `retrobat-` followed by random characters (if the name is already used, the creation fails) * **OAuth Redirect URLs**: `http://localhost` * **Category**: **Application Integration** * **Client Type**: **Confidential** 5. Validate the captcha, then click **Create**. 6. In the list of applications, click **Manage** on your application: * copy the **Client ID**; * click **New Secret**, confirm, then copy the **Client Secret**. 7. In RetroBat, open **MAIN MENU** > **SCRAPER** > **ACCOUNTS** and enter the **CLIENT ID** and **CLIENT SECRET** in the **IGDB** section. 8. In the **SCRAPE** tab, select **IGDB** in **SCRAPE FROM**. {% hint style="info" %} **Easier than typing with a controller:** close RetroBat, open `emulationstation\.emulationstation\es_settings.cfg` with a text editor, and add (or complete) these two lines: ```xml ``` {% endhint %} {% hint style="warning" %} * Keep your Client Secret private. * Clicking **New Secret** again creates a new secret and invalidates the previous one: you then need to enter it again in RetroBat. {% endhint %} ## Storage of scraped media Media are stored in the folder of each system, in subfolders. Each file is named after the game file, followed by the media type.
FolderMediaExample for roms\snes\Super Metroid.zip
imagesBox, box backside, screenshot, logo, fan art, map, cartridge, title shot, bezel…images\Super Metroid-thumb.png, -image, -marquee, -fanart, -boxback, -box, -wheel, -map, -cartridge, -titleshot, -bezel
videosVideosvideos\Super Metroid-video.mp4
manualsManuals (PDF)manuals\Super Metroid-manual.pdf
magazinesMagazinesmagazines\Super Metroid-magazine.pdf
The game information and the links to the media are saved in the `gamelist.xml` file of the system folder (for example `roms\snes\gamelist.xml`). ## Using your own media You can use images and videos you already have, or that you have created yourself. 1. Name each file exactly like the game file (without its extension), followed by the media type: | File | Media | Folder | | --------------------------- | ----------------------- | -------- | | `Super Metroid-thumb.png` | Box | `images` | | `Super Metroid-image.png` | Game image (screenshot) | `images` | | `Super Metroid-marquee.png` | Logo | `images` | | `Super Metroid-video.mp4` | Video | `videos` | 2. Copy the files to the `images` or `videos` folder of the system (for example `roms\snes\images`). Images can be `.png` or `.jpg`. 3. Enable **SEARCH FOR LOCAL ART** in **MAIN MENU** > **SYSTEM SETTINGS** > **FRONTEND DEVELOPER OPTIONS** > **DATA MANAGEMENT**.
{% hint style="info" %} Your files are only used when the game has no media of this type in the game list. To use your own media for a game that has already been scraped, attach them with **EDIT THIS GAME'S METADATA** (see below). {% endhint %} ## Editing game metadata manually In the [Game options](game-options.md) menu, choose **EDIT THIS GAME'S METADATA**:
You can: * change the game information: name, description, rating, release date, developer, publisher, game family, genres, arcade system, number of players, languages, region; * attach other media files (image, video, logo, box, fan art, manual, map…); * add the game to favorites; * hide the game; * mark the game as a **kid game**, to display it in [Kid mode](../advanced-features/kiosk-and-kid-mode.md#kid-mode).