From 8bd1456c98f8d3696538c384c1aa180a9eaf3374 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Fri, 1 Jul 2022 22:40:59 +0200 Subject: [PATCH] Documentation update. --- CHANGELOG.md | 1 + USERGUIDE-DEV.md | 10 ++++++---- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 47b694962..0a3276546 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -164,6 +164,7 @@ v1.2 maintenance release. * 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 * Added support for the repository-installed PPSSPP standalone (SDL and Qt) on Unix +* Added the .json file extension to the gc and wii systems * Added find rule entries for Valve Steam to simplify the setup of the RetroArch Steam release * Added connection and transfer timeout settings to the scraper (not configurable via the GUI) * Added an es_log.txt entry when the "Only show ROMs from gamelist.xml files" setting is enabled diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index 504d221e8..d12276fdb 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -554,23 +554,25 @@ If ES-DE is unable to find an emulator when a game is launched, a notification p ## Using the Steam release of RetroArch -As this release of RetroArch is executed via the Steam application it's behaving a bit glitchy and strange with ES-DE. This is due to the nature of Steam and it's unavoidable. The following issues have been observed: +As this release of RetroArch is executed via the Steam application it's behaving a bit glitchy and strange with ES-DE (which is due to the nature of Steam). In addition to this there seem to be some bugs in either Steam or RetroArch, or both. The following issues have been observed: * ES-DE will continue to run in the background due to the way that Steam works * Game launching is not seamless and there will be some flickering +* If the Steam GUI is visible, focus may not return to ES-DE when exiting a game. Minimizing Steam increases the chances of this working properly but it's not guaranteed to completely fix the problem +* Filenames containing apostrophes do not work, you need to rename these game files to be able to launch them * Core searches will not work, if an emulator core is missing there will be no error notification inside ES-DE and game launching will just silently fail -* Logging from the emulator is not possible due to ES-DE running in the background +* Logging output from emulators is not possible due to ES-DE running in the background As well, adding support for the Steam release of RetroArch for all systems that ES-DE supports requires hundreds of additional alternative emulator entries. For all these reasons there will be no official support for this release of RetroArch. If you insist on still using it, it's however quite easy to make [custom system configuration](USERGUIDE-DEV.md#game-system-customizations) entries as the setup has been partly prepared in the bundled configuration. -Simply add alternative emulator entries such as the following. This example enables support for the Nestopia UE core for the nes system: +Simply add alternative emulator entries such as the following example which enables support for the Nestopia UE core for the nes system: ``` %RUNINBACKGROUND% %EMULATOR_STEAM% -applaunch 1118310 -L nestopia_libretro %ROM% ``` This will work on both Linux and Windows. -So a complete entry for the nes system could look like the following: +A complete entry for the nes system could look like the following: ``` nes