Skip to content

Add a game

flowchart LR
    A["1. Check it is<br/>not a duplicate"] --> B["2. Official name"] --> C["3. ROM folder<br/>+ ROM list"]
    C --> D["4. Thumbnails"] --> E["5. Bezel"] --> F["6. Remap<br/>(if needed)"]
    F --> G["7. Scripts,<br/>copy, test"]

1. Not a duplicate

One version of a game in the whole collection: a game already on another console is not added again (the Games tab of each console page shows them all). An exception is fine when chosen: Olympic Gold is on the Master System and the Mega Drive.

2. The official name

Every ROM has its official No-Intro name (Redump for the discs), found from its checksum in libretro-database, the database RetroArch itself uses:

Consoles Database
Game Boy, Game Boy Color, Game Boy Advance, NES, Super Nintendo, Nintendo 64, Master System, Mega Drive metadat/no-intro/<console>.dat
PlayStation, Dreamcast metadat/redump/<console>.dat
Arcade The FinalBurn Neo dat of the core's version: the zip is named after its set (pacman.zip)
DOOM dat/DOOM.dat
Check How
A cartridge (.zip) The CRC32 of the ROM inside the zip (not of the zip) is in the dat, and the file is named exactly like its entry
A disc (.chd) Its name is the dat's: a .chd is compressed, its checksum is not the dat's
A game on several discs Listed by an .m3u file naming its discs, one per line, in the same folder

The revision is part of the name

Banjo-Kazooie (USA) (Rev 1).zip is not Banjo-Kazooie (USA).zip: the thumbnails and the saves follow the exact name, revision included.

3. The ROM folder and the ROM list

Step
1 The ROM into the console's folder of the collection (- ROM (DOWNLOADS)\<console folder>\)
2 A line in the console's ROM list (romlists\<console>.txt), in [Extra]: Title = ROM file
3 Its entry in the console's dat of the repository (dats\<console>.dat), copied from the official dat

The format of the ROM lists and the dats: see the repository's README.

4. The thumbnails

Three pictures per game, from thumbnails.libretro.com (or the libretro-thumbnails repositories), into - THUMBNAILS\<console>\:

Folder Picture
Named_Boxarts\ The box
Named_Titles\ The title screen
Named_Snaps\ A screenshot
Rule Example
Named exactly like the ROM, without its extension Super Mario 64 (USA).png for Super Mario 64 (USA).zip
These characters become _: & * / : ` " < > ? \ and the vertical bar International Track _ Field (USA).png
The site's name differs from the ROM's: rename the picture, never the ROM Mega Man Battle Network 2 (USA).png → Mega Man - Battle Network 2 (USA).png

5. The bezel (PC)

From The Bezel Project: its repository of the console (bezelproject-<console>), in retroarch/overlay/GameBezels/<console>/, the PNG and the .cfg of the game, into - BEZELS\<console>\. Arcade: bezelproject-MAME, in retroarch/overlay/ArcadeBezels/, named after the set (1942.png).

Rule
Named like the game's thumbnails International Track _ Field (USA).png and .cfg
The .cfg names its PNG overlay0_overlay = "International Track _ Field (USA).png"
No bezel for the game It shows the console's _Default bezel

How a bezel is turned on: see Bezels.

6. A remap, if needed

The game has Then
A 4-player mode with an adapter (multitap, Team Player, 4 Way Play) A game remap: see Multiplayer
Special controls A game remap: see Remaps
Nothing special Nothing: it gets the core remap (turbo, stick)

7. Scripts, copy, test

Step
1 Run the collection's scripts (see the repository's README): they check the names, the thumbnails, the bezel, and make the playlists and the bezel overrides. For the guide's Pictures tab: site-gen\picture_links.py
2 Copy what they report as missing to RetroArch on the PC, then to the phone and the tablet (see Install)
3 Start the game on each device: it runs, shows its pictures and its bezel, and its remap works

Replace or remove a game

Replace (another version, a revision) The same steps for the new ROM; remove the old ROM, its 3 thumbnails, its bezel and its remap, on the PC and on the devices
Remove Its ROM list line and dat entry, its ROM, thumbnails, bezel and remap, on the PC and on the devices