Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-24 15:15:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-05-27 12:53:54 +02:00
parent 7baec8a1f3
commit 107635126e
4 changed files with 69 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
CHANGELOG.md
View file

@ -144,61 +144,78 @@
### Release overview ### Release overview
v1.2 maintenance release. v1.2 maintenance release. Support has been added for multiple systems such as arcade LaserDisc (Daphne) and OpenBOR. A number of default emulators have been changed, some standalone emulators have been added and a number of bugs have been fixed. Some low-level functionality has also been implemented to enable more advanced emulator launch options and quite a number of missing theme assets have been created for the default rbsimple-DE theme.
### Detailed list of changes ### Detailed list of changes
* Added configuration for the Daphne arcade LaserDisc system using the emulator Hypseus Singe * Added configuration for the Daphne arcade LaserDisc system using the Hypseus Singe emulator
* Added configuration for the OpenBOR game engine on Linux and Windows * Added configuration for the OpenBOR game engine on Linux and Windows
* Added emulator configuration for the astrocde (Bally Astrocade) system * Added emulator configuration for the astrocde (Bally Astrocade) and cdtv systems
* Added scraper support for the astrocde system (ScreenScraper and TheGamesDB)
* Removed the --escape-exit command line option for the PPSSPP standalone emulator as it caused issues for some users
* Changed the default emulator for the famicom, fds and nes systems from Nestopia UE to Mesen * Changed the default emulator for the famicom, fds and nes systems from Nestopia UE to Mesen
* Changed the default emulator for the gb and gbc systems from SameBoy to Gambatte * Changed the default emulator for the gb and gbc systems from SameBoy to Gambatte
* Changed the default emulator for the gamegear system from Gearsystem to Genesis Plus GX * Changed the default emulator for the gamegear and sg-1000 systems from Gearsystem to Genesis Plus GX
* Changed the default emulator for the dos and pc systems from DOSBox-Core to DOSBox-Pure * Changed the default emulator for the dos and pc systems from DOSBox-Core to DOSBox-Pure
* Changed the default emulator for the mame system from MAME 2003-Plus to MAME - Current * Changed the default emulator for the mame system from MAME 2003-Plus to MAME - Current
* Added the Gearcoleco RetroArch core for the colecovision system and set it as the default emulator * Removed the --escape-exit command line option for the PPSSPP standalone emulator as it caused issues for some users
* Added DOSBox-X standalone as an alternative emulator for the dos and pc systems * Added experimental support for PCSX2 Qt and PCSX2 wxWidgets for the ps2 system on Windows
* Added AetherSX2 standalone as an alternative emulator for the ps2 system on macOS * Added AetherSX2 standalone as an alternative emulator for the ps2 system on macOS
* Added the Flycast RetroArch core and Flycast Standalone as alternative emulators for the arcade and mame systems * Added DOSBox-X standalone as an alternative emulator for the dos and pc systems
* Added bsnes standalone as an alternative emulator for the satellaview, sfc, snes, snesna and sufami systems
* Added Snes9x standalone as an alternative emulator for the satellaview and sufami systems
* Added Atari800 standalone as an alternative emulator for the atarixe system * Added Atari800 standalone as an alternative emulator for the atarixe system
* Added the Flycast RetroArch core and Flycast standalone as alternative emulators for the arcade and mame systems
* Added the Gearcoleco RetroArch core as an alternative emulator for the colecovision system
* Added Nestopia UE standalone as an alternative emulator for the famicom, fds and nes systems on Unix
* Added DeSmuME standalone as an alternative emulator for the nds system on Unix
* Added Model 2 Emulator standalone as an alternative emulator for the arcade and mame systems on Windows
* Added Supermodel standalone as an alternative emulator for the arcade and mame systems on Windows
* Added the file extensions .ciso, .dump, .gz, .m3u, .mdf, .img and .nrg to the ps2 system * Added the file extensions .ciso, .dump, .gz, .m3u, .mdf, .img and .nrg to the ps2 system
* Added the "citra" binary for Citra standalone on Linux (makes it possible to use the repository or AUR release) * Removed the .chd file extension from the naomi, naomigd and atomiswave systems
* Changed the steam platform to use the ScreenScraper "PC Windows" platform ID * Removed the .bin file extension from the pcengine, pcenginecd, tg16 and tg-cd systems
* Added the "citra" binary for Citra standalone on Linux (making it possible to use the repository or AUR release)
* Removed the -full-screen command line option for the xemu emulator
* Set %STARTDIR%=%EMUDIR% for the xenia (Xbox 360) emulator
* Added scraper support for the astrocde platform
* Added scraper support for the arcadia (Emerson Arcadia 2001) and crvision (VTech CreatiVision) platforms
* Changed the platform to arcade for the atomiswave, naomi and naomigd systems to improve scraping
* Added TheGamesDB scraper support for the atomiswave and naomi platforms
* Added a new pcwindows platform for scraping PC (Windows) games * Added a new pcwindows platform for scraping PC (Windows) games
* Changed the steam platform internally to use the ScreenScraper "PC Windows" platform ID
* Changed the platform to pcwindows for the epic system * Changed the platform to pcwindows for the epic system
* Added scraper support for the platforms arcadia (Emerson Arcadia 2001) and crvision (VTech CreatiVision)
* Enabled screensaver controls when running in Kid UI mode * Enabled screensaver controls when running in Kid UI mode
* Added custom event script triggers on application startup, screensaver start and screensaver end * Added custom event script triggers on application startup, screensaver start and screensaver end
* Added a --create-system-dirs command line option to generate the game system directories * Added a --create-system-dirs command line option to generate the game system directories
* Added an Xbox Kinect controller badge icon
* (macOS) Categorized the application as a game so it shows up in the Launchpad games section
* Added an %INJECT% variable for injecting launch arguments from game config files (required by Hypseus Singe) * Added an %INJECT% variable for injecting launch arguments from game config files (required by Hypseus Singe)
* Added a %GAMEDIR% variable that expands to the game directory (required by Hypseus Singe) * Added a %GAMEDIR% variable that expands to the game directory (required by Hypseus Singe)
* Made the %GAMEDIR% variable usable with the %STARTDIR% variable (required by OpenBOR) * Made the %GAMEDIR% variable usable with the %STARTDIR% variable (required by OpenBOR)
* (Windows) Set %RUNINBACKGROUND% when launching MAME standalone as this emulator may otherwise hang on exit * (Windows) Set %RUNINBACKGROUND% when launching MAME standalone as this emulator may otherwise hang on exit
* (Windows) Added an %ESCAPESPECIALS% variable that escapes the special characters &()^=;, * (Windows) Added an %ESCAPESPECIALS% variable that escapes the special characters &()^=;,
* (Windows) Added %ESCAPESPECIALS% to the desktop, epic, kodi, ports and steam systems * (Windows) Added %ESCAPESPECIALS% to the desktop, epic, kodi, ports and steam systems
* (rbsimple-DE) Added console and controller graphics for the ps2 and ps3 systems
* (rbsimple-DE) Added console graphics for the n3ds, saturn, saturnjp, switch and xbox360 systems
* Added an Xbox Kinect controller badge icon
* Swapped the colors of the Joy-Con controller badge icons
* (macOS) Categorized the application as a game so it shows up in the Launchpad games section
* Replaced the explicit shell commands in es_systems.xml with %EMULATOR_OS-SHELL% find rules * Replaced the explicit shell commands in es_systems.xml with %EMULATOR_OS-SHELL% find rules
* Added experimental support for folder flattening
* Updated the StringUtil::replace function as the old function was dangerous and could run into an endless loop * Updated the StringUtil::replace function as the old function was dangerous and could run into an endless loop
* Added experimental support for folder flattening
### Bug fixes ### Bug fixes
* Chinese characters would sometimes not render correctly
* The "Jump to.." quick selector didn't work correctly with multi-byte Unicode characters
* All games were included in the video and slideshow screeensavers when in Kid UI mode * All games were included in the video and slideshow screeensavers when in Kid UI mode
* The %BASENAME% variable didn't work correctly with the "Directories interpreted as files" functionality
* Under very rare circumstances, games and folders could get mixed up during gamelist.xml parsing * Under very rare circumstances, games and folders could get mixed up during gamelist.xml parsing
* The %BASENAME% variable didn't work correctly with the "Directories interpreted as files" functionality
* The scroll indicators would sometimes not work correctly in the Alternative Emulators screen * The scroll indicators would sometimes not work correctly in the Alternative Emulators screen
* Fixed a minor rounding issue which sometimes led to the menu scroll indicators not being positioned correctly * Fixed a minor rounding issue which sometimes led to the menu scroll indicators not being positioned correctly
* The game-end event was triggered immediately on game launch if running in the background * The game-end event was triggered immediately on game launch if running ES-DE in the background
* The "quit" custom event script trigger was not executed when quitting the application using the quit key combo * The "quit" custom event script trigger was not executed when quitting the application using the quit key combo
* (Linux) Flatpak directories were missing for user installations of the standalone emulators BlastEm, Play! and Snes9x * Chinese characters would sometimes not render correctly
* The "Jump to.." quick selector didn't work correctly with multi-byte Unicode characters
* (Windows) Fixed an issue where symlinking game media directories would crash the application * (Windows) Fixed an issue where symlinking game media directories would crash the application
* (Windows) Scripts and links executed using cmd.exe could not contain the special characters &()^=;, * (Windows) Scripts and links executed using cmd.exe could not contain the special characters &()^=;,
* (Windows) ROM directories could not be created in the root of a device such as D:\ or E:\ * (Windows) ROM directories could not be created in the root of a device such as D:\ or E:\
* (Linux) Flatpak directories were missing for user installations of the standalone emulators BlastEm, Play! and Snes9x
* (rbsimple-DE) The systeminfo text for the saturn and saturnjp systems had mixed up megabytes with megabits
## Version 1.2.3 ## Version 1.2.3

4
FAQ.md
View file

@ -32,6 +32,10 @@ Menus in ES-DE are not lists but grids, sometimes there is only a list but somet
ES-DE comes preconfigured with support for many alternative emulators, see the [What's new in ES-DE v1.2](https://www.youtube.com/watch?v=rpnMJqceSNk) video on the ES-DE YouTube channel for a brief overview of how this works. More emulators are continuously being added with each release. ES-DE comes preconfigured with support for many alternative emulators, see the [What's new in ES-DE v1.2](https://www.youtube.com/watch?v=rpnMJqceSNk) video on the ES-DE YouTube channel for a brief overview of how this works. More emulators are continuously being added with each release.
## I'm using a Steam Deck and ES-DE seems to crash when I attempt to open the main menu?
You've probably mapped your _Back_ button to F4 which is the default application exit key in ES-DE. To fix this, temporarily unmap the button or plug in an external keyboard into your Steam Deck, start ES-DE, open the menu (via the _Escape_ key if using a keyboard) and find the _Exit button combo_ entry in the _Other settings_ menu. You can set this to either F4, Alt + F4 or Alt + Q.
## I'm on Windows and ES-DE can't find my emulators, what is wrong? ## I'm on Windows and ES-DE can't find my emulators, what is wrong?
On Windows ES-DE is shipped as a portable installation and as a regular installer. If you're using the portable installation you need to drop your emulators inside the Emulators directory. Make sure to read the README.txt file directly in the EmulationStation-DE folder for more details. For the regular installer many emulators do not provide a method to inform ES-DE where they are installed, so you will need to add their installation directories to the Path environment variable in Windows. It's strongly recommended to read the _Specific notes for Windows_ section of the [User guide](USERGUIDE.md#specific-notes-for-windows) before attempting to setup and use ES-DE on Windows. On Windows ES-DE is shipped as a portable installation and as a regular installer. If you're using the portable installation you need to drop your emulators inside the Emulators directory. Make sure to read the README.txt file directly in the EmulationStation-DE folder for more details. For the regular installer many emulators do not provide a method to inform ES-DE where they are installed, so you will need to add their installation directories to the Path environment variable in Windows. It's strongly recommended to read the _Specific notes for Windows_ section of the [User guide](USERGUIDE.md#specific-notes-for-windows) before attempting to setup and use ES-DE on Windows.

50
USERGUIDE-DEV.md
View file

@ -813,6 +813,8 @@ For instance `topgunnr.7z` will be expanded to `Top Gunner`.
This is required by the TheGamesDB scraper where the expanded filenames are used for game searches. (Screenscraper natively supports searches using the MAME names). It's also quite nice to have the gamelist populated with the expanded game names even before any scraping has taken place. This is required by the TheGamesDB scraper where the expanded filenames are used for game searches. (Screenscraper natively supports searches using the MAME names). It's also quite nice to have the gamelist populated with the expanded game names even before any scraping has taken place.
If emulating Sega Model 2 games using _Model 2 Emulator_, then you need to change the ROM directory path in the EMULATOR.INI file to point to your Model 2 ROMs. This file is found in the emulator installation directory.
#### Vintage systems emulated using MAME #### Vintage systems emulated using MAME
**Bally Astrocade:** **Bally Astrocade:**
@ -2473,18 +2475,18 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| amiga | Commodore Amiga | PUAE | PUAE 2021 | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc | | amiga | Commodore Amiga | PUAE | PUAE 2021 | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc |
| amiga600 | Commodore Amiga 600 | PUAE | PUAE 2021 | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc | | amiga600 | Commodore Amiga 600 | PUAE | PUAE 2021 | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc |
| amiga1200 | Commodore Amiga 1200 | PUAE | PUAE 2021 | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc | | amiga1200 | Commodore Amiga 1200 | PUAE | PUAE 2021 | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc |
| amigacd32 | Commodore Amiga CD32 | PUAE | PUAE 2021 | | | | amigacd32 | Commodore Amiga CD32 | PUAE | PUAE 2021 | Yes | |
| amstradcpc | Amstrad CPC | Caprice32 | CrocoDS | | | | amstradcpc | Amstrad CPC | Caprice32 | CrocoDS | | |
| android | Google Android | _Placeholder_ | | | | | android | Google Android | _Placeholder_ | | | |
| apple2 | Apple II | _Placeholder_ | | | | | apple2 | Apple II | _Placeholder_ | | | |
| apple2gs | Apple IIGS | _Placeholder_ | | | | | apple2gs | Apple IIGS | _Placeholder_ | | | |
| 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*] | Depends | Single archive file following MAME name standard in root folder | | 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>Model 2 Emulator **(Standalone)** [W*],<br>Supermodel **(Standalone)** [W*] | Depends | Single archive file following MAME name standard in root folder |
| astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** [UMW*] | | Single archive in root folder | | astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** [UMW*] | | Single archive in root folder |
| atari2600 | Atari 2600 | Stella | Stella 2014 | No | Single archive or ROM file in root folder | | atari2600 | Atari 2600 | Stella | Stella 2014 | No | Single archive or ROM file in root folder |
| atari5200 | Atari 5200 | a5200 | Atari800 | | | | atari5200 | Atari 5200 | a5200 | Atari800 | Yes | |
| atari7800 | Atari 7800 ProSystem | ProSystem | | | | | atari7800 | Atari 7800 ProSystem | ProSystem | | Yes | |
| atari800 | Atari 800 | Atari800 | Atari800 **(Standalone)** [UMW*] | No | | | atari800 | Atari 800 | Atari800 | Atari800 **(Standalone)** [UMW*] | No | |
| atarijaguar | Atari Jaguar | Virtual Jaguar | | | | | atarijaguar | Atari Jaguar | Virtual Jaguar | | No | |
| atarijaguarcd | Atari Jaguar CD | Virtual Jaguar | | | | | atarijaguarcd | Atari Jaguar CD | Virtual Jaguar | | | |
| atarilynx | Atari Lynx | Handy | Beetle Lynx | | | | atarilynx | Atari Lynx | Handy | Beetle Lynx | | |
| atarist | Atari ST [also STE and Falcon] | Hatari | | | | | atarist | Atari ST [also STE and Falcon] | Hatari | | | |
@ -2494,11 +2496,11 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| c64 | Commodore 64 | VICE x64sc Accurate | VICE x64 Fast,<br>VICE x64 SuperCPU,<br>VICE x128,<br>Frodo | No | Single disk, tape or cartridge image in root folder and/or multi-disc images in separate folder | | c64 | Commodore 64 | VICE x64sc Accurate | VICE x64 Fast,<br>VICE x64 SuperCPU,<br>VICE x128,<br>Frodo | No | Single disk, tape or cartridge image in root folder and/or multi-disc images in separate folder |
| cavestory | Cave Story (NXEngine) | NXEngine | | | | | cavestory | Cave Story (NXEngine) | NXEngine | | | |
| cdimono1 | Philips CD-i | SAME CDi | CDi 2015 | Yes | Single .bin/.cue pair in root folder | | cdimono1 | Philips CD-i | SAME CDi | CDi 2015 | Yes | Single .bin/.cue pair in root folder |
| cdtv | Commodore CDTV | _Placeholder_ | | | | | cdtv | Commodore CDTV | PUAE | PUAE 2021 | Yes | |
| chailove | ChaiLove Game Engine | ChaiLove | | | | | chailove | ChaiLove Game Engine | ChaiLove | | | |
| channelf | Fairchild Channel F | FreeChaF | | | | | channelf | Fairchild Channel F | FreeChaF | | | |
| coco | Tandy Color Computer | _Placeholder_ | | | | | coco | Tandy Color Computer | _Placeholder_ | | | |
| colecovision | ColecoVision | Gearcoleco | blueMSX | | | | colecovision | ColecoVision | blueMSX | Gearcoleco | | |
| daphne | Daphne Arcade LaserDisc Emulator | Hypseus [Daphne] **(Standalone)** [UW*] | Hypseus [Singe] **(Standalone)** [UW*] | Yes (Daphne games) | See the specific _Hypseus Singe (Daphne)_ section elsewhere in this guide | | daphne | Daphne Arcade LaserDisc Emulator | Hypseus [Daphne] **(Standalone)** [UW*] | Hypseus [Singe] **(Standalone)** [UW*] | Yes (Daphne games) | See the specific _Hypseus Singe (Daphne)_ section elsewhere in this guide |
| desktop | Desktop Applications | N/A | | No | | | desktop | Desktop Applications | N/A | | No | |
| doom | Doom | PrBoom | | | | | doom | Doom | PrBoom | | | |
@ -2506,10 +2508,10 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| dragon32 | Dragon 32 | _Placeholder_ | | | | | dragon32 | Dragon 32 | _Placeholder_ | | | |
| dreamcast | Sega Dreamcast | Flycast | Flycast **(Standalone)** [UMW*],<br>Redream **(Standalone)** [UMW*] | No | In separate folder | | 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 | Shell script/batch file in root folder | | epic | Epic Games Store | Epic Games Store application **(Standalone)** | | No | Shell script/batch file in root folder |
| famicom | Nintendo Family Computer | Mesen | Nestopia UE,<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 | 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 | | 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 | | 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>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 | Yes | Single archive or ROM file in root folder |
| gameandwatch | Nintendo Game and Watch | GW | | | | | 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 | | |
| 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 | | 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 |
@ -2524,7 +2526,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| lutris | Lutris Open Gaming Platform | Lutris application **(Standalone)** [U] | | No | Shell script in root folder | | lutris | Lutris Open Gaming Platform | Lutris application **(Standalone)** [U] | | No | Shell script in root folder |
| lutro | Lutro Game Engine | Lutro | | | | | lutro | Lutro Game Engine | Lutro | | | |
| macintosh | Apple Macintosh | _Placeholder_ | | | | | macintosh | Apple Macintosh | _Placeholder_ | | | |
| 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*] | Depends | Single archive file following MAME name standard in root folder | | 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>Model 2 Emulator **(Standalone)** [W*],<br>Supermodel **(Standalone)** [W*] | Depends | Single archive file following MAME name standard in root folder |
| mame-advmame | AdvanceMAME | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder | | mame-advmame | AdvanceMAME | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder |
| mame-mame4all | MAME4ALL | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder | | mame-mame4all | MAME4ALL | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder |
| 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 | No | Single archive or ROM file in root folder |
@ -2543,11 +2545,11 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| naomigd | Sega NAOMI GD-ROM | Flycast | Flycast **(Standalone)** [UMW*] | | | | naomigd | Sega NAOMI GD-ROM | Flycast | Flycast **(Standalone)** [UMW*] | | |
| n3ds | Nintendo 3DS | Citra [UW],<br>Citra **(Standalone)** [M] | Citra 2018 [UW],<br>Citra **(Standalone)** [UW*] | No | Single ROM file in root folder | | n3ds | Nintendo 3DS | Citra [UW],<br>Citra **(Standalone)** [M] | Citra 2018 [UW],<br>Citra **(Standalone)** [UW*] | No | Single ROM file in root folder |
| n64 | Nintendo 64 | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | ParaLLEl N64 [UW],<br>Mupen64Plus **(Standalone)** [UMW*],<br>sixtyforce **(Standalone)** [M] | No | Single archive or ROM file in root folder | | n64 | Nintendo 64 | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | ParaLLEl N64 [UW],<br>Mupen64Plus **(Standalone)** [UMW*],<br>sixtyforce **(Standalone)** [M] | No | Single archive or ROM file in root folder |
| nds | Nintendo DS | DeSmuME | DeSmuME 2015,<br>melonDS,<br>melonDS **(Standalone)** [UMW*] | | | | nds | Nintendo DS | DeSmuME | DeSmuME 2015,<br>DeSmuME **(Standalone)** [U],<br>melonDS,<br>melonDS **(Standalone)** [UMW*] | No | |
| neogeo | SNK Neo Geo | FinalBurn Neo | | Yes | Single archive file following MAME name standard in root folder | | neogeo | SNK Neo Geo | FinalBurn Neo | | Yes | Single archive file following MAME name standard in root folder |
| neogeocd | SNK Neo Geo CD | NeoCD | | Yes | Single archive in root folder (which includes the CD image and ripped audio) | | 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) | | 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>FCEUmm,<br>QuickNES | No | Single archive or ROM file in root folder | | 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 | | | | ngp | SNK Neo Geo Pocket | Beetle NeoPop | RACE | | |
| ngpc | SNK Neo Geo Pocket Color | Beetle NeoPop | RACE | | | | ngpc | SNK Neo Geo Pocket Color | Beetle NeoPop | RACE | | |
| odyssey2 | Magnavox Odyssey2 | O2EM | | | | | odyssey2 | Magnavox Odyssey2 | O2EM | | | |
@ -2562,14 +2564,14 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| pcfx | NEC PC-FX | Beetle PC-FX | | | | | pcfx | NEC PC-FX | Beetle PC-FX | | | |
| pokemini | Nintendo Pokémon Mini | PokeMini | | No | | | pokemini | Nintendo Pokémon Mini | PokeMini | | No | |
| ports | Ports | N/A | | No | Shell/batch script in separate folder (possibly combined with game data) | | ports | Ports | N/A | | No | Shell/batch script in separate folder (possibly combined with game data) |
| ps2 | Sony PlayStation 2 | PCSX2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 **(Standalone)** [UW],<br>Play! **(Standalone)** [UMW*],<br>AetherSX2 **(Standalone)** [M] | Yes (No for Play!) | | | ps2 | Sony PlayStation 2 | PCSX2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 **(Standalone)** [UW],<br>PCSX2 Qt **(Standalone)** [W*],<br>PCSX2 wxWidgets **(Standalone)** [W*],<br>Play! **(Standalone)** [UMW*],<br>AetherSX2 **(Standalone)** [M] | Yes (No for Play!) | |
| ps3 | Sony PlayStation 3 | RPCS3 **(Standalone)** [UMW*] | | Yes | In separate folder (one folder per game with complete file structure retained, renamed to the .ps3 extension) | | ps3 | Sony PlayStation 3 | RPCS3 **(Standalone)** [UMW*] | | Yes | In separate folder (one folder per game with complete file structure retained, renamed to the .ps3 extension) |
| ps4 | Sony PlayStation 4 | _Placeholder_ | | | | | ps4 | Sony PlayStation 4 | _Placeholder_ | | | |
| psp | Sony PlayStation Portable | PPSSPP | PPSSPP **(Standalone)** | No | Single .iso file in root folder | | psp | Sony PlayStation Portable | PPSSPP | PPSSPP **(Standalone)** | No | Single .iso file in root folder |
| psvita | Sony PlayStation Vita | _Placeholder_ | | | | | psvita | Sony PlayStation Vita | _Placeholder_ | | | |
| 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*] | Yes | .chd file in root folder for single-disc games, .m3u playlist in root folder for multi-disc games |
| samcoupe | SAM Coupé | SimCoupe | | | | | samcoupe | SAM Coupé | SimCoupe | | | |
| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>Mesen-S | | | | 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 | | 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 | | 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 |
| scummvm | ScummVM Game Engine | ScummVM | | No | In separate folder (one folder per game with complete file structure retained) and with a .scummvm file for launching the game | | scummvm | ScummVM Game Engine | ScummVM | | No | In separate folder (one folder per game with complete file structure retained) and with a .scummvm file for launching the game |
@ -2577,15 +2579,15 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| sega32xjp | Sega Super 32X [Japan] | 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 |
| sega32xna | Sega Genesis 32X [North America] | PicoDrive | | No | Single archive or ROM file in root folder | | sega32xna | Sega Genesis 32X [North America] | PicoDrive | | No | Single archive or ROM file in root folder |
| segacd | Sega CD | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive | | | | segacd | Sega CD | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive | | |
| sfc | Nintendo SFC (Super Famicom) | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)** [UMW*],<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>Beetle Supafaust [UW],<br>Mesen-S | No | Single archive or ROM file in root folder | | sfc | Nintendo SFC (Super Famicom) | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)** [UMW*],<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>bsnes **(Standalone)** [UW*],<br>Beetle Supafaust [UW],<br>Mesen-S | No | Single archive or ROM file in root folder |
| sg-1000 | Sega SG-1000 | Gearsystem | Genesis Plus GX,<br>Genesis Plus GX Wide,<br>blueMSX | | | | sg-1000 | Sega SG-1000 | Genesis Plus GX | Genesis Plus GX Wide,<br>Gearsystem,<br>blueMSX | No | |
| snes | Nintendo SNES (Super Nintendo) | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)** [UMW*],<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>Beetle Supafaust [UW],<br>Mesen-S | No | Single archive or ROM file in root folder | | snes | Nintendo SNES (Super Nintendo) | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)** [UMW*],<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>bsnes **(Standalone)** [UW*],<br>Beetle Supafaust [UW],<br>Mesen-S | No | Single archive or ROM file in root folder |
| snesna | Nintendo SNES (Super Nintendo) [North America] | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)** [UMW*],<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>Beetle Supafaust [UW],<br>Mesen-S | No | Single archive or ROM file in root folder | | snesna | Nintendo SNES (Super Nintendo) [North America] | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)** [UMW*],<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>bsnes **(Standalone)** [UW*],<br>Beetle Supafaust [UW],<br>Mesen-S | No | Single archive or ROM file in root folder |
| solarus | Solarus Game Engine | _Placeholder_ | | | | | solarus | Solarus Game Engine | _Placeholder_ | | | |
| spectravideo | Spectravideo | blueMSX | | | | | spectravideo | Spectravideo | blueMSX | | | |
| steam | Valve Steam | Steam application **(Standalone)** | | No | Shell script/batch file in root folder (and .url files supported on Windows) | | steam | Valve Steam | Steam application **(Standalone)** | | No | Shell script/batch file in root folder (and .url files supported on Windows) |
| stratagus | Stratagus Game Engine | _Placeholder_ | | | | | stratagus | Stratagus Game Engine | _Placeholder_ | | | |
| sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy | | | | 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 | | | | supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE | | |
| switch | Nintendo Switch | Yuzu **(Standalone)** [UW] | Ryujinx **(Standalone)** [UW*] | Yes | | | switch | Nintendo Switch | Yuzu **(Standalone)** [UW] | Ryujinx **(Standalone)** [UW*] | Yes | |
| symbian | Symbian | _Placeholder_ | | | | | symbian | Symbian | _Placeholder_ | | | |
@ -2597,18 +2599,18 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| to8 | Thomson TO8 | Theodore | | | | | to8 | Thomson TO8 | Theodore | | | |
| trs-80 | Tandy TRS-80 | _Placeholder_ | | | | | trs-80 | Tandy TRS-80 | _Placeholder_ | | | |
| uzebox | Uzebox | Uzem | | | | | uzebox | Uzebox | Uzem | | | |
| vectrex | Vectrex | vecx | | | | | vectrex | Vectrex | vecx | | No | |
| vic20 | Commodore VIC-20 | VICE xvic | | | Single disk, tape or cartridge image in root folder | | vic20 | Commodore VIC-20 | VICE xvic | | | Single disk, tape or cartridge image in root folder |
| videopac | Philips Videopac G7000 | O2EM | | | | | videopac | Philips Videopac G7000 | O2EM | | | |
| virtualboy | Nintendo Virtual Boy | Beetle VB | | | | | virtualboy | Nintendo Virtual Boy | Beetle VB | | | |
| wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)** [UMW*],<br>PrimeHack **(Standalone)** [U] | | | | wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)** [UMW*],<br>PrimeHack **(Standalone)** [U] | | |
| wiiu | Nintendo Wii U | Cemu **(Standalone)** [W*] | | No | In separate folder | | wiiu | Nintendo Wii U | Cemu **(Standalone)** [W*] | | No | In separate folder |
| wonderswan | Bandai WonderSwan | Beetle Cygne | | | | | wonderswan | Bandai WonderSwan | Beetle Cygne | | No | |
| wonderswancolor | Bandai WonderSwan Color | Beetle Cygne | | | | | wonderswancolor | Bandai WonderSwan Color | Beetle Cygne | | No | |
| x1 | Sharp X1 | x1 | | | Single archive or ROM file in root folder | | x1 | Sharp X1 | x1 | | | Single archive or ROM file in root folder |
| x68000 | Sharp X68000 | PX68k | | | | | x68000 | Sharp X68000 | PX68k | | Yes | |
| xbox | Microsoft Xbox | xemu **(Standalone)** [UMW*] | | Yes | Single .iso file in root folder | | xbox | Microsoft Xbox | xemu **(Standalone)** [UMW*] | | Yes | Single .iso file in root folder |
| xbox360 | Microsoft Xbox 360 | xenia **(Standalone)** [W*] | | No | | | xbox360 | Microsoft Xbox 360 | xenia **(Standalone)** [W*] | | No | |
| zmachine | Infocom Z-machine | _Placeholder_ | | | | | zmachine | Infocom Z-machine | _Placeholder_ | | | |
| zx81 | Sinclair ZX81 | EightyOne | | | | | zx81 | Sinclair ZX81 | EightyOne | | | |
| zxspectrum | Sinclair ZX Spectrum | Fuse | | | | | zxspectrum | Sinclair ZX Spectrum | Fuse | | No | |

2
USERGUIDE.md
View file

@ -785,6 +785,8 @@ For instance `topgunnr.7z` will be expanded to `Top Gunner`.
This is required by the TheGamesDB scraper where the expanded filenames are used for game searches. (Screenscraper natively supports searches using the MAME names). It's also quite nice to have the gamelist populated with the expanded game names even before any scraping has taken place. This is required by the TheGamesDB scraper where the expanded filenames are used for game searches. (Screenscraper natively supports searches using the MAME names). It's also quite nice to have the gamelist populated with the expanded game names even before any scraping has taken place.
If emulating Sega Model 2 games using _Model 2 Emulator_, then you need to change the ROM directory path in the EMULATOR.INI file to point to your Model 2 ROMs. This file is found in the emulator installation directory.
#### Nintendo Switch #### Nintendo Switch
The Nintendo Switch emulator Yuzu is distributed as a Snap package, Flatpak package or AppImage on Linux and as a regular installer on Windows. At the moment there is unfortunately no macOS release of this emulator and it's unclear if it can run on BSD Unix. The Nintendo Switch emulator Yuzu is distributed as a Snap package, Flatpak package or AppImage on Linux and as a regular installer on Windows. At the moment there is unfortunately no macOS release of this emulator and it's unclear if it can run on BSD Unix.