From 314f6b115131ca18fe9f6554bdfbc09bffd93619 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Mon, 27 Jun 2022 18:48:26 +0200 Subject: [PATCH] Documentation update. --- CHANGELOG.md | 3 +++ USERGUIDE-DEV.md | 10 ++++++---- USERGUIDE.md | 4 +++- 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 425b836bc..386b8e276 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -155,6 +155,9 @@ v1.2 maintenance release. ### Detailed list of changes * 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 the Kronos RetroArch core as an alternative emulator for the arcade and mame systems +* (macOS) Improved Apple compliance for the Info.plist file ### Bug fixes diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index 81f63eb2f..33a1d0325 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -282,7 +282,9 @@ Lack of controller support is a bit of a problem on macOS, and in some instances ES-DE is available both as an Intel/x86 build and as a native M1/ARM build. If running on an M1 Mac it's possible to launch either M1 or Intel emulators from ES-DE and it's sometimes recommended to go for the Intel versions. The reason is that some emulators are not yet working properly on the M1 architecture, and for RetroArch some cores are only available for the x86 platform. So investigate what makes most sense for your setup. Over time this situation should improve as M1 support matures. -One macOS-specific requirement is that the RetroArch setting _Start in Fullscreen mode_ is enabled or ES-DE will not be able to switch to the emulator window when launching games. As a workaround you can switch to the window manually using Command + Tab but it probably doesn't make sense to run emulators in windowed mode anyway. It's unclear if only RetroArch is affected by this issue, at least it has not been observed for any other emulators so far. The standalone PlayStation 2 emulator PCSX2 has a similar issue but that seems to be GPU driver related and is problematic also on other operating systems. If using this emulator you need to manually switch to the PCSX2 window using Command + Tab after launching a game. If using an M1 Mac then the AetherSX2 emulator is recommended instead of PCSX2. +One macOS-specific requirement is that the RetroArch setting _Start in Fullscreen mode_ is enabled or ES-DE will not be able to switch to the emulator window when launching games. As a workaround you can switch to the window manually using Command + Tab but it probably doesn't make sense to run emulators in windowed mode anyway. This issue has not been observed with any other emulators. The standalone PlayStation 2 emulator PCSX2 seemingly has a similar issue but it's not the same symptoms and it's problematic also on other operating systems. If using this emulator you need to manually switch to the PCSX2 window using Command + Tab after launching a game. If using an M1 Mac then the AetherSX2 emulator is recommended instead of PCSX2 as it does not have this issue and it's also a lot faster. + +At the time of writing there is an additional issue with the M1 release of RetroArch where ES-DE will not be able to consistently switch to its window on game launch if the setting _Close windows when closing an app_ under the General entry in the macOS System Preferences has been set to disabled. This error does not occur for the Intel/x86 release of RetroArch or with any other standalone emulators (including those built specifically for the M1 architecture). The first time you launch a RetroArch-emulated game from within ES-DE the operating system will present you with a security option with the following description: @@ -2562,7 +2564,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | android | Google Android | BlueStacks **(Standalone)** [W] | | No | Shortcut (.lnk) file in root folder | | apple2 | Apple II | _Placeholder_ | | | | | apple2gs | Apple IIGS | _Placeholder_ | | | | -| arcade | Arcade | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)** [UMW*],
FinalBurn Neo,
FB Alpha 2012,
Flycast,
Flycast **(Standalone)** [UMW*],
Model 2 Emulator **(Standalone)** [W*],
Supermodel **(Standalone)** [W*] | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | +| arcade | Arcade | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)** [UMW*],
FinalBurn Neo,
FB Alpha 2012,
Flycast,
Flycast **(Standalone)** [UMW*],
Kronos [UW],
Model 2 Emulator **(Standalone)** [W*],
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 | | @@ -2609,7 +2611,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | lutris | Lutris Open Gaming Platform | Lutris application **(Standalone)** [U] | | No | See the specific _Lutris_ section elsewhere in this guide | | lutro | Lutro Game Engine | Lutro | | | | | macintosh | Apple Macintosh | _Placeholder_ | | | | -| mame | Multiple Arcade Machine Emulator | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)** [UMW*],
FinalBurn Neo,
FB Alpha 2012,
Flycast,
Flycast **(Standalone)** [UMW*],
Model 2 Emulator **(Standalone)** [W*],
Supermodel **(Standalone)** [W*] | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | +| mame | Multiple Arcade Machine Emulator | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)** [UMW*],
FinalBurn Neo,
FB Alpha 2012,
Flycast,
Flycast **(Standalone)** [UMW*],
Kronos [UW],
Model 2 Emulator **(Standalone)** [W*],
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,
SMS Plus GX,
Gearsystem,
PicoDrive | No | Single archive or ROM file in root folder | @@ -2660,7 +2662,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)** [UMW*],
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [UW*],
Mesen-S | | | | saturn | Sega Saturn | Beetle Saturn | Kronos [UW],
YabaSanshiro [UW],
Yabause | 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 | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game | -| scummvm | ScummVM Game Engine | ScummVM | | No | See the specific _ScummVM_ section elsewhere in this guide | +| 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 | | sega32xna | Sega Genesis 32X [North America] | PicoDrive | | No | Single archive or ROM file in root folder | diff --git a/USERGUIDE.md b/USERGUIDE.md index c298f5a59..b81dcc359 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -280,7 +280,9 @@ Lack of controller support is a bit of a problem on macOS, and in some instances ES-DE is available both as an Intel/x86 build and as a native M1/ARM build. If running on an M1 Mac it's possible to launch either M1 or Intel emulators from ES-DE and it's sometimes recommended to go for the Intel versions. The reason is that some emulators are not yet working properly on the M1 architecture, and for RetroArch some cores are only available for the x86 platform. So investigate what makes most sense for your setup. Over time this situation should improve as M1 support matures. -One macOS-specific requirement is that the RetroArch setting _Start in Fullscreen mode_ is enabled or ES-DE will not be able to switch to the emulator window when launching games. As a workaround you can switch to the window manually using Command + Tab but it probably doesn't make sense to run emulators in windowed mode anyway. It's unclear if only RetroArch is affected by this issue, at least it has not been observed for any other emulators so far. The standalone PlayStation 2 emulator PCSX2 has a similar issue but that seems to be GPU driver related and is problematic also on other operating systems. If using this emulator you need to manually switch to the PCSX2 window using Command + Tab after launching a game. If using an M1 Mac then the AetherSX2 emulator is recommended instead of PCSX2. +One macOS-specific requirement is that the RetroArch setting _Start in Fullscreen mode_ is enabled or ES-DE will not be able to switch to the emulator window when launching games. As a workaround you can switch to the window manually using Command + Tab but it probably doesn't make sense to run emulators in windowed mode anyway. This issue has not been observed with any other emulators. The standalone PlayStation 2 emulator PCSX2 seemingly has a similar issue but it's not the same symptoms and it's problematic also on other operating systems. If using this emulator you need to manually switch to the PCSX2 window using Command + Tab after launching a game. If using an M1 Mac then the AetherSX2 emulator is recommended instead of PCSX2 as it does not have this issue and it's also a lot faster. + +At the time of writing there is an additional issue with the M1 release of RetroArch where ES-DE will not be able to consistently switch to its window on game launch if the setting _Close windows when closing an app_ under the General entry in the macOS System Preferences has been set to disabled. This error does not occur for the Intel/x86 release of RetroArch or with any other standalone emulators (including those built specifically for the M1 architecture). The first time you launch a RetroArch-emulated game from within ES-DE the operating system will present you with a security option with the following description: