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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2021-08-11 12:16:35 +02:00
parent 18949d375c
commit 38b378d92d
2 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -10,6 +10,10 @@
### Detailed list of changes
* Added a menu option to change the application exit key combination
### Bug fixes
## Version 1.1.0
**Release date:** 2021-08-10

12
USERGUIDE-DEV.md
View file

@ -19,7 +19,7 @@ If you just want to get started as quickly as possible, simply follow these step
5) Start RetroArch and install the required emulator cores
6) Start ES-DE, scrape game media for your collection and play some games!
You can always close the application immediately by pressing F4 on the keyboard.
You can always close the application immediately by using the keyboard, by default the exit key is mapped to F4 but it can be changed to Alt + F4, Alt + Q or Command Q using the _Exit button combo_ menu option.
For additional details, read on below.
@ -273,9 +273,9 @@ _(Insert on Unix and Windows, F13 on macOS)_
Marks games as favorites in the gamelist view (if the _Enable toggle favorites button_ option has been enabled). Used by some other minor functions as explained by the help system and/or this guide.
**F4 (keyboard only)**
**F4 (keyboard only)** _Could alternatively be Alt + F4, Alt + Q or Command + Q_
Quits the application immediately.
Quits the application. This key combination can be changed using the _Exit button combo_ menu option described later in this document.
## Getting your games into ES-DE
@ -686,7 +686,7 @@ It's possible to change the game media directory location from within ES-DE, for
## Main menu
This menu can be accessed from both the system view and gamelist view. It contains the scraper, application settings and various tools such as the input configurator and the miximage generator. Settings are saved when navigating back from any menu screen, assuming at least one setting was changed. Pressing the application exit key (F4) will also save any pending changes.
This menu can be accessed from both the system view and gamelist view. It contains the scraper, application settings and various tools such as the input configurator and the miximage generator. Settings are saved when navigating back from any menu screen, assuming at least one setting was changed. Pressing the application exit key (F4 by default) will also save any pending changes.
![alt text](images/current/es-de_main_menu.png "ES-DE Main Menu")
_The ES-DE main menu._
@ -1159,6 +1159,10 @@ This gives you a choice between _Normal_ and _Borderless_ modes. With the border
This gives the choice between FFmpeg and VLC, which is applied to the gamelist videos, the media viewer and the video screensaver. The VLC video player is not included on some builds. If this option is not available in the menu, it means that the FFmpeg video player is in use.
**Exit button combo**
This gives the choice of which key combination to use to close the application. The default value is F4, but this can be changed to Alt + F4 on all operating systems. Additionally on macOS the Command + Q combination is selectable and on all other operating systems Alt + Q is selectable instead. Note that on Windows and most window managers on Unix/Linux, Alt + F4 will close the application regardless of the selected option as that key combination is a default which can't be restricted by ES-DE. Similarly on macOS, Command + Q always closes the application, so selecting this combination simply disables the previously selected exit button.
**When to save game metadata**
The metadata for a game is updated by scraping or by manual editing using the metadata editor, but also when launching it as this updates the _Times played_ counter and the _Last played_ timestamp. This setting enables you to define when to write such metadata changes to the gamelist.xml files. Setting the option to _Never_ will disable writing to these files altogether, except for some special conditions such as when a game is manually deleted using the metadata editor, or when scraping using the multi-scraper (the multi-scraper will always save any updates immediately to the gamelist.xml files). In theory _On exit_ will give some performance gains, but it's normally recommended to leave the setting at its default value which is _Always_. Note that with the settings set to _Never_, any updates such as the _Last played_ date will still be shown on screen, but during the next application startup, any values previously saved to the gamelist.xml files will be read in again. As well, when changing this setting to _Always_ from either of the two other options, any pending changes will be immediately written to the gamelist.xml files.