Documentation update.

This commit is contained in:
Leon Styhre 2022-07-04 20:01:51 +02:00
parent c7eafb384a
commit a265a37312
2 changed files with 34 additions and 26 deletions

View file

@ -158,11 +158,15 @@ v1.2 maintenance release.
### Detailed list of changes
* Added experimental support for Vita3K for the psvita system on Unix and Windows
* Added support for the Creatronic Mega Duck (megaduck) game system
* Added support for the Watara Supervision (supervision) game system
* Added emulator configuration for the apple2 system
* Added emulator configuration for the apple2gs system
* Added emulator configuration for the macintosh system
* Added Mednafen standalone as an alternative emulator for many systems
* Added experimental support for PCSX2 Qt standalone for the ps2 system on Unix
* Added ScummVM standalone as an alternative emulator for the scummvm system
* Added Atari800 standalone as an alternative emulator for the a5200 system
* Added the Kronos RetroArch core as an alternative emulator for the arcade and mame systems
* Added KEmulator standalone as an alternative emulator for the j2me system on Windows
* Added support for the repository-installed PPSSPP standalone (SDL and Qt) on Unix

View file

@ -1454,13 +1454,15 @@ This is what the complete setup could look like:
#### Apple II
On Unix/Linux you can emulate Apple II games using either the [LinApple](http://linapple.sourceforge.net) emulator or MAME standalone and on Windows you can use [AppleWin](https://github.com/AppleWin/AppleWin) or MAME standalone. On macOS there is a port of AppleWin available named [Mariani](https://github.com/sh95014/AppleWin) but it appears broken at the moment as it does not accept any command line parameters. Instead only MAME standalone is supported on macOS for the time being.
On Unix/Linux the default emulator for the apple2 system is [LinApple](http://linapple.sourceforge.net) and on Windows it's [AppleWin](https://github.com/AppleWin/AppleWin). Additionally the alternative emulators [Mednafen](https://mednafen.github.io) and [MAME](https://www.mamedev.org) standalone are supported. On macOS there is a port of AppleWin available named [Mariani](https://github.com/sh95014/AppleWin) but it appears broken at the moment as it does not accept any command line parameters. So instead only Mednafen and MAME are supported on macOS.
Depending on which Unix/Linux operating system you're using, LinApple may not be readily available and you may have to build it from source code or obtain a binary from somewhere on the Internet. See the [Using manually downloaded emulators on Linux](USERGUIDE-DEV.md#using-manually-downloaded-emulators-on-linux) section of this guide for more details on where it needs to be installed. If you're using an OS with access to the AUR, such as Arch or Manjaro, then LinApple is available there. Note that you need to use the _linapple-git_ package though as the regular _linapple_ package does not work correctly.
Depending on which Unix/Linux operating system you're using, LinApple may not be readily available and you may have to build it from source code or obtain a binary from somewhere on the Internet. See the [Using manually downloaded emulators on Linux](USERGUIDE-DEV.md#using-manually-downloaded-emulators-on-linux) section of this guide for more details on where it needs to be installed. If you're using an OS with access to the AUR, such as Arch or Manjaro, then LinApple is available there. Note that you need to use the _linapple-git_ package as the regular _linapple_ package does not work correctly.
Once the LinApple or AppleWin emulator is installed no additional configuration is required, just drop your games into the ~/ROMs/apple2 folder and launch them from inside ES-DE.
If you want to use MAME standalone to emulate Apple II games (or if you're on macOS) then you need to place the following ROM files in the ~/ROMs/apple2 directory:
If using Mednafen you need to place some Apple II ROM files in the emulator firmware directory, refer to the Mednafen documentation for details about this.
If you want to use MAME standalone then you need to place the following ROM files in the ~/ROMs/apple2 directory:
```
a2diskiing.zip
apple2e.zip
@ -2703,17 +2705,17 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| amigacd32 | Commodore Amiga CD32 | PUAE | PUAE 2021 | Yes | |
| amstradcpc | Amstrad CPC | Caprice32 | CrocoDS | | |
| android | Google Android | BlueStacks **(Standalone)** [W] | | No | Shortcut (.lnk) file in root folder |
| apple2 | Apple II | LinApple **(Standalone)** [U],<br>MAME **(Standalone)** [M],<br>AppleWin **(Standalone)** [W*] | MAME **(Standalone)** [UW*] | Yes for MAME | See the specific _Apple II_ section elsewhere in this guide |
| apple2 | Apple II | LinApple **(Standalone)** [U],<br>Mednafen **(Standalone)** [M],<br>AppleWin **(Standalone)** [W*] | Mednafen **(Standalone)** [UW*],<br>MAME **(Standalone)** [UMW*] | Yes for Mednafen and MAME | See the specific _Apple II_ section elsewhere in this guide |
| apple2gs | Apple IIGS | MAME **(Standalone)** [UMW*] | | Yes | See the specific _Apple IIGS_ section elsewhere in this guide |
| arcade | Arcade | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FB Alpha 2012,<br>Flycast,<br>Flycast **(Standalone)** [UMW*],<br>Kronos [UW],<br>Model 2 Emulator **(Standalone)** [W*],<br>Supermodel **(Standalone)** [W*] | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** [UMW*] | | See the specific _Bally Astrocade_ section elsewhere in this guide |
| atari2600 | Atari 2600 | Stella | Stella 2014 | No | Single archive or ROM file in root folder |
| atari5200 | Atari 5200 | a5200 | Atari800 | Yes | |
| atari5200 | Atari 5200 | a5200 | Atari800,<br>Atari800 **(Standalone)** [UMW*] | Yes | |
| atari7800 | Atari 7800 ProSystem | ProSystem | | Yes | |
| atari800 | Atari 800 | Atari800 | Atari800 **(Standalone)** [UMW*] | No | |
| atarijaguar | Atari Jaguar | Virtual Jaguar | | No | |
| atarijaguarcd | Atari Jaguar CD | Virtual Jaguar | | | |
| atarilynx | Atari Lynx | Handy | Beetle Lynx | | |
| atarilynx | Atari Lynx | Handy | Beetle Lynx,<br>Mednafen **(Standalone)** [UMW*] | | |
| atarist | Atari ST [also STE and Falcon] | Hatari | | | |
| atarixe | Atari XE | Atari800 | Atari800 **(Standalone)** [UMW*] | No | |
| atomiswave | Atomiswave | Flycast | Flycast **(Standalone)** [UMW*] | | |
@ -2734,17 +2736,17 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| dragon32 | Dragon 32 | _Placeholder_ | | | |
| dreamcast | Sega Dreamcast | Flycast | Flycast **(Standalone)** [UMW*],<br>Redream **(Standalone)** [UMW*] | No | In separate folder |
| epic | Epic Games Store | Epic Games Store application **(Standalone)** | | No | Shortcut in root folder |
| famicom | Nintendo Family Computer | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>QuickNES | No | Single archive or ROM file in root folder |
| famicom | Nintendo Family Computer | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>QuickNES,<br>Mednafen **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder |
| fba | FinalBurn Alpha | FB Alpha 2012 | FB Alpha 2012 Neo Geo,<br>FB Alpha 2012 CPS-1,<br>FB Alpha 2012 CPS-2,<br>FB Alpha 2012 CPS-3 | Yes | Single archive file following MAME name standard in root folder |
| fbneo | FinalBurn Neo | FinalBurn Neo | | Yes | Single archive file following MAME name standard in root folder |
| fds | Nintendo Famicom Disk System | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm | Yes | Single archive or ROM file in root folder |
| fds | Nintendo Famicom Disk System | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>Mednafen **(Standalone)** [UMW*] | Yes | Single archive or ROM file in root folder |
| gameandwatch | Nintendo Game and Watch | GW | | | |
| gamegear | Sega Game Gear | Genesis Plus GX | Genesis Plus GX Wide,<br>Gearsystem,<br>SMS Plus GX | | |
| gamegear | Sega Game Gear | Genesis Plus GX | Genesis Plus GX Wide,<br>Gearsystem,<br>SMS Plus GX,<br>Mednafen **(Standalone)** [UMW*] | | |
| gb | Nintendo Game Boy | Gambatte | SameBoy,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes,<br>mGBA,<br>mGBA **(Standalone)**,<br>VBA-M,<br>VBA-M **(Standalone)** | No | Single archive or ROM file in root folder |
| gba | Nintendo Game Boy Advance | mGBA | mGBA **(Standalone)**,<br>VBA-M,<br>VBA-M **(Standalone)** [UMW*],<br>VBA Next,<br>gpSP | No | Single archive or ROM file in root folder |
| gbc | Nintendo Game Boy Color | Gambatte | SameBoy,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes,<br>mGBA,<br>mGBA **(Standalone)**,<br>VBA-M,<br>VBA-M **(Standalone)** | No | Single archive or ROM file in root folder |
| gc | Nintendo GameCube | Dolphin | Dolphin **(Standalone)** [UMW*], PrimeHack **(Standalone)** [U] | No | Single .iso file in root folder |
| genesis | Sega Genesis | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive,<br>BlastEm,<br>BlastEm **(Standalone)** [U] | No | Single archive or ROM file in root folder |
| genesis | Sega Genesis | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive,<br>BlastEm,<br>BlastEm **(Standalone)** [U],<br>Mednafen **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder |
| gx4000 | Amstrad GX4000 | _Placeholder_ | | | |
| intellivision | Mattel Electronics Intellivision | FreeIntv | | | |
| j2me | Java 2 Micro Edition (J2ME) | SquirrelJME | KEmulator **(Standalone)** [W*] | No | Single .jar file in root folder |
@ -2755,10 +2757,11 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| mame | Multiple Arcade Machine Emulator | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FB Alpha 2012,<br>Flycast,<br>Flycast **(Standalone)** [UMW*],<br>Kronos [UW],<br>Model 2 Emulator **(Standalone)** [W*],<br>Supermodel **(Standalone)** [W*] | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| mame-advmame | AdvanceMAME | _Placeholder_ | | Depends | |
| mame-mame4all | MAME4ALL | _Placeholder_ | | Depends | |
| mastersystem | Sega Master System | Genesis Plus GX | Genesis Plus GX Wide,<br>SMS Plus GX,<br>Gearsystem,<br>PicoDrive | No | Single archive or ROM file in root folder |
| mastersystem | Sega Master System | Genesis Plus GX | Genesis Plus GX Wide,<br>SMS Plus GX,<br>Gearsystem,<br>PicoDrive,<br>Mednafen **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder |
| megacd | Sega Mega-CD | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive | | |
| megacdjp | Sega Mega-CD [Japan] | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive | | |
| megadrive | Sega Mega Drive | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive,<br>BlastEm,<br>BlastEm **(Standalone)** [U] | No | Single archive or ROM file in root folder |
| megadrive | Sega Mega Drive | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive,<br>BlastEm,<br>BlastEm **(Standalone)** [U],<br>Mednafen **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder |
| megaduck | Creatronic Mega Duck | SameDuck | | No | Single archive or ROM file in root folder |
| mess | Multi Emulator Super System | MESS 2015 | | | |
| model2 | Sega Model 2 | Model 2 Emulator **(Standalone)** [W*] | | | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| model3 | Sega Model 3 | Supermodel **(Standalone)** [W*] | | | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
@ -2777,9 +2780,9 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| neogeo | SNK Neo Geo | FinalBurn Neo | | Yes | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| neogeocd | SNK Neo Geo CD | NeoCD | | Yes | Single archive in root folder (which includes the CD image and ripped audio) |
| neogeocdjp | SNK Neo Geo CD [Japan] | NeoCD | | Yes | Single archive in root folder (which includes the CD image and ripped audio) |
| nes | Nintendo Entertainment System | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>QuickNES | No | Single archive or ROM file in root folder |
| ngp | SNK Neo Geo Pocket | Beetle NeoPop | RACE | | |
| ngpc | SNK Neo Geo Pocket Color | Beetle NeoPop | RACE | | |
| nes | Nintendo Entertainment System | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>QuickNES,<br>Mednafen **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder |
| ngp | SNK Neo Geo Pocket | Beetle NeoPop | RACE,<br>Mednafen **(Standalone)** [UMW*] | | |
| ngpc | SNK Neo Geo Pocket Color | Beetle NeoPop | RACE,<br>Mednafen **(Standalone)** [UMW*] | | |
| odyssey2 | Magnavox Odyssey2 | O2EM | | | |
| openbor | OpenBOR Game Engine | OpenBOR **(Standalone)** [UW] | | | See the specific _OpenBOR_ section elsewhere in this guide |
| oric | Tangerine Computer Systems Oric | Oricutron **(Standalone)** [UW*] | | | See the specific _Tangerine Computer Systems Oric_ section elsewhere in this guide |
@ -2787,9 +2790,9 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| pc | IBM PC | DOSBox-Pure | DOSBox-Core,<br>DOSBox-SVN,<br>DOSBox-X **(Standalone)**,<br>DOSBox Staging **(Standalone)** [UMW*] | No | See the specific _DOS / PC_ section elsewhere in this guide |
| pc88 | NEC PC-8800 Series | QUASI88 | | | |
| pc98 | NEC PC-9800 Series | Neko Project II Kai | Neko Project II | | |
| pcengine | NEC PC Engine | Beetle PCE | Beetle PCE FAST | No | Single archive or ROM file in root folder |
| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST | Yes | |
| pcfx | NEC PC-FX | Beetle PC-FX | | | |
| pcengine | NEC PC Engine | Beetle PCE | Beetle PCE FAST,<br>Mednafen **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder |
| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST,<br>Mednafen **(Standalone)** [UMW*] | Yes | |
| pcfx | NEC PC-FX | Beetle PC-FX | Mednafen **(Standalone)** [UMW*] | Yes | |
| pico8 | PICO-8 Fantasy Console | PICO-8 **(Standalone)** | PICO-8 Splore **(Standalone)** | No | See the specific _PICO-8_ section elsewhere in this guide |
| pokemini | Nintendo Pokémon Mini | PokeMini | | No | |
| ports | Ports | _Various_ | | No | See the specific _Ports and desktop applications_ section elsewhere in this guide |
@ -2798,11 +2801,11 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| ps4 | Sony PlayStation 4 | _Placeholder_ | | | |
| psp | Sony PlayStation Portable | PPSSPP | PPSSPP **(Standalone)** | No | Single .iso file in root folder |
| psvita | Sony PlayStation Vita | Vita3K **(Standalone)** [UW*] | | Yes | See the specific _Sony PlayStation Vita_ section elsewhere in this guide |
| psx | Sony PlayStation | Beetle PSX | Beetle PSX HW,<br>PCSX ReARMed,<br>SwanStation,<br>DuckStation **(Standalone)** [UMW*] | Yes | .chd file in root folder for single-disc games, .m3u playlist in root folder for multi-disc games |
| psx | Sony PlayStation | Beetle PSX | Beetle PSX HW,<br>PCSX ReARMed,<br>SwanStation,<br>DuckStation **(Standalone)** [UMW*],<br>Mednafen **(Standalone)** [UMW*] | Yes | .chd file in root folder for single-disc games, .m3u playlist in root folder for multi-disc games |
| samcoupe | SAM Coupé | SimCoupe | | | |
| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)** [UMW*],<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>bsnes **(Standalone)** [UW*],<br>Mesen-S | | |
| saturn | Sega Saturn | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game |
| saturnjp | Sega Saturn [Japan] | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game |
| saturn | Sega Saturn | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause,<br>Mednafen **(Standalone)** [UMW*] | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game |
| saturnjp | Sega Saturn [Japan] | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause,<br>Mednafen **(Standalone)** [UMW*] | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game |
| scummvm | ScummVM Game Engine | ScummVM | ScummVM **(Standalone)** | No | See the specific _ScummVM_ section elsewhere in this guide |
| sega32x | Sega Mega Drive 32X | PicoDrive | | No | Single archive or ROM file in root folder |
| sega32xjp | Sega Super 32X [Japan] | PicoDrive | | No | Single archive or ROM file in root folder |
@ -2818,11 +2821,12 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| stratagus | Stratagus Game Engine | _Placeholder_ | | | |
| sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)** [UMW*],<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>bsnes **(Standalone)** [UW*] | | |
| supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE | | |
| supervision | Watara Supervision | Potator | | No | Single archive or ROM file in root folder |
| switch | Nintendo Switch | Yuzu **(Standalone)** [UW] | Ryujinx **(Standalone)** [UW*] | Yes | |
| symbian | Symbian | _Placeholder_ | | | |
| tanodragon | Tano Dragon | _Placeholder_ | | | |
| tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST | No | Single archive or ROM file in root folder |
| tg-cd | NEC TurboGrafx-CD | Beetle PCE | Beetle PCE FAST | Yes | |
| tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST,<br>Mednafen **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder |
| tg-cd | NEC TurboGrafx-CD | Beetle PCE | Beetle PCE FAST,<br>Mednafen **(Standalone)** [UMW*] | Yes | |
| ti99 | Texas Instruments TI-99 | MAME **(Standalone)** [UW*] | | Yes | See the specific _Texas Instruments TI-99_ section elsewhere in this guide |
| tic80 | TIC-80 Game Engine | _Placeholder_ | | | |
| to8 | Thomson TO8 | Theodore | | | |
@ -2831,11 +2835,11 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| vectrex | Vectrex | vecx | | No | |
| vic20 | Commodore VIC-20 | VICE xvic | | | Single disk, tape or cartridge image in root folder |
| videopac | Philips Videopac G7000 | O2EM | | | |
| virtualboy | Nintendo Virtual Boy | Beetle VB | | | |
| virtualboy | Nintendo Virtual Boy | Beetle VB | Mednafen **(Standalone)** [UMW*] | No | |
| wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)** [UMW*],<br>PrimeHack **(Standalone)** [U] | | |
| wiiu | Nintendo Wii U | Cemu **(Standalone)** [W*] | | No | See the specific _Nintendo Wii U_ section elsewhere in this guide |
| wonderswan | Bandai WonderSwan | Beetle Cygne | | No | |
| wonderswancolor | Bandai WonderSwan Color | Beetle Cygne | | No | |
| wonderswan | Bandai WonderSwan | Beetle Cygne | Mednafen **(Standalone)** [UMW*] | No | |
| wonderswancolor | Bandai WonderSwan Color | Beetle Cygne | Mednafen **(Standalone)** [UMW*] | No | |
| x1 | Sharp X1 | x1 | | | Single archive or ROM file in root folder |
| x68000 | Sharp X68000 | PX68k | | Yes | |
| xbox | Microsoft Xbox | xemu **(Standalone)** [UMW*] | | Yes | Single .iso file in root folder |