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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-07-01 17:01:39 +02:00
parent b334e2a5af
commit 639f8842fa
3 changed files with 29 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -88,6 +88,7 @@
* Improved the in-tree build on macOS to not needing to install any libraries when compiling the "external" dependencies * Improved the in-tree build on macOS to not needing to install any libraries when compiling the "external" dependencies
* Large refactoring to improve thread safety and improve singleton pattern usage * Large refactoring to improve thread safety and improve singleton pattern usage
* Made the logging thread safe * Made the logging thread safe
* (Windows) Changed many logging entries to use backslashes instead of forward slashes as directory separators
* Added the build date to to main menu for alpha and dev builds * Added the build date to to main menu for alpha and dev builds
* Moved all Platform functions to the utility namespace instead of using the global namespace * Moved all Platform functions to the utility namespace instead of using the global namespace
* Implemented proper XML attribute support in ThemeData that eliminates the risk of name collisions * Implemented proper XML attribute support in ThemeData that eliminates the risk of name collisions
@ -143,6 +144,8 @@
* Theme sets were not always sorted correctly (as seen when mixing uppercase and lowercase in theme names) * Theme sets were not always sorted correctly (as seen when mixing uppercase and lowercase in theme names)
* The device text flickered in GuiDetectDevice when configuring a controller * The device text flickered in GuiDetectDevice when configuring a controller
* The selector bar was not aligned correctly during menu scale-up animations * The selector bar was not aligned correctly during menu scale-up animations
* (Windows) File paths would get escaped with quotation marks even if they did not contain any spaces
* (Windows) The emulator binary path would sometimes not get escaped correctly in es_log.txt on game launch
## Version 1.2.6 (in development) ## Version 1.2.6 (in development)
@ -161,6 +164,7 @@ v1.2 maintenance release.
* Added ScummVM standalone as an alternative emulator for the scummvm system * 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 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 support for the repository-installed PPSSPP standalone (SDL and Qt) on Unix
* 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 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 * Added an es_log.txt entry when the "Only show ROMs from gamelist.xml files" setting is enabled
* Passing the --ignore-gamelist command line option now immediately disables the ParseGamelistOnly setting * Passing the --ignore-gamelist command line option now immediately disables the ParseGamelistOnly setting

32
USERGUIDE-DEV.md
View file

@ -554,17 +554,35 @@ If ES-DE is unable to find an emulator when a game is launched, a notification p
## Using the Steam release of RetroArch ## Using the Steam release of RetroArch
On Windows it's no problem to use the Steam release of RetroArch although you may have to add the installation location manually to your Path environment variable. By default the following locations will be searched: 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:
* 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
* 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
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:
``` ```
C:\Program Files (x86)\Steam\steamapps\common\RetroArch\retroarch.exe <command label="Nestopia UE (Steam)">%RUNINBACKGROUND% %EMULATOR_STEAM% -applaunch 1118310 -L nestopia_libretro %ROM%</command>
D:\Program Files (x86)\Steam\steamapps\common\RetroArch\retroarch.exe
C:\Program Files\Steam\steamapps\common\RetroArch\retroarch.exe
D:\Program Files\Steam\steamapps\common\RetroArch\retroarch.exe
``` ```
If you have installed RetroArch at another location, simply start the Settings application, search for _path_ in the _Find a setting_ field and choose _Edit environment variables for your account_. Edit the _Path_ variable and add the directory where RetroArch is installed. This is required as there is no apparent way for ES-DE to find where RetroArch has been installed by the Steam application. This will work on both Linux and Windows.
On Linux the Steam release of RetroArch is currently not supported. So a complete entry for the nes system could look like the following:
```
<system>
<name>nes</name>
<fullname>Nintendo Entertainment System</fullname>
<path>%ROMPATH%/nes</path>
<extension>.nes .NES .unf .UNF .unif .UNIF .7z .7Z .zip .ZIP</extension>
<command label="Nestopia UE (Steam)">%RUNINBACKGROUND% %EMULATOR_STEAM% -applaunch 1118310 -L nestopia_libretro %ROM%</command>
<command label="FCEUmm (Steam)">%RUNINBACKGROUND% %EMULATOR_STEAM% -applaunch 1118310 -L fceumm_libretro %ROM%</command>
<platform>nes</platform>
<theme>nes</theme>
</system>
```
## Using emulators in AppImage format on Linux ## Using emulators in AppImage format on Linux

14
USERGUIDE.md
View file

@ -548,20 +548,6 @@ The default es_systems.xml file is paired with a file named es_find_rules.xml wh
If ES-DE is unable to find an emulator when a game is launched, a notification popup will be shown. Likewise a notification will be shown if the defined emulator core is not installed. The es_log.txt file will also provide additional details. If ES-DE is unable to find an emulator when a game is launched, a notification popup will be shown. Likewise a notification will be shown if the defined emulator core is not installed. The es_log.txt file will also provide additional details.
## Using the Steam release of RetroArch
On Windows it's no problem to use the Steam release of RetroArch although you may have to add the installation location manually to your Path environment variable. By default the following locations will be searched:
```
C:\Program Files (x86)\Steam\steamapps\common\RetroArch\retroarch.exe
D:\Program Files (x86)\Steam\steamapps\common\RetroArch\retroarch.exe
C:\Program Files\Steam\steamapps\common\RetroArch\retroarch.exe
D:\Program Files\Steam\steamapps\common\RetroArch\retroarch.exe
```
If you have installed RetroArch at another location, simply start the Settings application, search for _path_ in the _Find a setting_ field and choose _Edit environment variables for your account_. Edit the _Path_ variable and add the directory where RetroArch is installed. This is required as there is no apparent way for ES-DE to find where RetroArch has been installed by the Steam application.
On Linux the Steam release of RetroArch is currently not supported.
## Using emulators in AppImage format on Linux ## Using emulators in AppImage format on Linux
AppImages is a great way to package emulators on Linux as they work across many different distributions, and launching and running them introduces virtually no overhead. There is one small problem though in that there is no standardized directory for storing these files, meaning ES-DE could have issues locating them. AppImages is a great way to package emulators on Linux as they work across many different distributions, and launching and running them introduces virtually no overhead. There is one small problem though in that there is no standardized directory for storing these files, meaning ES-DE could have issues locating them.