LogoLogo
Retrobat WebsiteForumGithub
English
English
  • Welcome!
  • Get Started
    • Prerequisites
    • Installation & First Startup
    • RetroBat Folder Structure
    • Adding a game
    • Running a game
    • Adding BIOS files
  • NAVIGATION
    • Navigation Keys
    • Hotkeys
    • System View and Game View
    • Main Menu
    • View Options
    • Game Options
    • Configuration of systems and games
    • Scraping & Metadata
    • Game Collections
  • Systems & Emulators
    • Arcade Guide
    • Supported Game Systems
      • Game Consoles
        • 3DO
        • Actionmax
        • Adventure Vision
        • Amstrad GX4000
        • APF MP-1000
        • Arcadia 2001
        • Atari (consoles)
          • Atari 2600
          • Atari 5200
          • Atari 7800
          • Atari XEGS
          • Jaguar
          • Jaguar CD
        • Bally Astrocade
        • Casio Loopy
        • Channel F
        • ColecoVision
        • Commodore (game consoles)
          • Amiga CDTV
          • Amiga CD32
        • Intellivision
        • Lowres NX
        • Microsoft (consoles)
          • Xbox
          • Xbox 360
        • NEC (consoles)
          • PC Engine/TurboGrafx-16
          • PC Engine CD-ROM/TurboGrafx-CD
          • SuperGrafx
          • PC-FX
        • Nintendo (game consoles)
          • Nintendo Entertainment System - Family Computer
          • Family Computer Disk System
          • NES 3D
          • Super Nintendo Entertainment System - Super Famicom
          • Satellaview
          • SuFami Turbo
          • Super NES MSU-1
          • Super Game Boy
          • Nintendo 64
          • Nintendo 64 Disk Drive
          • GameCube
          • Wii
          • WiiU
          • Switch
        • Philips CD-i
        • Odyssey²
        • Othello Multivision
        • PV-1000
        • Sega (game consoles)
          • SG-1000
          • Master System - Mark III
          • Megadrive - Genesis
          • Megadrive - Genesis (MSU)
          • Mega-CD - Sega-CD
          • Sega 32X
          • Saturn
          • Dreamcast
        • SNK (game consoles)
          • Neo Geo
          • Neo Geo CD
        • Sony (game consoles)
          • PlayStation
          • PlayStation 2
          • Playstation 3
          • Playstation 4
        • Super Cassette Vision
        • Super A'Can
        • Uzebox
        • VC4000
        • Vectrex
        • Vircon32
        • VTech
          • CreatiVision
          • V.Smile
      • Portable Game Consoles
        • Arduboy
        • Atari (portable game consoles)
          • Lynx
        • Gamate
        • Game.com
        • Game Pocket Computer
        • Game Master
        • Game & Watch
        • GP 32
        • LCD Games
        • Mega Duck
        • Nintendo (portable game consoles)
          • Game Boy
          • Game Boy MSU
          • Game Boy 2 players
          • Virtual Boy
          • Game Boy Color
          • Game Boy Color 2 players
          • Game Boy Advance
          • Game Boy Advance 2 players
          • Nintendo DS
          • Pokémon Mini
          • Nintendo 3DS
        • Nokia
          • N-Gage & Symbian
        • Sega (portable game consoles)
          • Game Gear
        • SNK (portable game consoles)
          • Neo Geo Pocket
          • Neo Geo Pocket Color
        • Sony (portable game consoles)
          • PlayStation Portable
          • PlayStation Vita
        • Supervision
        • Wonderswan
          • WonderSwan
          • WonderSwan Color
      • Home Computer
        • Acorn Computers
          • Archimedes
          • ATOM
          • BBC Micro
          • Electron
        • Amstrad CPC
        • Apple
          • Apple II
          • Apple IIGS
        • Atari (computers)
          • Atari 800
          • Atari ST
        • Camputers Lynx
        • Coleco Adam
        • Pegasus
        • Commodore (computers)
          • Commodore PET
          • Commodore VIC-20
          • Commodore 64
          • Commodore Plus/4
          • Commodore 128
          • Amiga 500
          • Amiga 1200
          • Amiga 4000
        • Dragon 32/64
        • Fujitsu
          • FM-7
          • FM-TOWNS
        • Mattel
          • Aquarius
        • Microsoft (computers)
          • MSX
          • MSX2
          • MSX2+
          • MSX turbo R
        • NEC (computers)
          • NEC PC-8800
          • NEC PC-9800
        • Oric Atmos
        • Philips
          • P2000t
          • VG5000µ
        • Sam Coupé
        • Sharp
          • Sharp X1
          • Sharp X68000
        • Sinclair Research
          • ZX 81
          • ZX Spectrum
        • SpectraVideo (SV-318)
        • Thomson - MO/TO
        • TI-99/4A
        • Tomy Tutor
        • TRS-80 Color Computer
      • Arcade
        • Atomiswave
        • Capcom Play Systems
          • CPS I
          • CPS II
          • CPS III
        • Cave CV1000
        • Final Burn Neo
        • Gaelco
        • HomeBrew MAME
        • Hyper Neo Geo 64
        • LaserDisc
        • MAME
        • Namco 246/256
        • SEGA
          • Sega Model 2
          • Sega Titan-Video
          • Sega Model 3
          • Sega NAOMI
          • Sega NAOMI 2
          • Sega Hikaru
          • Triforce
          • Sega Chihiro
        • TeknoParrot
        • Zinc
      • Game Engines
        • EasyRPG
        • GemRB
        • IKEMEN
        • Löve
        • Lutro
        • MUGEN
        • Open Beats Of Rage
        • Singe
        • Solarus
      • Pinball
        • Future Pinball
        • Pinball FX
        • Pinball FX2
        • Pinball FX3
        • Pinball M
        • Visual Pinball
        • Zaccaria Pinball
      • Others
        • Cannonball
        • Cave Story
        • CDogs
        • Commander Genius
        • DevilutionX
        • Dinothawr
        • Doom III
        • DOS
        • Duke Nukem 3D
        • Flash
        • GzDoom
        • Java ME
        • Karaoke
        • OpenGOAL
        • OpenJazz
        • Perfect Dark
        • Pico-8
        • Ports
        • PrBoom
        • Quake
        • Quake 2
        • Raze
        • REminiscence
        • Ship Of Harkinian
        • Starship
        • Sonic 3 AIR
        • Sonic Mania
        • Sonic Retro
        • Super Mario War
        • ScummVM
        • The Force Engine
        • Theme Hospital
        • TIC-80
        • Tomb Raider
        • TV Games
        • WASM-4
        • Windows
        • Wolfenstein 3D
  • Controllers
    • Supported Controllers
      • 🎮Gamepads
        • Special controllers
      • 🕹️Arcade Sticks
      • 🔫Lightguns
        • WiimoteGun
      • 🛞Wheels
      • ⌨️Keyboard
    • Controllers Configuration
    • Gun controls
    • Emulator specific controls mapping
      • Dolphin controller mapping
      • MAME64 controller mapping
      • Model2 controller mapping
      • RetroArch controller mapping
    • Pad2Key
  • Advanced Features
    • Decorations (bezels)
    • Updates & Content Download
    • Kiosk and Kid mode
    • Save States
    • Retroachievements
    • Netplay
    • AI Translation Service
    • Batgui
    • retrobat.ini
    • Latency and blur reduction
    • Softpatching
  • TUTORIALS
    • Know issues & fixes
    • Symbolic links
    • Adding RetroArch Shader Sets to Retrobat
    • Customize Mega-Bezels
Powered by GitBook

Copyright The RetroBat Team 2019-2024

On this page
  • Information that can be scraped
  • Scraping process
  • Scraping options
  • Storage of scraped medias
  • Using Local Media
  • Manual modification of Game Metadata

Was this helpful?

Export as PDF
  1. NAVIGATION

Scraping & Metadata

PreviousConfiguration of systems and gamesNextGame Collections

Last updated 1 year ago

Was this helpful?

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 ()

  • ArcadeDB

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

Global scraping

Per Game scraping

Scraping options

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

Additionaly, each scraper has its own settings.

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)

The Scraper settings screen is also where you can enter your credentials for ScreenScaper service.

Storage of scraped medias

All scraped medias will be stored in the rom folder.

Folder
Media stored

images

box (thumb), fanart, boxback, image, marquee, map

manuals

pdf manual

videos

mp4 videos

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

Manual modification of Game Metadata

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

There are two approaches to scraping, either for a single game from the , or for multiple games and systems (global scraping) from the .

Refer to the for instructions.

Refer to the for instructions.

Scraping options are available from the .

Example of available settings for ScreenScraper
Example of media folders

From the , in "frontend developer options", enable "Search for local art"

The menu offers the possibility to manually edit/complete metadata for a game

Flag game as KID game to display it in the

screenscraper website
TheGamesDB
HFSDB
Game Options
Main Menu
Main Menu
Game Option
Kid Mode
following part of the wiki
following section of the wiki
SYSTEM SETTINGS