# Scraping & Metadata

Scraping is used for downloading metadata and media files (images, videos, maps, pad-to-key settings and manuals) for games in your collection.

Retrobat supports 4 scraping services:

* ScreenScraper (default service) : credentials are required ([screenscraper website](https://www.screenscraper.fr/))
* [TheGamesDB](https://thegamesdb.net/)
* [HFSDB](https://db.hfsplay.fr/)
* ArcadeDB
* [IGDB](https://www.igdb.com/) : require to enter IGDB clientid and secret on scraper menu (see how-to get on [IGDB api](https://api-docs.igdb.com/#getting-started))

### **Information that can be scraped**

* Game information (title, year, number of players, description...)
* Ratings
* Thumb (box)
* Marquee / Wheel
* Video
* Fanart
* Image (title screen or in-game screenshot)
* Box backside
* Map
* Manual
* Pad-to-key settings

### Scraping process

There are two approaches to scraping, either for a single game from the [Game Options](https://wiki.retrobat.org/navigation/game-options), or for multiple games and systems (global scraping) from the [Main Menu](https://wiki.retrobat.org/navigation/main-menu).

#### Global scraping

Refer to the [following part of the wiki](https://wiki.retrobat.org/get-started/adding-a-game#global-scraping) for instructions.

#### Per Game scraping

Refer to the[ following section of the wiki](https://wiki.retrobat.org/get-started/adding-a-game#per-game-scraping) for instructions.

### Scraping options

Scraping options are available from the [Main Menu](https://wiki.retrobat.org/navigation/main-menu).

<div align="left"><figure><img src="https://990680527-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FexdzL60ZuqPLldz2AYta%2Fuploads%2FDqmh1mNEIZP8LW7uyyuI%2Fimage.png?alt=media&#x26;token=5faeebc8-73b8-44ca-9d5f-72f13258356a" alt=""><figcaption></figcaption></figure></div>

Before running the scraper you can:

* Select the scraper to use
* Limit the scraper to only games missing all medias or games missing any media
* Ignore games scraped recently
* Include/exclude systems
* Include/exclude scraping services

Additionaly, each scraper has its own settings.

<div align="left"><figure><img src="https://990680527-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FexdzL60ZuqPLldz2AYta%2Fuploads%2FjuIohhi7dXz5bWpMPwgc%2Fimage.png?alt=media&#x26;token=c65c8121-7140-44be-93ee-9a80bae00047" alt=""><figcaption><p>Example of available settings for ScreenScraper</p></figcaption></figure></div>

From here you can select which data to scrape, but also define:

* What image to use as "image" file
* What image to use as "thumb" image
* What image to use as logo (marquee or wheel)

{% hint style="info" %}
The Scraper settings screen is also where you can enter your credentials for ScreenScaper service.
{% endhint %}

### Scraping accounts

Screenscraper and IGDB require an account creation, they can be entered in the ACCOUNTS tab:

<div align="left"><figure><img src="https://990680527-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FexdzL60ZuqPLldz2AYta%2Fuploads%2FuX7HHo6WEvSOGqHadHKq%2Fimage.png?alt=media&#x26;token=4d215132-6b98-4b38-bf00-5f511337738a" alt=""><figcaption></figcaption></figure></div>

### Disable scraping services

At the bottom of the OPTIONS tab, it is possible to select which scraping services are activated in RetroBat:

<div align="left"><figure><img src="https://990680527-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FexdzL60ZuqPLldz2AYta%2Fuploads%2FrJJPGFmRZLXD0xAMUfb1%2Fimage.png?alt=media&#x26;token=d0207861-7032-4324-933a-07de089391e8" alt=""><figcaption></figcaption></figure></div>

### Storage of scraped medias

All scraped medias will be stored in the rom folder.

<div align="left"><figure><img src="https://i.imgur.com/XlUVX8L.png" alt=""><figcaption><p>Example of media folders</p></figcaption></figure></div>

<table><thead><tr><th width="199">Folder</th><th>Media stored</th></tr></thead><tbody><tr><td>images</td><td>box (thumb), fanart, boxback, image, marquee, map</td></tr><tr><td>manuals</td><td>pdf manual</td></tr><tr><td>videos</td><td>mp4 videos</td></tr></tbody></table>

### Using Local Media

You can also decide to use existing images and videos that are already stored on your computer, or media that you have created on your own.\
\
To do so, you have to :

* rename the media files exactly like the game file,
* add the naming extension specific to the media type:
  * *name\_of\_game***-thumb** for the image of the box art,
  * *name\_of\_game***-image** for the image of the game,
  * *name\_of\_game***-marquee** for the image of the game logo,
  * *name\_of\_game***-video.mp4** for the game video.
* place the media files in the "**images**" folders for images and "**videos**" folder for videos
* From the [**SYSTEM SETTINGS**](https://wiki.retrobat.org/main-menu#system-settings), in "**frontend developer options**", enable "**Search for local art**"

<div align="left"><figure><img src="https://i.imgur.com/dy6VEGP.png" alt=""><figcaption></figcaption></figure></div>

### Manual modification of Game Metadata

The [Game Option](https://wiki.retrobat.org/navigation/game-options) menu offers the possibility to manually edit/complete metadata for a game

<div align="left"><figure><img src="https://i.imgur.com/80l5jWw.png" alt=""><figcaption></figcaption></figure></div>

**From there you can:**

* Update Game information (name, description, rating, release date, developer, publisher, family, genres, arcade system, number of players, languages and region)
* Attach different media files
* Add game to favorites
* Hide game
* Flag game as KID game to display it in the [Kid Mode](https://wiki.retrobat.org/advanced-features/kiosk-and-kid-mode#kid-mode)