From 7e8566b5570db5381ae71b12d621c32ff76e971d Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Sun, 8 Oct 2023 23:17:47 +0200 Subject: [PATCH] Documentation update --- CHANGELOG.md | 9 ++++++++- USERGUIDE-DEV.md | 21 +++++++++++---------- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5c256ead2..c9e381e81 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,6 +29,7 @@ * Renamed the setting "Only show ROMs from gamelist.xml files" to "Only show games from gamelist.xml files * Added support for deleting installed themes from the theme downloader interface * Added support for the Acorn Archimedes (archimedes) game system +* Added support for the Acorn Electron (electron) game system * Added support for the Bit Corporation Gamate (gamate) game system * Added support for the Sega NAOMI 2 (naomi2) game system * Added support for the Nokia N-Gage (ngage) game system @@ -51,6 +52,8 @@ * Added the .88d, .cmt and .t88 file extensions to the pc88 system * Removed the .7z and .zip file extensions from the pc88 system * Removed the .cdi, .cue, .gdi, .m3u and .iso file extensions from the atomiswave, naomi and naomigd systems +* Added the MAME - Current RetroArch core as the default emulator for the arcadia, crvision, gamecom and gmaster systems +* Added the MAME - Current RetroArch core as the default emulator for the pv1000, scv and vsmile systems * (Linux) Added support for the Microsoft Xbox 360 (xbox360) game system by running xenia via Wine and Proton * (Linux) Added support for the Atari Jaguar CD (atarijaguarcd) game system by running BigPEmu via Wine and Proton * (Linux) Added BigPEmu Wine and BigPEmu Proton as alternative emulators for the atarijaguar system @@ -61,6 +64,7 @@ * (Linux) Added support for the AppImage release of Snes9x * (Linux) Added support for the Flatpak release of Cemu * (Linux) Added the PCSX2 Flatpak release to the non-legacy PCSX2 find rule configuration +* (Linux) Added a find rule entry for the Snap package release of Dolphin * (Linux) Updated the DuckStation find rules as the AppImage release filename has changed * (Linux) Updated the Citra find rules as the AppImage release filename has changed * (Windows) Added 3dSen standalone as an alternative emulator for the famicom and nes systems @@ -107,6 +111,7 @@ * Added theme support for the "manual", "physicalName" and "physicalNameExtension" metadata types for the text element * Added support for binding multiple texture units for use in the shaders * Added the device serial number to the es_log.txt entries when adding or removing controllers +* Improved resilience to buggy controller drivers which could previously crash the application (mostly relevant for macOS) * Changed the application updater to not use the scraper's transfer and connection timeout settings * Added support to MathUtil::md5Hash() for streaming files in chunks * Replaced a number of homecooked functions in FileSystemUtil with those from the C++ standard library @@ -119,6 +124,7 @@ * Added a lot more debug log output to the scraper * Changed a number of stream operations to open files for writing in binary mode (to always create proper Unix line breaks) * Changed the concept of "theme set" to simply "theme" everywhere in the code and documentation +* (Windows) Removed a launch command hack that deleted double quotation marks * (Windows) Added a warning dialog on startup if an unsafe upgrade of the portable release has been made * (Windows) Improved the README.txt file for the portable release * (Windows) Defined UNICODE and _UNICODE in the CMake configuration to force Unicode support for the Win32 API @@ -129,7 +135,7 @@ * (macOS) Completely removed support for the legacy OS build * Updated the MAME index files to include ROMs up to MAME version 0.258 * Bundled the August 2023 release of the Mozilla TLS/SSL certificates -* Updated SDL to 2.28.3 on Windows, macOS and the Linux AppImage builds +* Updated SDL to 2.28.4 on Windows, macOS and the Linux AppImage builds * Updated RapidJSON to commit a95e013b97ca6523f32da23f5095fcc9dd6067e5 * Updated rlottie to commit f969abf62c8df773e3951a1176000e70fcde637f * Updated LunaSVG to 2.3.6 @@ -140,6 +146,7 @@ * The video player would not play the last couple of frames for any videos * Starting the media viewer did not pause fallback game videos (defined using the "default" video property) +* Quotation marks in the launch command were not always handled correctly when combined with the %CORE% variable * The %STARTDIR% variable could not be combined with running ES-DE in the background while launching games on Linux and macOS * Directories interpreted as files entries could not be removed from custom collections * Duplicate ScreenScraper game entries could show up in the interactive scraper if multiple platforms were defined for the system diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index ea35c777b..61270be07 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -3605,8 +3605,8 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | apple2 | Apple II | LinApple **(Standalone)** [U],
Mednafen **(Standalone)** [M],
AppleWin **(Standalone)** [W] | Mednafen **(Standalone)** [UW],
MAME **(Standalone)** | Yes for Mednafen and MAME | See the specific _Apple II_ section elsewhere in this guide | | apple2gs | Apple IIGS | MAME **(Standalone)** | | Yes | See the specific _Apple IIGS_ section elsewhere in this guide | | arcade | Arcade | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)**,
FinalBurn Neo,
FinalBurn Neo **(Standalone)** [UW],
FB Alpha 2012,
Flycast,
Flycast **(Standalone)**,
Kronos [UW],
Model 2 Emulator **(Standalone)** [W],
Model 2 Emulator [Suspend ES-DE] **(Standalone)** [W],
Supermodel **(Standalone)** [UW],
Supermodel [Fullscreen] **(Standalone)** [UW],
_Shortcut or script_ | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | -| arcadia | Emerson Arcadia 2001 | MAME **(Standalone)** | | No | Single archive or ROM file | -| archimedes | Acorn Archimedes | MAME **(Standalone)** [Model A440/1] | MAME **(Standalone)** [Model A3000],
MAME **(Standalone)** [Model A310],
MAME **(Standalone)** [Model A540] | Yes | | +| arcadia | Emerson Arcadia 2001 | MAME - Current | MAME **(Standalone)** | No | Single archive or ROM file | +| archimedes | Acorn Archimedes | MAME [Model A440/1] **(Standalone)** | MAME [Model A3000] **(Standalone)**,
MAME [Model A310] **(Standalone)**,
MAME [Model A540] **(Standalone)** | Yes | | | arduboy | Arduboy Miniature Game System | Arduous | | No | Single archive or .hex file | | astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** | Yes | See the specific _Bally Astrocade_ section elsewhere in this guide | | atari2600 | Atari 2600 | Stella | Stella 2014,
Stella **(Standalone)**,
Gopher2600 **(Standalone)** [UW],
ares **(Standalone)** | No | Single archive or ROM file | @@ -3632,7 +3632,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | cps1 | Capcom Play System I | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)**,
FinalBurn Neo,
FinalBurn Neo **(Standalone)** [UW],
FB Alpha 2012,
FB Alpha 2012 CPS-1 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | | cps2 | Capcom Play System II | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)**,
FinalBurn Neo,
FinalBurn Neo **(Standalone)** [UW],
FB Alpha 2012,
FB Alpha 2012 CPS-2 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | | cps3 | Capcom Play System III | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)**,
FinalBurn Neo,
FinalBurn Neo **(Standalone)** [UW],
FB Alpha 2012,
FB Alpha 2012 CPS-3 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | -| crvision | VTech CreatiVision | MAME **(Standalone)** | | Yes | Single archive or ROM file | +| crvision | VTech CreatiVision | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file | | daphne | Daphne Arcade LaserDisc Emulator | Hypseus [Daphne] **(Standalone)** [UW] | Hypseus [Singe] **(Standalone)** [UW] | Yes for Daphne games | See the specific _Hypseus Singe (Daphne)_ section elsewhere in this guide | | desktop | Desktop Applications | _Suspend ES-DE_ | _Keep ES-DE running_,
_AppImage (Suspend ES-DE)_ [U],
_AppImage (Keep ES-DE running)_ [U] | No | See the specific _Ports and desktop applications_ section elsewhere in this guide | | doom | Doom | PrBoom | PrBoom+ **(Standalone)**,
Boom 3 [UW],
Boom 3 xp [UW],
_Shortcut or script_ | No | | @@ -3640,6 +3640,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | dragon32 | Dragon Data Dragon 32 | XRoar Dragon 32 **(Standalone)** | XRoar Dragon 64 **(Standalone)** | Yes | See the specific _Dragon 32 and Tano Dragon_ section elsewhere in this guide | | dreamcast | Sega Dreamcast | Flycast | Flycast **(Standalone)**,
Redream **(Standalone)** | No | In separate folder interpreted as a file, with .m3u playlist if multi-disc game | | easyrpg | EasyRPG Game Engine | EasyRPG | EasyRPG Player **(Standalone)** | No | See the specific _EasyRPG Game Engine_ section elsewhere in this guide | +| electron | Acorn Electron | MAME [Tape] **(Standalone)** | MAME [Diskette DFS] **(Standalone)**,
MAME [Diskette ADFS] **(Standalone)** | Yes | Single archive, or single tape or diskette image file | | emulators | Emulators | _Suspend ES-DE_ | _Keep ES-DE running_,
_AppImage (Suspend ES-DE)_ [U],
_AppImage (Keep ES-DE running)_ [U] | No | See the specific _Ports and desktop applications_ section elsewhere in this guide | | epic | Epic Games Store | Epic Games Store **(Standalone)** | | No | Shortcut (.desktop/.app/.lnk) file | | famicom | Nintendo Family Computer | Mesen | Mesen **(Standalone)** [UW],
Nestopia UE,
Nestopia UE **(Standalone)** [U],
FCEUmm,
QuickNES,
puNES **(Standalone)** [UW],
Mednafen **(Standalone)**,
ares **(Standalone)**,
ares FDS **(Standalone)**,
3dSen **(Wine)** [U],
3dSen **(Proton)** [U],
3dSen **(Standalone)** [W] | No | Single archive or ROM file. For Famicom games in 3D see the specific _Nintendo NES and Famicom in 3D_ section elsewhere in this guide | @@ -3649,16 +3650,16 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | flash | Adobe Flash | Ruffle **(Standalone)** | Lightspark **(Standalone)** [U],
ArcadeFlashWeb **(Standalone)** [W] | No | Single .swf file | | fmtowns | Fujitsu FM Towns | Tsugaru **(Standalone)** [UW] | | Yes | See the specific _Fujitsu FM Towns_ section elsewhere in this guide | | fpinball | Future Pinball | Future Pinball **(Standalone)** [W] | | No | | -| gamate | Bit Corporation Gamate | MAME **(Standalone)** | | Yes | Single archive or ROM file | +| gamate | Bit Corporation Gamate | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file | | gameandwatch | Nintendo Game and Watch | MAME Local Artwork **(Standalone)** | MAME **(Standalone)**,
Handheld Electronic (GW) | No | See the specific _LCD handheld games_ section elsewhere in this guide | -| gamecom | Tiger Electronics Game.com | MAME **(Standalone)** | | Yes | Single archive or ROM file | +| gamecom | Tiger Electronics Game.com | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file | | gamegear | Sega Game Gear | Genesis Plus GX | Genesis Plus GX Wide,
Gearsystem,
SMS Plus GX,
PicoDrive,
Mednafen **(Standalone)**,
ares **(Standalone)** | No | Single archive or ROM file | | gb | Nintendo Game Boy | Gambatte | SameBoy,
SameBoy **(Standalone)**,
Gearboy,
Gearboy **(Standalone)** [UW],
TGB Dual,
Mesen-S,
Mesen **(Standalone)** [UW],
bsnes,
mGBA,
mGBA **(Standalone)**,
VBA-M,
VBA-M **(Standalone)**,
ares **(Standalone)**,
SkyEmu **(Standalone)** | No | Single archive or ROM file | | gba | Nintendo Game Boy Advance | mGBA | mGBA **(Standalone)**,
VBA-M,
VBA-M **(Standalone)**,
VBA Next,
gpSP,
ares **(Standalone)**,
SkyEmu **(Standalone)** | Yes for ares | Single archive or ROM file | | gbc | Nintendo Game Boy Color | Gambatte | SameBoy,
SameBoy **(Standalone)**,
Gearboy,
Gearboy **(Standalone)** [UW],
TGB Dual,
Mesen-S,
Mesen **(Standalone)** [UW],
bsnes,
mGBA,
mGBA **(Standalone)**,
VBA-M,
VBA-M **(Standalone)**,
ares **(Standalone)**,
SkyEmu **(Standalone)** | No | Single archive or ROM file | | gc | Nintendo GameCube | Dolphin | Dolphin **(Standalone)**,
PrimeHack **(Standalone)** [UW],
Triforce **(Standalone)** [UW] | No | Disc image file for single-disc games, .m3u playlist for multi-disc games | | genesis | Sega Genesis | Genesis Plus GX | Genesis Plus GX Wide,
PicoDrive,
BlastEm,
BlastEm **(Standalone)** [U],
Mednafen **(Standalone)**,
ares **(Standalone)** | No | Single archive or ROM file | -| gmaster | Hartung Game Master | MAME **(Standalone)** | | Yes | Single archive or ROM file | +| gmaster | Hartung Game Master | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file | | gx4000 | Amstrad GX4000 | Caprice32 | CrocoDS,
MAME **(Standalone)** | No | Single archive or ROM file | | intellivision | Mattel Electronics Intellivision | FreeIntv | | | | | j2me | Java 2 Micro Edition (J2ME) | SquirrelJME | KEmulator **(Standalone)** [W] | No | Single .jar file | @@ -3722,14 +3723,14 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | psp | Sony PlayStation Portable | PPSSPP | PPSSPP **(Standalone)** | No | Single disc image file | | 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,
PCSX ReARMed,
SwanStation,
DuckStation **(Standalone)**,
Mednafen **(Standalone)** | Yes | .chd file for single-disc games, .m3u playlist for multi-disc games | -| pv1000 | Casio PV-1000 | MAME **(Standalone)** | | No | Single archive or ROM file | +| pv1000 | Casio PV-1000 | MAME - Current | MAME **(Standalone)** | No | Single archive or ROM file | | quake | Quake | TyrQuake | vitaQuake 2,
vitaQuake 2 [Rogue],
vitaQuake 2 [Xatrix],
vitaQuake 2 [Zaero],
vitaQuake 3 [UW],
_Shortcut or script_ | No | | | samcoupe | MGT SAM Coupé | SimCoupé **(Standalone)** | | No | Single archive or ROM file | | satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [UW],
Mesen-S,
Mesen **(Standalone)** [UW],
ares **(Standalone)** | | | | saturn | Sega Saturn | Beetle Saturn | Kronos [UW],
YabaSanshiro [UW],
Yabause,
Mednafen **(Standalone)**,
SSF **(Standalone)** [W] | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game | | saturnjp | Sega Saturn [Japan] | Beetle Saturn | Kronos [UW],
YabaSanshiro [UW],
Yabause,
Mednafen **(Standalone)**,
SSF **(Standalone)** [W] | 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 | -| scv | Epoch Super Cassette Vision | MAME **(Standalone)** | | Yes | Single archive or ROM file | +| scv | Epoch Super Cassette Vision | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file | | sega32x | Sega Mega Drive 32X | PicoDrive | ares **(Standalone)** | No | Single archive or ROM file | | sega32xjp | Sega Super 32X [Japan] | PicoDrive | ares **(Standalone)** | No | Single archive or ROM file | | sega32xna | Sega Genesis 32X [North America] | PicoDrive | ares **(Standalone)** | No | Single archive or ROM file | @@ -3747,7 +3748,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [UW],
ares **(Standalone)** | | | | supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,
ares **(Standalone)** | | | | supervision | Watara Supervision | Potator | | No | Single archive or ROM file | -| supracan | Funtech Super A'Can | MAME **(Standalone)** | | Yes/No | Single archive or ROM file. To make MAME start these games create an empty file named internal_68k.bin and zip it into supracan.zip | +| supracan | Funtech Super A'Can | MAME - Current | MAME **(Standalone)** | Yes/No | Single archive or ROM file. To make MAME start these games create an empty file named internal_68k.bin and zip it into supracan.zip | | switch | Nintendo Switch | Yuzu **(Standalone)** [UW],
Ryujinx **(Standalone)** [M] | Ryujinx **(Standalone)** [UW] | Yes | | | symbian | Symbian | EKA2L1 [Nokia N-Gage] **(Standalone)** | EKA2L1 [Nokia N70] **(Standalone)**,
EKA2L1 [Nokia N97] **(Standalone)**,
EKA2L1 [Custom device] **(Standalone)** | Yes | See the specific _Symbian and Nokia N-Gage_ section elsewhere in this guide | | tanodragon | Tano Dragon | XRoar **(Standalone)** | | Yes | See the specific _Dragon 32 and Tano Dragon_ section elsewhere in this guide | @@ -3765,7 +3766,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | videopac | Philips Videopac G7000 | O2EM | | | | | virtualboy | Nintendo Virtual Boy | Beetle VB | Mednafen **(Standalone)** | No | | | vpinball | Visual Pinball | Visual Pinball **(Standalone)** [UW] | | No | In separate folder interpreted as a file | -| vsmile | VTech V.Smile | MAME **(Standalone)** | | Yes | Single archive or ROM file | +| vsmile | VTech V.Smile | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file | | wasm4 | WASM-4 Fantasy Console | WASM-4 | | No | Single .wasm file | | wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)**,
PrimeHack **(Standalone)** [UW] | No | | | wiiu | Nintendo Wii U | Cemu **(Standalone)** | | No | See the specific _Nintendo Wii U_ section elsewhere in this guide |