Skip to content
Christian Jungerius edited this page Nov 10, 2022 · 4 revisions

Scraping concerns collecting metadata and assets for all of the entities in AKL.

Categories asset labels

  • thumb = DefaultFolder.png is the default for categories.

  • Trailer is an asset, however label is set with setInfo() instead of setArt().

Asset name AEL name setArt() setInfo() Infolabel
Icon s_icon icon $INFO[ListItem.Icon]
Fanart s_fanart fanart $INFO[ListItem.Fanart]
Banner s_banner banner $INFO[ListItem.Art(banner)]
Flyer s_flyer poster $INFO[ListItem.Art(poster)]
Clearlogo s_clearlogo clearlogo $INFO[ListItem.Art(clearlogo)]
Trailer s_trailer trailer $INFO[ListItem.trailer]
Extrafanart extrafanart extrafanart1 Not implemented yet
Extrafanart extrafanart extrafanart2 Not implemented yet

ROMs asset labels

Asset name AKL name setArt label setInfo label MAME mapping for MAME views
Title s_title title/thumb title
Snap s_snap snap snap
Fanart s_fanart fanart fanart
Banner s_banner banner marquee
Clearlogo s_clearlogo clearlogo clearlogo
Boxfront s_boxfront boxfront cabinet
Boxback s_boxback boxback cpanel
Cartridge s_cartridge cartridge pcb
Flyer s_flyer poster flyer
Map s_map map
Manual s_manual manual
Trailer s_trailer trailer trailer
Extrafanart extrafanart extrafanart1 extrafanart
Extrafanart extrafanart extrafanart2 extrafanart
  • thumb label is set to DefaultProgram.png.
  • Trailer is an asset, however label is set with setInfo() instead of setArt()
  • extrafanart is a Python list.

Console ROMs asset availability

Artwork site Title Snap Fanart Banner Boxfront Boxback Cartridge Flyer Map Manual Trailer
EmuMovies YES YES NO NO YES YES YES YES YES YES YES
HyperSpin Media NO NO <1> YES YES NO YES <1> <1> NO NO
No-Intro YES NO NO NO YES YES YES NO NO YES NO
Retroarch YES YES NO NO YES NO NO NO NO NO NO
TheGamesDB <2> <2> YES YES YES YES NO NO NO NO YouTube
GameFAQs <2> <2> NO NO YES YES NO NO NO NO NO
MobyGames <2> <2> NO NO YES YES YES NO NO NO NO
GiantBomb <3> <3> <3> <3> YES <3> <3> NO NO NO YouTube
  • Banner is a horizontal image with name of ROM/system. It is called Wheel in Hyperspin and Logo in HL. Also, HL has both Logo/Wheel and Banner in separated directories. I do not know the difference between them. No idea about what is HL Clearart.
  • Flyer is a vertical image. It is called Poster in HL.
  • EmuMovies/HyperSpin Media provide 2D and 3D version of Boxfront and Cartridges.
  • <1> In the HyperSpin forum you can find per-game/per-system themes that have Fanart and Banner. However, in many cases assets are inside SWF files and difficult to use outside HyperSpin.\
  • <2> TheGamesDB/GameFAQs/MobyGames do not differentiate between Title/Snap. They just have screenshots.
  • GameFAQs have gamebox Spine, which can be considered a kind of Banner.
  • <3> GiantBomb has quite a lot of artwork. However, everything is mixed (Title, Snaps, Fanart, all showing on the same page) and makes it difficult to scrape. Boxfront is easy to scrape from GiantBomb.
  • RetroPie and Emulation Station users have nice No-Intro artwork collections including Title, Snap and Boxfront.

AKL artwork policy

  • One artwork directory will be required for every ROM launcher. User will be asked for one Artwork directory and AKL will create subdirectories inside automatically.

ROM artwork storage

  1. Asset directory may be the same as the ROMs directory.
ROMs directory         ~/ROMs/SNES/Super Mario World (Europe).zip
Artwork directory      ~/Artwork/SNES/
Created automatically  ~/Artwork/SNES/titles/Super Mario World (Europe).png
                       ~/Artwork/SNES/snaps/Super Mario World (Europe).png
                       ~/Artwork/SNES/fanarts/Super Mario World (Europe).png
                       ~/Artwork/SNES/banners/Super Mario World (Europe).png
                       ~/Artwork/SNES/boxfronts/Super Mario World (Europe).png
                       ~/Artwork/SNES/boxbacks/Super Mario World (Europe).png
                       ~/Artwork/SNES/cartridges/Super Mario World (Europe).png
                       ~/Artwork/SNES/flyers/Super Mario World (Europe).png
                       ~/Artwork/SNES/maps/Super Mario World (Europe).png
                       ~/Artwork/SNES/manuals/Super Mario World (Europe).pdf
                       ~/Artwork/SNES/trailers/Super Mario World (Europe).mpeg
                       ~/Artwork/SNES/extrafanart/Super Mario World (Europe)/fanart1.png
                       ~/Artwork/SNES/extrafanart/Super Mario World (Europe)/fanart2.png
                       ~/Artwork/SNES/extrafanart/Super Mario World (Europe)/fanart3.png

Launcher/Category artwork storage

  1. Category name SEGA. Each category will have a subdirectory with same name to store extrafanart.

  2. Launcher name SNES (Retroarch bsnes balanced). Each launcher will have a subdirectory to store extrafanart.

Artwork directory  ADDON_DATA_DIR/asset-categories/
                   ADDON_DATA_DIR/asset-categories/SEGA/fanart1.png
                   ADDON_DATA_DIR/asset-categories/SEGA/fanart2.png
                   ADDON_DATA_DIR/asset-categories/SEGA/fanart3.png

Artwork directory  ADDON_DATA_DIR/asset-launchers/
                   ADDON_DATA_DIR/asset-launchers/SNES (Retroarch bsnes balanced)/fanart1.png
                   ADDON_DATA_DIR/asset-launchers/SNES (Retroarch bsnes balanced)/fanart2.png
                   ADDON_DATA_DIR/asset-launchers/SNES (Retroarch bsnes balanced)/fanart3.png
Clone this wiki locally