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 2023-08-13 15:20:55 +02:00
parent f2952ecc28
commit d8d7b5f3d2
2 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -36,6 +36,8 @@
* Added a "containerType" property to the text element to select between vertical and horizontal containers
* Added a number of carousel, grid, textlist and text properties to control horizontally scrolling text
* Added a "textRelativeScale" property to the carousel to size text smaller than the overall item size
* Added "iterationCount" and "onIterationsDone" properties to the video element
* Changed the "path" property for the video element to consider the set value even if it points to a non-existing file
* Added theme support for the "manual" metadata type for the text element
* Added the device serial number to the es_log.txt entries when adding or removing controllers
* Changed the application updater to not use the scraper's transfer and connection timeout settings
@ -62,6 +64,8 @@
### Bug fixes
* The video player would not play the last couple of frames for any videos
* Starting the media viewer did not pause fallback game videos (defined using the "default" video property)
* Directories interpreted as files entries could not be removed from custom collections
* Duplicate ScreenScraper game entries could show up in the interactive scraper if multiple platforms were defined for the system
* ScreenScraper API calls were slightly malformed for systems where multiple platforms were defined

14
THEMES-DEV.md
View file

@ -2044,7 +2044,7 @@ Properties:
- `never` - Don't set element as stationary during any transitions.
- Default is `never`
* `path` - type: PATH
- Path to a video file. Setting a value for this property will make the video static, i.e. any `imageType`, `gameselector` and `default` properties will be ignored.
- Path to a video file. Setting a value for this property will make the video static, i.e. any `imageType`, `gameselector` and `default` properties will be ignored. This is true even if the property does not point to an existing video file. As well, when defining this for the gamelist view the video will not immediately restart when navigating between games.
* `default` - type: PATH
- Path to a default video file. The default video will be played when the selected game does not have a video. This property is also applied to any custom collection that does not contain any games when browsing the grouped custom collections system. Takes precedence over `defaultImage`.
* `defaultImage` - type: PATH
@ -2071,6 +2071,16 @@ Properties:
- This optional property which is only available in the `system` view makes it possible to select which `gameselector` entry to use to populate the `imageType` property and to use for playing the video stream. This assumes that a `gameCount` property for the gameselector element has been defined with a value higher than `1`. By defining multiple `video` elements with different values for the `gameselectorEntry` property it's possible to display multiple game entries at the same time, for example listing a couple of games that were last played, or a selection of random games. If the requested entry does not exist (for instance if `gameCount` has been set to 5 and `gameselectorEntry` has been set to `4` but the system only contains 3 games), then the overall element will not get rendered. Note that the first entry is defined as `0`, the second entry as `1` etc.
- Minimum value is `0` and maximum value is the value of the `gameselector` element property `gameCount` minus 1. If a value outside this range is defined, then it will be automatically clamped to a valid value.
- Default is `0`
* `iterationCount` - type: UNSIGNED_INTEGER
- Number of times to play the video until next time it's reset. Video resets are triggered by various events like navigation between systems and gamelists, reloading of gamelists, opening of menus etc.
- Minimum value is `0` and maximum value is `10`
- Default is `0` (infinite amount of times)
* `onIterationsDone` - type: STRING
- What to do after playing the video the number of times defined by `iterationCount`
- `nothing` - Render nothing.
- `image` - Render the image defined by `imageType` or `defaultImage` which means this value can't be used if `path` has been set
- Default is `nothing`
- This property can only be used when `iterationCount` has a non-zero value.
* `audio` - type: BOOLEAN
- Whether to enable or disable audio playback for the video. For static videos in the gamelist view it's strongly recommended to set this to `false` if there is also a separate video element playing game videos.
- Default is `true`
@ -2181,7 +2191,7 @@ Properties:
- 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.
- Number of times to play the animation until next time it's reset. Animation resets are triggered by various events like navigation between systems and gamelists, reloading of gamelists, opening of menus etc.
- Minimum value is `0` and maximum value is `10`
- Default is `0` (infinite amount of times)
* `interpolation` - type: STRING