Skip to content

Latest commit

 

History

History
388 lines (315 loc) · 38.1 KB

README.md

File metadata and controls

388 lines (315 loc) · 38.1 KB

Advanced Emulator Launcher asset library

The Advanced Emulator Launcher asset library has been designed to help you in the process of setting up your Kodi retrogaming library and contains the following items:

  • Category and launcher metadata in NFO format.

  • Category and launcher assets, including Icons, Fanarts, Banners, Posters and Controllers.

  • Launcher (emulator) configuration in XML for Linux, Windows and Android platforms.

There are two ways to use the library:

  • Configure you categories and launchers using the AEL category/launcher creation wizard in the addon context menu. Then, use the context menu to load the metadata NFO file and the assets (Icon, Fanart, etc.).

  • Use the XML configuration files to import into AEL any category or launcher. For categories, the XML file defines the metadata and assets. For Launchers, the XML file defines the metadata, the assets and the emulator parameters (aka the arguments).

  • To import and XML file, go to AEL addon settings, then go to "IO" tab, then select "Import configuration". Remember to change the ROM path, assets path and application path in the XML before importing (or you can change later after importing using the "Edit Launcher" context menu).

Alternatively, you can configure your launchers using the launcher creation wizard and have a look at the XML files to learn about the app/emulator arguments you must introduce in the wizard.

After importing an XML configuration file, if you discover some mistake or want to change something, simply edit the XML configuration file, reimport the XML in AEL, and when asked about overwriting the category/launcher say yes. You can reimport categories/launchers as many times as you want until you are totally satisfied with your setup.

Having a set of XML files with your emulator configuration and asset files will serve as a backup in the event you have to rebuild your mediacenter setup for some reason (emulator upgrade, AEL addon updgrade, Kodi upgrade, hard disk crash, etc.).

Contributions to the AEL Asset Library repository are welcomed and encouraged.

The Category and Launcher NFO files

The metadata for Launchers and assets is stored in NFO files. NFO files are small XML files that containt all the metadata AEL is able to display.

A Category NFO file looks like this:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<category>
  <genre>Company</genre>
  <plot>Sony Corporation, commonly referred to as Sony, styled SONY /ˈsoʊniː/, is a Japanese multinational conglomerate corporation headquartered in Kōnan Minato, Tokyo, Japan. Its diversified business includes consumer and professional electronics, gaming, entertainment and financial services. The company is one of the leading manufacturers of electronic products for the consumer and professional markets. Sony is ranked 116th on the 2015 list of Fortune Global 500.&#10;Sony Corporation is the electronics business unit and the parent company of the Sony Group, which is engaged in business through its four operating segments: electronics (including video games, network services and medical business), motion pictures, music and financial services. These make Sony one of the most comprehensive entertainment companies in the world. Sony's principal business operations include Sony Corporation (Sony Electronics in the U.S.), Sony Pictures Entertainment, Sony Interactive Entertainment, Sony Music Entertainment, Sony Mobile Communications (formerly Sony Ericsson) and Sony Financial. Sony is among the Worldwide Top 20 Semiconductor Sales Leaders and as of 2013, the fourth-largest television manufacturer in the world, after Samsung Electronics, LG Electronics and TCL.</plot>
</category>

A Launcher NFO file looks like this:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<launcher>
  <year>1994</year>
  <genre>Fifth generation console</genre>
  <developer>SONY</developer>
  <rating></rating>
  <plot>The PlayStation (officially abbreviated as PS, and commonly known as the PS1 or PSX) is a home video game console developed and marketed by Sony Computer Entertainment. The console was released on 3 December 1994 in Japan, 9 September 1995 in North America, 29 September 1995 in Europe, 15 November 1995 in Australia, and for Korea in 1996. The console was the first of the PlayStation lineup of home video game consoles. It primarily competed with the Nintendo 64 and the Sega Saturn as part of the fifth generation of video game consoles.</plot>
</launcher>

The Category and Launcher assets

The assets for categories are stored in the xxxx directory.

The assets for launchers are stored in directories sorted by category. For example, the assets for SEGA launchers are stored in xxxxxx.

AEL Category XML configuration files

The XML files to setup categories in AEL are located in the directory xxxxx. These XML files for categories use the assets located in the xxxx directory.

A Category XML configuration file looks like this:

xxx yyy zzz

The most up-to-date documentation for Category XML files is in this example.

AEL Launcher XML configuration files

The XML launcher configuration files are organised in different directories for Linux, Windows and Android platforms. These XML configuration files use the metadata NFO files and assets located in the directories xxxx

Path configurations

It is recommended that you keep your game library organised and that you use short names for the ROMs and artwork directories. Short names means smaller databases and smaller databases load faster, particularly with huge collections.

If you want to change the ROM path or asset path from the defaults to fit your setup you can edit the XML configuration files and then reload them in AEL.

Linux

The XML files in this library assume the following ROM paths and asset directories:

Category System ROM path or data files Assets path
Kodi Retroplayer /home/kodi/AEL-ROMs/retroplayer/ /home/kodi/AEL-assets/retroplayer/
Retroarch Not applicable Not applicable
Arcade Capcom Play System /home/kodi/AEL-ROMs/mame-cps/ /home/kodi/AEL-assets/mame-cps/
Arcade MAME /home/kodi/AEL-ROMs/mame/ /home/kodi/AEL-assets/mame/
Arcade SEGA /home/kodi/AEL-ROMs/mame-sega/ /home/kodi/AEL-assets/mame-sega/
Atari Atari 2600 /home/kodi/AEL-ROMs/atari-2600/ /home/kodi/AEL-assets/atari-2600/
Atari Atari 5200 /home/kodi/AEL-ROMs/atari-5200/ /home/kodi/AEL-assets/atari-5200/
Atari Atari 7800 /home/kodi/AEL-ROMs/atari-7800/ /home/kodi/AEL-assets/atari-7800/
Atari Atari Jaguar /home/kodi/AEL-ROMs/atari-jaguar/ /home/kodi/AEL-assets/atari-jaguar/
Atari Atari Jaguar CD /home/kodi/AEL-ROMs/atari-jaguarcd/ /home/kodi/AEL-assets/atari-jaguarcd/
Atari Atari Lynx /home/kodi/AEL-ROMs/atari-lynx/ /home/kodi/AEL-assets/atari-lynx/
Computers Amstrad CPC /home/kodi/AEL-ROMs/com-amstrad-cpc/ /home/kodi/AEL-assets/com-amstrad-cpc/
Computers Atari 8-bit /home/kodi/AEL-ROMs/com-atari-8bit/ /home/kodi/AEL-assets/com-atari-8bit/
Computers Atari ST /home/kodi/AEL-ROMs/com-atari-st/ /home/kodi/AEL-assets/com-atari-st/
Computers Commodore 64 /home/kodi/AEL-ROMs/com-c64/ /home/kodi/AEL-assets/com-c64/
Computers Commodore Amiga /home/kodi/AEL-ROMs/com-amiga/ /home/kodi/AEL-assets/com-amiga/
Computers Microsoft MSX /home/kodi/AEL-ROMs/com-msx/ /home/kodi/AEL-assets/com-msx/
Computers Microsoft MSX2 /home/kodi/AEL-ROMs/com-msx2/ /home/kodi/AEL-assets/com-msx2/
Computers Sinclair ZX Spectrum /home/kodi/AEL-ROMs/com-spectrum/ /home/kodi/AEL-assets/com-spectrum/
Consoles 3DO Interactive Multiplayer /home/kodi/AEL-ROMs/con-3do/ /home/kodi/AEL-assets/con-3do/
Consoles Amiga CD32 /home/kodi/AEL-ROMs/con-cd32/ /home/kodi/AEL-assets/con-cd32/
Consoles Bandai WonderSwan /home/kodi/AEL-ROMs/con-wswan/ /home/kodi/AEL-assets/con-wswan/
Consoles Bandai WonderSwan Color /home/kodi/AEL-ROMs/con-wswancolor/ /home/kodi/AEL-assets/con-wswancolor/
Consoles Colecovision /home/kodi/AEL-ROMs/con-coleco/ /home/kodi/AEL-assets/con-coleco/
Consoles Emerson Arcadia 2001 /home/kodi/AEL-ROMs/con-arcadia/ /home/kodi/AEL-assets/con-arcadia/
Consoles Fairchild Channel F /home/kodi/AEL-ROMs/con-channelf/ /home/kodi/AEL-assets/con-channelf/
Consoles Fujitsu FM Towns Marty /home/kodi/AEL-ROMs/con-fmtmarty/ /home/kodi/AEL-assets/con-fmtmarty/
Consoles GCE Vectrex /home/kodi/AEL-ROMs/con-vectrex/ /home/kodi/AEL-assets/con-vectrex/
Consoles Magnavox Odyssey 2 /home/kodi/AEL-ROMs/con-odyssey2/ /home/kodi/AEL-assets/con-odyssey2/
Consoles Mattel Intellivision /home/kodi/AEL-ROMs/con-intellivision/ /home/kodi/AEL-assets/con-intellivision/
Consoles Philips Videopac+ G7400 /home/kodi/AEL-ROMs/con-g7400/ /home/kodi/AEL-assets/con-g7400/
Consoles RCA Studio II /home/kodi/AEL-ROMs/con-studio2/ /home/kodi/AEL-assets/con-studio2/
Consoles Watara Supervision /home/kodi/AEL-ROMs/con-watara/ /home/kodi/AEL-assets/con-watara/
Games Cave Story (NX Engine) /home/kodi/AEL-ROMs/games-nxengine/Cave Story EN/ Not applicable
Games Doom /home/kodi/AEL-ROMs/games-doom/doom.wad Not applicable
Games Doom II: Hell on Earth /home/kodi/AEL-ROMs/games-doom2/doom2.wad Not applicable
Games The Plutonia Experiment /home/kodi/AEL-ROMs/games-plutonia/plutonia.wad Not applicable
Games TNT: Evilution /home/kodi/AEL-ROMs/games-tnt/tnt.wad Not applicable
Games Game and Watch /home/kodi/AEL-ROMs/games-gw/ /home/kodi/AEL-assets/games-gw/
Games ScummVM /home/kodi/AEL-ROMs/games-scummvm/ /home/kodi/AEL-assets/games-scummvm/
Games The Ultimate Doom /home/kodi/AEL-ROMs/games-doomu/doomu.wad Not applicable
Games Tomb Raider (Open Lara) /home/kodi/AEL-ROMs/games-tombr/ /home/kodi/AEL-assets/games-tombr/
Microsoft MS-DOS /home/kodi/AEL-ROMs/msdos/ /home/kodi/AEL-assets/msdos/
NEC PC Engine /home/kodi/AEL-ROMs/nec-pce/ /home/kodi/AEL-assets/nec-pce/
NEC PC Engine CD-ROM2 /home/kodi/AEL-ROMs/nec-pcecd/ /home/kodi/AEL-assets/nec-pcecd/
NEC PC-FX /home/kodi/AEL-ROMs/nec-pcfx/ /home/kodi/AEL-assets/nec-pcfx/
NEC SuperGrafx /home/kodi/AEL-ROMs/nec-sgx/ /home/kodi/AEL-assets/nec-sgx/
Nintendo Famicom Disk System /home/kodi/AEL-ROMs/nintendo-fds/ /home/kodi/AEL-assets/nintendo-fds/
Nintendo Game Boy /home/kodi/AEL-ROMs/nintendo-gb/ /home/kodi/AEL-assets/nintendo-gb/
Nintendo Game Boy Color /home/kodi/AEL-ROMs/nintendo-gbcolor/ /home/kodi/AEL-assets/nintendo-gbcolor/
Nintendo Game Boy Advance /home/kodi/AEL-ROMs/nintendo-gba/ /home/kodi/AEL-assets/nintendo-gba/
Nintendo GameCube /home/kodi/AEL-ROMs/nintendo-gamecube/ /home/kodi/AEL-assets/nintendo-gamecube/
Nintendo NES /home/kodi/AEL-ROMs/nintendo-nes/ /home/kodi/AEL-assets/nintendo-nes/
Nintendo Nintendo 3DS /home/kodi/AEL-ROMs/nintendo-3ds/ /home/kodi/AEL-assets/nintendo-3ds/
Nintendo Nintendo 64 /home/kodi/AEL-ROMs/nintendo-n64/ /home/kodi/AEL-assets/nintendo-n64/
Nintendo Nintendo 64 Disk Drive /home/kodi/AEL-ROMs/nintendo-n64dd/ /home/kodi/AEL-assets/nintendo-n64dd/
Nintendo Nintendo DS /home/kodi/AEL-ROMs/nintendo-ds/ /home/kodi/AEL-assets/nintendo-ds/
Nintendo Pokemon Mini /home/kodi/AEL-ROMs/nintendo-pokemini/ /home/kodi/AEL-assets/nintendo-pokemini/
Nintendo SNES /home/kodi/AEL-ROMs/nintendo-snes/ /home/kodi/AEL-assets/nintendo-snes/
Nintendo Switch /home/kodi/AEL-ROMs/nintendo-switch/ /home/kodi/AEL-assets/nintendo-switch/
Nintendo Virtual Boy /home/kodi/AEL-ROMs/nintendo-vb/ /home/kodi/AEL-assets/nintendo-vb/
Nintendo Wii /home/kodi/AEL-ROMs/nintendo-wii/ /home/kodi/AEL-assets/nintendo-wii/
Nintendo Wii U /home/kodi/AEL-ROMs/nintendo-wiiu/ /home/kodi/AEL-assets/nintendo-wiiu/
SEGA 32X /home/kodi/AEL-ROMs/sega-32x/ /home/kodi/AEL-assets/sega-32x/
SEGA Dreamcast /home/kodi/AEL-ROMs/sega-dreamcast/ /home/kodi/AEL-assets/sega-dreamcast/
SEGA Game Gear /home/kodi/AEL-ROMs/sega-gg/ /home/kodi/AEL-assets/sega-gg
SEGA Genesis /home/kodi/AEL-ROMs/sega-genesis/ /home/kodi/AEL-assets/sega-genesis
SEGA Master System /home/kodi/AEL-ROMs/sega-sms/ /home/kodi/AEL-assets/sega-sms
SEGA Mega CD /home/kodi/AEL-ROMs/sega-megacd/ /home/kodi/AEL-assets/sega-megacd
SEGA Mega Drive /home/kodi/AEL-ROMs/sega-genesis/ /home/kodi/AEL-assets/sega-genesis
SEGA PICO /home/kodi/AEL-ROMs/sega-pico/ /home/kodi/AEL-assets/sega-pico
SEGA Saturn /home/kodi/AEL-ROMs/sega-saturn/ /home/kodi/AEL-assets/sega-saturn
SEGA SG-1000 /home/kodi/AEL-ROMs/sega-sg1000/ /home/kodi/AEL-assets/sega-sg1000
SNK Neo Geo AES /home/kodi/AEL-ROMs/mame-neogeo/ /home/kodi/AEL-assets/snk-neoaes/
SNK Neo Geo CD /home/kodi/AEL-ROMs/snk-neocd/ /home/kodi/AEL-assets/snk-neocd/
SNK Neo Geo Pocket /home/kodi/AEL-ROMs/snk-ngp/ /home/kodi/AEL-assets/snk-ngp/
SNK Neo Geo Pocket Color /home/kodi/AEL-ROMs/snk-ngpc/ /home/kodi/AEL-assets/snk-ngpc/
SONY PlayStation /home/kodi/AEL-ROMs/sony-psx/ /home/kodi/AEL-assets/sony-psx/
SONY PlayStation 2 /home/kodi/AEL-ROMs/sony-ps2/ /home/kodi/AEL-assets/sony-ps2/
SONY PSP /home/kodi/AEL-ROMs/sony-psp/ /home/kodi/AEL-assets/sony-psp/

Windows

In Windows it is recommended to use the Notepad++ editor to edit the XML files encoded in UTF-8.

Android

Emulator configurations

Linux

  • Retroarch executable is located in /home/kodi/bin/retroarch.

  • Retroarch cores are located in /home/kodi/bin/libretro/.

  • MAME exectuable is located in /usr/games/mame. Remember to edit your mame.ini to include the ROM path. Otherwise MAME will not find the ROMs.

  • Cemu (Wii U emulator) executable is located in /home/kodi/bin/cemu/Cemu.exe. At the time of writing this is a windows-only emulator and thus requires Wine to run. The pyhton wrapper script below can be used to launch games:

#!/usr/bin/python3
# File /home/kodi/bin/cemu-launcher.py
import subprocess
import sys
arg_list = [
   '/usr/bin/wine',
   '/home/kodi/bin/cemu/cemu.exe',
   '-g',
   # Insert Z: and change slashes into backslashes
   '{}'.format('Z:' + sys.argv[1].replace('/', '\\'))
]
subprocess.run(arg_list)
  • Yuzu (Switch emulator) exectuable is located in /home/kodi/bin/yuzu.AppImage.

The XML files with emulator configurations are located in the Launchers XML Linux directory.

Category System Emulators
Kodi Retroplayer Retroarch
Retroarch Retroarch
Arcade Capcom Play System MAME
Arcade MAME MAME
Arcade SEGA MAME
Atari Atari 2600 Retroarch
Atari Atari 5200 Retroarch
Atari Atari 7800 Retroarch
Atari Atari Jaguar Retroarch
Atari Atari Jaguar CD MAME
Atari Atari Lynx Retroarch
Computers Amstrad CPC Retroarch
Computers Atari 8-bit WIP
Computers Atari ST Retroarch
Computers Commodore 64 MAME
Computers Commodore Amiga MAME
Computers Microsoft MSX Retroarch
Computers Microsoft MSX2 Retroarch
Computers Sinclair ZX Spectrum Retroarch
Consoles 3DO Interactive Multiplayer Retroarch
Consoles Amiga CD32 MAME
Consoles Bandai WonderSwan Retroarch
Consoles Bandai WonderSwan Color Retroarch
Consoles Colecovision Retroarch MAME
Consoles Emerson Arcadia 2001 MAME
Consoles Farichild Channel F MAME
Consoles Fujitsu FM Towns Marty MAME
Consoles GCE Vectrex Retroarch
Consoles Magnavox Odyssey 2 Retroarch
Consoles Mattel Intellivision MAME
Consoles Philips Videopac+ G7400 Retroarch
Consoles RCA Studio II MAME
Consoles Watara Supervision MAME
Games Cave Story Retroarch
Games Doom Retroarch
Games Doom II: Hell on Earth Retroarch
Games The Plutonia Experiment Retroarch
Games TNT: Evilution Retroarch
Games Game and Watch Retroarch
Games ScummVM Retroarch
Games The Ultimate Doom Retroarch
Games Tomb Raider (Open Lara) Retroarch
Microsoft MS-DOS Retroarch
NEC PC Engine Retroarch
NEC PC Engine CD-ROM2 Retroarch
NEC PC-FX Retroarch
NEC SuperGrafx Retroarch
Nintendo Famicom Disk System Retroarch
Nintendo Game Boy Retroarch
Nintendo Game Boy Color Retroarch
Nintendo Game Boy Advance Retroarch
Nintendo GameCube Retroarch
Nintendo NES Retroarch
Nintendo Nintendo 3DS Retroarch
Nintendo Nintendo 64 Retroarch
Nintendo Nintendo 64 Disk Drive Retroarch
Nintendo Nintendo DS Retroarch
Nintendo Pokemon Mini Retroarch
Nintendo SNES Retroarch
Nintendo Virtual Boy Retroarch
Nintendo Wii Retroarch
Nintendo Wii U Cemu
Nintendo Switch Yuzu
SEGA 32X Retroarch
SEGA Dreamcast Retroarch
SEGA Game Gear Retroarch
SEGA Genesis Retroarch
SEGA Master System Retroarch MAME
SEGA Mega CD Retroarch
SEGA Mega Drive Retroarch
SEGA PICO Retroarch
SEGA Saturn Retroarch
SEGA SG-1000 Retroarch
SNK Neo Geo AES MAME
SNK Neo Geo CD MAME
SNK Neo Geo Pocket Retroarch
SNK Neo Geo Pocket Color Retroarch
SONY PlayStation Retroarch
SONY PlayStation 2 WIP
SONY PSP Retroarch

Linux wrapper

These configurations use a wrapper script to close Kodi on launching and reopen it again when launched app finishes. The wrapper script works OK in general Linux distros like Kodibuntu, Ubuntu or Debian. Note that you sould activate the non blocking launcher option, otherwise Kodi will not shut down properly.

Linux LibreELEC

These configurations user a wrapper script that closes Kodi on launching and reopens it again when the launched app finishes. This wrapper script works OK in LibreELEC.

Windows

The XML files with emulator configurations are located in the Launchers XML Windows directory.

Android

The XML files with emulator configurations are located in the Launchers XML Android directory.

Useful links

Advanced Emulator Launcher thread in Kodi forum

Image sizes

Icons should have a size of 256x256 or 512x512 pixels. Kodi Wiki, Add on structure Icon

Fanart should have 16:9 aspect ratio. We recommend a 1280x720 JPEG image. It should certainly be no larger than 1920x1080. Kodi Wiki, Add on structure Fanart

Banners sould have a size of 758 x 140 pixels. Kodi Wiki, Wide banner icons

Posters should have an aspect ratio 2:3, so pixel sizes of 666x1000 and 1000x1500 whould be OK. Kodi Forum, Poster art size question

Credits

All NFO files have been compiled by Wintermute0110 with information from the Wikipedia.

Artwork has been taken from many sources including:

If you are the author of some of the assets and want to be credited here contact me opening an issue in Github.