diff --git a/docs/Getting-Started/Metadata-Providers.md b/docs/Getting-Started/Metadata-Providers.md index 1baaa73f..1246b101 100644 --- a/docs/Getting-Started/Metadata-Providers.md +++ b/docs/Getting-Started/Metadata-Providers.md @@ -154,6 +154,91 @@ library/ └─ etc... ``` + +```xml + + + + + ./game.gba + + + Game Title + A fun game to play + en + USA + + + 0.8 + 19990615T000000 + Developer Inc. + Publisher Co. + Game Series + Action + 1-2 + f1234567890abcdef1234567890abcde + + + ./images/game.png + ./covers/game.png + ./backcovers/game.png + ./3dboxes/game.png + ./fanart/game.png + ./manuals/game.pdf + ./marquees/game.png + ./miximages/game.png + ./physicalmedia/game.png + ./screenshots/game.png + ./titlescreens/game.png + ./thumbnails/game.png + + + + ... + + ... + +``` + +#### ES-DE metadata + +Here are the text properties that will be read from `gamelist.xml`. + +| Property Name | Description | +| ------------- | -------------------------------- | +| name | Game title | +| desc | Game description or synopsis | +| lang | Game language (en, es, it, etc.) | +| region | Game region (us, eu, jp, etc.) | +| rating | Game rating score | +| releasedate | Game release date | +| developer | Developer company | +| publisher | Publisher company | +| family | Game franchise or series | +| genre | Game category or type | +| players | Number of players supported | +| md5 | ROM file hash identifier | + +#### ES-DE media + +RomM has two ways of mapping media files: first it looks at `gamelist.xml` for properties, and it falls back to looking at nested folders for images that have the same name as the ROM. + +| Property Name | Folder Name | Description | +| ------------- | ------------- | -------------------------------------- | +| image | images | General game image | +| cover | covers | Front cover artwork | +| backcover | backcovers | Back cover artwork | +| box3d | 3dboxes | 3D box artwork | +| fanart | fanart | Fan-made artwork | +| manual | manuals | Game instruction manual | +| marquee | marquees | Arcade game marquee or header | +| miximage | miximages | Composite or mixed artwork | +| physicalmedia | physicalmedia | Physical media (cartridge, disc, etc.) | +| screenshot | screenshots | In-game screenshot | +| title_screen | titlescreens | Game title screen | +| thumbnail | thumbnails | Small preview image | +| video | videos | Gameplay video or trailer | + #### ES-DE settings Here are the settings you need to change so RomM can read your artwork and gamelist.xml files from the same folder that holds your ROMs.