# 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](/navigation/game-options.md), or for multiple games and systems (global scraping) from the [Main Menu](/navigation/main-menu.md).

#### Global scraping

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

#### Per Game scraping

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

### Scraping options

Scraping options are available from the [Main Menu](/navigation/main-menu.md).

<div align="left"><figure><img src="/files/Z08vS3ruyrPSmuHh5WQi" 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="/files/jFllUkE0EjDpQ7L3mD6E" 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="/files/g1Pn4WfRJ5zaYmf5naja" 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="/files/tIPCN5hSgQghZycf2hWl" 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**](/navigation/main-menu.md#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](/navigation/game-options.md) 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](/advanced-features/kiosk-and-kid-mode.md#kid-mode)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wiki.retrobat.org/navigation/scraping-and-metadata.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.