use the same example for both playlist formats

This commit is contained in:
markwkidd 2019-03-27 20:53:39 -04:00 committed by GitHub
parent ba079d1906
commit 20a5d5504f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -50,12 +50,13 @@ Each playlist is a plain text file with an extension of `.lpl`. RetroArch 1.7.5
#### JSON Playlist Format
The following example is a single-entry MAME 2003-Plus playlist for [Alien Arena](https://www.arcade-museum.com/game_detail.php?game_id=6850) -- the silent version of this game is available through the RetroArch **Content Downloader** found in the **Online Updater** menu. This playlist was generated by the playlist scanner but could just as easily be created manually.
The following example is a single-entry MAME 2003-Plus playlist for [Alien Arena](https://www.arcade-museum.com/game_detail.php?game_id=6850) -- the silent version of this game is available through the RetroArch **Content Downloader** found in the **Online Updater** menu.
The playlist is named `MAME 2003-Plus.lpl` which means it will match the existing icon for that core's playlists in the RetroArch assets pack and display it for the playlist for menu drivers that implement playlist icons.
The **Alien Arena** romset is located at `C:\retroarch\downloads\\alienar.zip`; note that the backslashes are doubled in JSON-formatted playlist entries so that the value of the `path` entry is `C:\\retroarch\\downloads\\alienar.zip`.
The **Alien Arena** romset is located at `C:\retroarch\downloads\alienar.zip`; note that the backslashes are doubled in JSON-formatted playlist entries so that the value of the `path` entry is `C:\\retroarch\\downloads\\alienar.zip`.
##### `MAME 2003-Plus.lpl`
```json
{
"version": "1.0",
@ -72,6 +73,9 @@ The **Alien Arena** romset is located at `C:\retroarch\downloads\\alienar.zip`;
}
```
!!! Alert
You can omit the CRC or Serial for a manualy created playlist entry by using the word `DETECT` instead, although it may limit your ability to use netplay for this playlist entry.
#### 6-Line Playlist Format (Deprecated)
!!! Warning
@ -79,18 +83,21 @@ The **Alien Arena** romset is located at `C:\retroarch\downloads\\alienar.zip`;
**Each entry in a playlist must be composed of 6 lines:**
/storage/roms/n64/Legend of Zelda, The - Ocarina of Time (USA).n64
Legend of Zelda, The - Ocarina of Time (USA)
/tmp/cores/mupen64plus_libretro.so
Nintendo 64 (Mupen64Plus)
EC95702D|crc
Nintendo - Nintendo 64.lpl
##### `MAME 2003-Plus.lpl`
```
C:\retroarch\downloads\alienar.zip"
Alien Arena
/tmp/cores/mame2003_plus_libretro.so
DETECT
01ACE2AB|crc
MAME 2003-Plus.lpl
```
1. The path to the ROM. This can either be an 'absolute' path or a path relative to the current working directory.
2. The display name (you can use any name here)
3. The path to the core, this libretro core will be used to launch the ROM. **You can use the word DETECT in place of the core path here. Once this is done you can set the core to be used for this playlist via the RetroArch GUI.**
4. The displayname of the core, not really useful, we keep it there because the history list is also using this format
5. Link to the database entry. The fact that there is a CRC value here means that this playlist entry was originally created by the playlist scanner. In some other cases it is done by serial number. **You can omit a link to the database for a manualy created playlist entry by using the word DETECT here instead.**
5. CRC or Serial number for database and other matching purposes. **You can omit the CRC or Serial for a manualy created playlist entry by using the word DETECT here instead, although it may limit your ability to use Netplay for this playlist entry.**
6. The name of this playlist, ending in the extension .lpl
## Thumbnails