mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2025-01-18 15:15:37 +00:00
Documentation update
This commit is contained in:
parent
192035e16a
commit
456f9be771
|
@ -21,6 +21,7 @@
|
|||
* Dramatically improved start times for the video and slideshow screensavers on devices with poor disk I/O performance (like Android)
|
||||
* Added support for skipping the scanning of game system subdirectories (by using noload.txt files)
|
||||
* Added an error popup if incorrect credentials (username and password) are used when scraping using ScreenScraper
|
||||
* Added a "Dark and red" menu color scheme to improve perceived contrast on low-contrast displays
|
||||
* (Android) Added support for the Dragon Data Dragon 32 (dragon32) game system
|
||||
* (Android) Added support for the Tano Dragon (tanodragon) game system
|
||||
* (Android) Changed the find rule for Ruffle to make game launching work again after a code change in the emulator
|
||||
|
|
|
@ -2136,7 +2136,7 @@ Just make sure to not place the portable installation on a network share that us
|
|||
|
||||
There are numerous locations throughout ES-DE where custom scripts can be executed if the option to do so has been enabled in the settings. You'll find the option _Enable custom event scripts_ on the Main menu under _Other settings_. By default this setting is deactivated so make sure to enable it to use this feature.
|
||||
|
||||
The approach is quite straightforward, ES-DE will look for any files inside a script directory that corresponds to the event that is triggered and will then attempt to execute all these files (regardless of their file extensions). If you want to have the scripts executed in a certain order you can name them accordingly as they will be sorted and executed in lexicographic order. The sorting is case-sensitive on Unix/Linux and case-insensitive on macOS and Windows. ES-DE will wait for each script to finish its execution before moving on to the next one, so the application will suspend briefly when whatever the script is doing is executing. If you want to avoid this you can setup a wrapper script that executes another script outside the ES-DE scripts directory as a background process. Refer to your operating system documentation on how to accomplish this.
|
||||
The approach is quite straightforward, ES-DE will look for any files inside a script directory that corresponds to the event that is triggered and will then attempt to execute all these files (regardless of their file extensions). If you want to have the scripts executed in a certain order you can name them accordingly as they will be sorted and executed in lexicographic order. The sorting is case-sensitive on Linux and Android and case-insensitive on macOS and Windows. ES-DE will wait for each script to finish its execution before moving on to the next one, so the application will suspend briefly when whatever the script is doing is executing. If you want to avoid this you can setup a wrapper script that executes another script outside the ES-DE scripts directory as a background process. Refer to your operating system documentation on how to accomplish this.
|
||||
|
||||
On Windows it's also possible to place .lnk shortcut files in the event directories to have these executed in the same manner as a script. Note that while PowerShell scripts can't be executed directly they can be run via either a .lnk shortcut file or a .bat wrapper script where you explicitly call powershell.exe with the -command flag. Just be aware that by default the execution of PowerShell scripts is disabled on Windows. Further details about PowerShell is beyond the scope of this document.
|
||||
|
||||
|
@ -2163,11 +2163,11 @@ We'll go through two examples:
|
|||
* Creating a log file that will record the start and end time for each game we play, letting us see how much time we spend on retro-gaming
|
||||
* Changing the system resolution when launching and returning from a game in order to run the emulator at a lower resolution than ES-DE
|
||||
|
||||
The following examples are for Unix systems, but it works the same way on macOS and Windows (although .bat batch files are used on Windows instead of shell scripts and any spaces in the parameters are not escaped as is the case on Unix and macOS).
|
||||
The following examples are for Linux systems, but it works the same way on Android, macOS and Windows (although .bat batch files are used on Windows instead of shell scripts and any spaces in the parameters are not escaped as is the case on Linux, Android and macOS).
|
||||
|
||||
As can be seen in the table above, the events executed when a game starts and ends are named _game-start_ and _game-end_
|
||||
|
||||
So let's create the folders for these events in the scripts directory. The location is `~/ES-DE/scripts`
|
||||
So let's create the folders for these events inside the application data directory, or more specifically in `~/ES-DE/scripts`
|
||||
|
||||
**Game log**
|
||||
|
||||
|
|
|
@ -2134,7 +2134,7 @@ Just make sure to not place the portable installation on a network share that us
|
|||
|
||||
There are numerous locations throughout ES-DE where custom scripts can be executed if the option to do so has been enabled in the settings. You'll find the option _Enable custom event scripts_ on the Main menu under _Other settings_. By default this setting is deactivated so make sure to enable it to use this feature.
|
||||
|
||||
The approach is quite straightforward, ES-DE will look for any files inside a script directory that corresponds to the event that is triggered and will then attempt to execute all these files (regardless of their file extensions). If you want to have the scripts executed in a certain order you can name them accordingly as they will be sorted and executed in lexicographic order. The sorting is case-sensitive on Unix/Linux and case-insensitive on macOS and Windows. ES-DE will wait for each script to finish its execution before moving on to the next one, so the application will suspend briefly when whatever the script is doing is executing. If you want to avoid this you can setup a wrapper script that executes another script outside the ES-DE scripts directory as a background process. Refer to your operating system documentation on how to accomplish this.
|
||||
The approach is quite straightforward, ES-DE will look for any files inside a script directory that corresponds to the event that is triggered and will then attempt to execute all these files (regardless of their file extensions). If you want to have the scripts executed in a certain order you can name them accordingly as they will be sorted and executed in lexicographic order. The sorting is case-sensitive on Linux and Android and case-insensitive on macOS and Windows. ES-DE will wait for each script to finish its execution before moving on to the next one, so the application will suspend briefly when whatever the script is doing is executing. If you want to avoid this you can setup a wrapper script that executes another script outside the ES-DE scripts directory as a background process. Refer to your operating system documentation on how to accomplish this.
|
||||
|
||||
On Windows it's also possible to place .lnk shortcut files in the event directories to have these executed in the same manner as a script. Note that while PowerShell scripts can't be executed directly they can be run via either a .lnk shortcut file or a .bat wrapper script where you explicitly call powershell.exe with the -command flag. Just be aware that by default the execution of PowerShell scripts is disabled on Windows. Further details about PowerShell is beyond the scope of this document.
|
||||
|
||||
|
@ -2161,11 +2161,11 @@ We'll go through two examples:
|
|||
* Creating a log file that will record the start and end time for each game we play, letting us see how much time we spend on retro-gaming
|
||||
* Changing the system resolution when launching and returning from a game in order to run the emulator at a lower resolution than ES-DE
|
||||
|
||||
The following examples are for Unix systems, but it works the same way on macOS and Windows (although .bat batch files are used on Windows instead of shell scripts and any spaces in the parameters are not escaped as is the case on Unix and macOS).
|
||||
The following examples are for Linux systems, but it works the same way on Android, macOS and Windows (although .bat batch files are used on Windows instead of shell scripts and any spaces in the parameters are not escaped as is the case on Linux, Android and macOS).
|
||||
|
||||
As can be seen in the table above, the events executed when a game starts and ends are named _game-start_ and _game-end_
|
||||
|
||||
So let's create the folders for these events in the scripts directory. The location is `~/ES-DE/scripts`
|
||||
So let's create the folders for these events inside the application data directory, or more specifically in `~/ES-DE/scripts`
|
||||
|
||||
**Game log**
|
||||
|
||||
|
|
|
@ -3243,7 +3243,7 @@ Transition animations to play when navigating between different gamelists, betwe
|
|||
|
||||
**Application language**
|
||||
|
||||
Sets the language for the application user interface. If this option is set to _automatic_ then the language will be auto-detected, which means ES-DE will attempt to use whatever language has been selected in the operating system language settings. If there are no translations available in ES-DE for this precise language then a fallback will be done to the closest match, such as _Svenska_ instead of _Svenska (Finland)_. If no close match is available then ES-DE will revert to the default language which is _English (United States)_. It's also possible to explicitly select a supported language, which will override whatever has been set by the operating system. Note that the onboarding configurator for the Android release is unaffected by this setting. Also note that language auto-detection does not work on the Steam Deck when running in game mode, so there it's necessary to select a language explicitly.
|
||||
Sets the language for the application user interface. If this option is set to _automatic_ then the language will be auto-detected, which means ES-DE will attempt to use whatever language has been selected in the operating system language settings. If there are no translations available in ES-DE for this precise language then a fallback will be done to the closest match, such as _Svenska_ instead of _Svenska (Finland)_. If no close match is available then ES-DE will revert to the default language which is _English (United States)_. It's also possible to explicitly select a supported language, which will override whatever has been set by the operating system. Note that the onboarding configurator for the Android release is unaffected by this setting. Also note that language auto-detection does not work on the Steam Deck when running in game mode, so there it's necessary to select a language explicitly. If you accidentally select a language you didn't intend to, then you can access the application language setting via the second menu entry from the top after opening the main menu, and then after entering this sub-menu by pressing the down button seven times.
|
||||
|
||||
**Quick system select**
|
||||
|
||||
|
@ -3263,7 +3263,7 @@ The order in which to sort your gamelists. This can be overriden per game system
|
|||
|
||||
**Menu color scheme**
|
||||
|
||||
Provides a selection between a _Dark_ and a _Light_ color scheme. This will affect the entire menu system as well as the game launch screen.
|
||||
Provides a selection between the _Dark_, _Dark with red_ and _Light_ color schemes. This will affect the entire menu system as well as the game launch screen.
|
||||
|
||||
**Menu opening animation**
|
||||
|
||||
|
|
Loading…
Reference in a new issue