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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2023-12-24 00:41:28 +01:00
parent b863861399
commit 0d845ba4af
3 changed files with 15 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -12,10 +12,13 @@
* Renamed the application data directory from .emulationstation to ES-DE
* Split the es_find_rules.xml and es_systems.xml files for Linux and BSD Unix into separate directories
* Added support for defining font sizes from the theme configuration and selecting these from the UI settings menu
* Added the theme font sizes count to the theme downloader interface
* Added support for medium and large font sizes to the Slate and Modern themes
* Added support for .webp, .svg and unanimated .gif files to the slideshow screensaver when using a custom image directory
* Changed the default slideshow custom image directory from slideshow/custom_images to screensavers/custom_slideshow
* Changed the custom slideshow image directory setting from ScreensaverSlideshowImageDir to ScreensaverSlideshowCustomDir
* Added Mednafen standalone as an alternative emulator for the gb, gba and gbc systems
* (Linux) Added support for the AppImage release of Vita3K
* Added the .zso file extension to the ps2 system
* Added the .zar file extension to the xbox360 system on Linux and Windows
* Added the .pk3 and .ipk3 file extensions to the doom system on Linux, Unix and Windows
@ -27,6 +30,7 @@
* Added a "renderDuringTransitions" property to the image element
* Added support for more extreme vertical resolutions than previously allowed
* Added support for the 19.5:9, 20:9 and 1:1 display aspect ratios
* The SDL error message is now printed to the log if a controller could not be added
* Added workarounds for some mobile GPUs which do not support all OpenGL operations when using the BGRA pixel format
### Bug fixes

2
INSTALL-DEV.md
View file

@ -1010,6 +1010,8 @@ The input configuration is described in the [User guide](USERGUIDE-DEV.md#input-
## Command line options
_There are no command line options available on Android as this operating system works completely differently than all other supported platforms._
You can use **--help** or **-h** to view the list of command line options, as shown here.
```

13
USERGUIDE-DEV.md
View file

@ -688,6 +688,7 @@ The following emulators are supported in AppImage format when using the bundled
| ps2 | PCSX2 | pcsx2*.AppImage |
| ps2 | Play! | Play!*.AppImage |
| ps3 | RPCS3 | rpcs3*.AppImage |
| psvita | Vita3K | Vita3K*.AppImage |
| psx | DuckStation | DuckStation*.AppImage |
| snes | Snes9x | Snes9x*.AppImage |
| switch | Yuzu | yuzu*.AppImage |
@ -3121,6 +3122,10 @@ Themes optionally support variants which are a type of theme profiles defined by
If the theme author has included multiple color schemes, then these can be selected between using this menu option.
**Theme font size**
If the theme author has included support for multiple font/text sizes, then these can be selected between using this menu option. Possible choices are _medium, large, small, extra large_ and _extra small_. What layout changes these font size options actually make is completely up to the theme author.
**Theme aspect ratio**
Themes could optionally be optimized for different screen aspect ratios. ES-DE supports 16:9, 16:10, 3:2, 4:3, 5:4, 21:9 and 32:9 in both horizontal and vertical orientation, but it's completely up to the theme author which of these are actually supported by the theme. It's normally best to leave this setting at _Automatic_ in which case ES-DE will automatically select the aspect ratio that most closely matches the screen resolution. The _Automatic_ option is however only available if the theme supports at least two aspect ratios.
@ -3468,7 +3473,7 @@ For platforms and package formats where the previous setting above is available
With this setting enabled, the taskbar will be hidden when launching ES-DE, and it will be restored when the application exits. This can make for a more seamless experience as the taskbar could otherwise flash by briefly when launching and returning from games.
**Run in background (while game is launched)**
**Run in background (while game is launched)** _(All operating systems except Android)_
Enabling this option makes ES-DE continue to run while a game is launched. This is normally not recommended as it leads to a slightly strange application behavior and it also removes the ability to capture return codes and log output from the emulators. Generally this option should only be enabled if there are issues with launching games while suspending ES-DE. Note however that some systems like Valve Steam will always keep ES-DE running in the background because they require it for technical reasons (i.e. those systems will override this menu option).
@ -3516,7 +3521,7 @@ Displays the framerate and VRAM statistics as an overlay. This can be useful to
Enabling or disabling the menu when the UI mode is set to _Kid_. Mostly intended for testing purposes as it's not recommended to enable the menu in this restricted mode.
**Show quit menu (reboot and power off entries)** _(All operating systems except macOS)_
**Show quit menu (reboot and power off entries)** _(All operating systems except macOS and Android)_
With this setting enabled, there is a Quit menu shown as the last entry on the main menu which provides options to quit ES-DE, to reboot the computer or to power off the computer. With this setting disabled, there will simply be an entry to quit the application instead of the complete quit menu.
@ -3546,11 +3551,11 @@ If the menu is enabled, these are its entries:
If the option _When to save game metadata_ has been set to _On exit_, the gamelist.xml files will be updated at this point. This applies also if the Quit menu is disabled and replaced by the _Quit ES-DE_ entry.
**Reboot system** _(All operating systems except macOS)_
**Reboot system** _(All operating systems except macOS and Android)_
Self explanatory.
**Power off system** _(All operating systems except macOS)_
**Power off system** _(All operating systems except macOS and Android)_
Self explanatory.