From 0845bcf840bb7c5e109144fabbb853d5f4208f29 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Sat, 4 Mar 2023 22:48:45 +0100 Subject: [PATCH] Documentation update. --- CHANGELOG.md | 2 ++ THEMES-DEV.md | 10 ++++++++-- USERGUIDE-DEV.md | 2 +- 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 51871e78c..b9de56e3b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -63,6 +63,7 @@ Overall application speed and performance has been greatly improved with faster * Added ares standalone as an alternative emulator for many systems * Added MAME standalone as the default emulator for the macintosh system (Mac SE and Mac Plus diskette images) * Added MAME standalone as the default emulator for the gameandwatch system +* Added PrBoom+ standalone as an alternative emulator for the doom system * Added openMSX standalone as an alternative emulator for the colecovision, msx, msx1, msx2 and msxturbor systems * Added SameBoy standalone as an alternative emulator for the gb and gbc systems * Added Gearboy standalone as an alternative emulator for the gb and gbc systems on Unix and Windows @@ -339,6 +340,7 @@ Overall application speed and performance has been greatly improved with faster * Navigation sounds for the trigger buttons would play when repeatedly pressed at the start or end of textlists * Slide and fade transitions would sometimes stop working after changing theme sets * Using fade transitions, when holding a direction button to scroll the system view carousel, the key repeat would cause an unwanted background rendering +* Textlist entries would sometimes scroll horizontally even though they fit inside the element width * Custom collections editing mode did not end when switching UI modes * Editing a folder using the metadata editor added any new values to the filter index, even though it shouldn't be possible to filter folders directly * There were multiple issues with filtering games inside folders (too many games filtered, inconsistent behavior etc.) diff --git a/THEMES-DEV.md b/THEMES-DEV.md index 307065568..0fe52cced 100644 --- a/THEMES-DEV.md +++ b/THEMES-DEV.md @@ -1356,7 +1356,7 @@ Properties: - Minimum value is `0.1` and maximum value is `1` - Default is `0.5` * `unfocusedItemSaturation` - type: FLOAT - - Sets the saturation for all items except the currently selected entry. + - Sets the saturation for all items except the currently selected entry. This property takes precedence over `imageSaturation` if that has also been defined. - Minimum value is `0` (grayscale) and maximum value is `1` (original file saturation). - Default is `1` * `unfocusedItemDimming` - type: FLOAT @@ -1501,7 +1501,7 @@ Properties: - Minimum value is `0.1` and maximum value is `1` - Default is `1` * `unfocusedItemSaturation` - type: FLOAT - - Sets the saturation for all items except the currently selected entry. + - Sets the saturation for all items except the currently selected entry. This property takes precedence over `imageSaturation` if that has also been defined. - Minimum value is `0` (grayscale) and maximum value is `1` (original file saturation). - Default is `1` * `unfocusedItemDimming` - type: FLOAT @@ -1989,6 +1989,8 @@ Properties: GIF and Lottie (vector graphics) animations. The animation type is automatically selected based on the file extension with `.gif` for GIF animations and `.json` for Lottie animations. Note that Lottie animations take a lot of memory and CPU resources if scaled up to large sizes so it's adviced to not add too many of these to the same view and to not make them too large. GIF animations on the other hand are not as demanding except if they're really long and/or of high resolution. +Also be aware that the [rlottie](https://github.com/Samsung/rlottie) library used by ES-DE is not compatible with all Lottie animations out there so you may need to convert them to a format that rlottie can read, or use some other animations altogether. + Supported views: * `system ` * `gamelist` @@ -2028,6 +2030,10 @@ Properties: - The direction that the animation should be played. - Valid values are `normal` (forwards), `reverse` (backwards), `alternate` (bouncing forwards/backwards) and `alternateReverse` (bouncing backwards/forwards, i.e. starting with playing backwards). - Default is `normal` +* `iterationCount` - type: UNSIGNED_INTEGER + - Number of times to play the animation until next time it's reset. Animation resets are triggered by various events like navigating between systems and gamelists, reloading a gamelist etc. + - Minimum value is `0` and maximum value is `10` + - Default is `0` (infinite amount of times) * `interpolation` - type: STRING - Interpolation method to use when scaling. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. - Valid values are `nearest` or `linear` diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index a7c20363e..b12cc1e7c 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -3090,7 +3090,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | crvision | VTech CreatiVision | MAME **(Standalone)** | | Yes | Single archive or ROM file | | daphne | Daphne Arcade LaserDisc Emulator | Hypseus [Daphne] **(Standalone)** [UW] | Hypseus [Singe] **(Standalone)** [UW] | Yes for Daphne games | See the specific _Hypseus Singe (Daphne)_ section elsewhere in this guide | | desktop | Desktop Applications | _Suspend ES-DE_ | _Keep ES-DE running_ | | See the specific _Ports and desktop applications_ section elsewhere in this guide | -| doom | Doom | PrBoom | Boom 3 [UW],
Boom 3 xp [UW],
_Shortcut or script_ | No | | +| doom | Doom | PrBoom | PrBoom+ **(Standalone)**,
Boom 3 [UW],
Boom 3 xp [UW],
_Shortcut or script_ | No | | | dos | DOS (PC) | DOSBox-Pure | DOSBox-Core,
DOSBox-SVN,
DOSBox-X **(Standalone)**,
DOSBox Staging **(Standalone)** | No | See the specific _DOS / PC_ section elsewhere in this guide | | dragon32 | Dragon Data Dragon 32 | XRoar Dragon 32 **(Standalone)** | XRoar Dragon 64 **(Standalone)** | Yes | See the specific _Dragon 32 and Tano Dragon_ section elsewhere in this guide | | dreamcast | Sega Dreamcast | Flycast | Flycast **(Standalone)**,
Redream **(Standalone)** | No | In separate folder interpreted as a file, with .m3u playlist if multi-disc game |