Asset searching

This page describes how Pegasus is searching automatically for game assets, such as logo images, backgrounds or videos. Such media files can come from these sources:

  1. A manually set file for the game in a metadata file
  2. A manually set default file for the collections in a metadata file
  3. A file with a recognized name under <directory>/media/<gamename>/
  4. Third-party sources (eg. EmulationStation, Steam, Skraper)

To download assets for all your games automatically, you might want to use a program called "scraper". See the bottom of this page for more details.

Game assets in the Metadata file

All recognized asset types can be set in the metadata.txt (and metadata.pegasus.txt) file by adding a assets.<assetname>: <file> entry for a game.

The list of possible asset names can be found HERE. <file> is the path to the asset file, which can be either relative (to the metadata file) or an absolute path.


Let's say we have the following structure:

├─ metadata.pegasus.txt
├─ Alien Hominid.gba
└─ assets/
   ├─ covers/
   │  └─ Alien_Hominid.jpg
   └─ logos/
      └─ Alien_Hominid_logo.jpg

Our metadata.pegasus.txt file could then look like this:

collection: Game Boy Advance
extension: gba

game: Alien Hominid
file: Alien Hominid.gba
developer: Zoo Digital
assets.box_front: assets/covers/Alien_Hominid.jpg
assets.logo: assets/logos/Alien_Hominid_logo.jpg

Collection assets in the Metadata file

Similarly, you can also set default assets for a collection by adding a assets.<assetname>: <file> field.

However, note that using these default assets depends on the theme set in Pegasus, as a theme's creator can decide to use a different artwork for such purposes as well.


Continuing the example above, let's say we have an assets/default_cover.jpg file. In this case the collection could be defined like this:

collection: Game Boy Advance
extension: gba
description: The Game Boy Advance (GBA) is a 32-bit handheld
  video game console developed, manufactured and marketed by Nintendo
  as the successor to the Game Boy Color.
assets.box_front: assets/default_cover.jpg

game: Alien Hominid
# ...

The media directory

If the game's assets haven't beed defined manually, Pegasus will also look for a matching file under <dir>/media/<gamename>/, where <dir> is the directory where the Metadata file looks for games, and <gamename> can be either the title of the game found in this directory, or the filename (without extension) of one of the game's files.


├─ metadata.pegasus.txt
├─ Contra (U).zip
└─ media/
   └─ Contra (U)/
      ├─ boxFront.jpg
      ├─ logo.jpg
      └─ video.mp4
Recognized files

For still images, PNG and JPG files are searched, for videos WEBM, MP4 and AVI, and for audio MP3, OGG and WAV. The recognized filenames are:

Accepted namesPurpose
boxFront, box_front, boxart2DThe front of the game box
boxBack, box_backThe back of the game box
boxSpine, box_spine, boxSide, box_sideThe spine (side edge) of the game box
boxFull, box_full, boxFull box art (front + back + spine)
cartridge, disc, cartImage of the game medium (cartridge, floppy, disk, etc.)
logo, wheelThe game's logo, usually the title art over a transparent background
poster, flyerAdvertisement poster, usually with 2:3 aspect ratio (in general a portrait-aligned image)
Accepted namesPurpose
marqueeA wide (often over 3:1) artwork on the top of arcade machines
bezel, screenmarquee, borderDecoration around a game's screen on an arcade machine or emulator
panelControl panel of the arcade machine
cabinetLeft, cabinet_leftLeft side of the arcade machine
cabinetRight, cabinet_rightRight side of the arcade machine
Accepted namesPurpose
tileA square-sized image (not the desktop icon)
bannerAn image in 16:9 aspect ratio
steam, steamgrid, gridSteam grid icon, in 460x215px or 920x430px size
backgroundA background image, eg. artwork or selected screenshot
musicBackground music
screenshotAn in-game screenshot
titlescreenAn in-game screenshot of the title screen or main menu of the game
videoA video about the game, eg. a trailer or gameplay presentation

Third-party sources

Pegasus also tries to use the assets of third-party data sources, if possible. Usually no configuration is necessary, just enable the data source in the Settings menu. Internet access might be required, depending on the source (eg. Steam).

How to get assets for my games?

For larger game libraries, it might be tiresome to download each and every asset manually. To automatize this process, you can use programs called scrapers. These go through all your games, check multiple online databases for available assets, and may even generate a configuration file for you.

Some popular scraper programs are Universal XML Scraper, Steven Selph's Scraper, and Skyscraper. Try giving them a go!