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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-02-09 22:17:31 +01:00
parent 0bd31eca9f
commit 0f3fddc7dc
4 changed files with 21 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CHANGELOG.md
View file

@ -18,6 +18,7 @@
* Added support for defining what type of image metadata to use for all image elements (and also for the video component static image) * Added support for defining what type of image metadata to use for all image elements (and also for the video component static image)
* Added a legacy (backward compatibility) mode for still supporting older RetroPie EmulationStation themes * Added a legacy (backward compatibility) mode for still supporting older RetroPie EmulationStation themes
* Added theme support for Lottie animations (vector graphics) * Added theme support for Lottie animations (vector graphics)
* Replaced the forceUppercase theme property with a more versatile letterCase property (forceUppercase is retained for legacy theme compatibility)
* Made it possible to set any text element as a scrollable container using either metadata values or literal strings * Made it possible to set any text element as a scrollable container using either metadata values or literal strings
* Made it possible to use almost all game metadata field when theming text elements * Made it possible to use almost all game metadata field when theming text elements
* Added scraper support for displaying the returned platform if it does not match the game platform, or if multiple platforms are defined for the system * Added scraper support for displaying the returned platform if it does not match the game platform, or if multiple platforms are defined for the system
@ -28,11 +29,12 @@
* Added the ability to set a manual sortname specifically for custom collections using the metadata editor * Added the ability to set a manual sortname specifically for custom collections using the metadata editor
* When scraping in semi-automatic mode, horizontal scrolling of long game names are no longer reset when automatically selecting the result * When scraping in semi-automatic mode, horizontal scrolling of long game names are no longer reset when automatically selecting the result
* Reduced CPU usage significantly when a menu is open by not rendering the bottom of the stack * Reduced CPU usage significantly when a menu is open by not rendering the bottom of the stack
* Reduced CPU usage by only rendering the currently visible system in SystemView * Reduced CPU usage significantly by only rendering the necessary systems in SystemView
* Added an OpenGL ES 2.0 renderer (borrowed from the RetroPie fork of EmulationStation) * Added an OpenGL ES 2.0 renderer (borrowed from the RetroPie fork of EmulationStation)
* Added logging of the display refresh rate on startup * Added logging of the display refresh rate on startup
* Improved the theme loading error logging to make it consistent and easier to understand * Improved the theme loading error logging to make it consistent and easier to understand
* Added a log warning for unthemed systems during theme set loading * Added a log warning for unthemed systems during theme set loading
* Changed the warning log level for missing theme files to debug level if the paths are set using variables
* Added a color model conversion shader for converting from BGRA to RGBA * Added a color model conversion shader for converting from BGRA to RGBA
* Added renderer support for supplying a separate format than internalFormat when creating textures (although not really supported by the OpenGL standard) * Added renderer support for supplying a separate format than internalFormat when creating textures (although not really supported by the OpenGL standard)
* Added the rlottie library as a Git subtree * Added the rlottie library as a Git subtree
@ -63,6 +65,7 @@
* Changing some values using the metadata editor could lead to an incorrect sort order if the changes were done from within a grouped custom collection * Changing some values using the metadata editor could lead to an incorrect sort order if the changes were done from within a grouped custom collection
* Changing the setting "Group unthemed custom collections" could lead to incorrect custom collections sorting under some circumstances * Changing the setting "Group unthemed custom collections" could lead to incorrect custom collections sorting under some circumstances
* When multi-scraping in semi-automatic mode and a long game name was scrolling, the start position was not reset when scraping the next game * When multi-scraping in semi-automatic mode and a long game name was scrolling, the start position was not reset when scraping the next game
* The VideoComponent static images were not fading out smoothly on gamelist fast-scrolling (only fixed for non-legacy themes)
* Clearing a game in the metadata editor would sometimes not remove all media files (if there were both a .jpg and a .png for a certain file type) * Clearing a game in the metadata editor would sometimes not remove all media files (if there were both a .jpg and a .png for a certain file type)
* The ScummVM platform entry was missing for TheGamesDB which resulted in very inaccurate scraper searches * The ScummVM platform entry was missing for TheGamesDB which resulted in very inaccurate scraper searches
* During multi-scraping the busy indicator was not displayed after a result was acquired but before the thumbnail was completely downloaded * During multi-scraping the busy indicator was not displayed after a result was acquired but before the thumbnail was completely downloaded

31
THEMES-DEV.md
View file

@ -78,7 +78,9 @@ The following are the most important changes compared to the legacy theme struct
* The concept of _features_ is gone * The concept of _features_ is gone
* The `<formatVersion>` tag is gone as tracking theme versions doesn't make much sense after all * The `<formatVersion>` tag is gone as tracking theme versions doesn't make much sense after all
* The `video` element properties `showSnapshotNoVideo` and `showSnapshotDelay` have been removed * The `video` element properties `showSnapshotNoVideo` and `showSnapshotDelay` have been removed
* The `forceUppercase` property has been replaced with the more versatile `letterCase` property
* Correct theme structure is enforced more strictly than before, and deviations will generate error log messages and make the theme loading fail * Correct theme structure is enforced more strictly than before, and deviations will generate error log messages and make the theme loading fail
* Many additional elements and properties have been added, refer to the [Reference](THEMES-DEV.md#reference) section for more information
Attempting to use any of the legacy logic in the new theme structure will make the theme loading fail, for example adding the _extra="true"_ attribute to any element. Attempting to use any of the legacy logic in the new theme structure will make the theme loading fail, for example adding the _extra="true"_ attribute to any element.
@ -977,8 +979,9 @@ It's strongly recommended to use the same image dimensions for all badges as var
- Valid values are `left`, `center`, or `right`. Controls alignment on the X axis and `center` will also align vertically. - Valid values are `left`, `center`, or `right`. Controls alignment on the X axis and `center` will also align vertically.
* `color` - type: COLOR * `color` - type: COLOR
* `backgroundColor` - type: COLOR * `backgroundColor` - type: COLOR
* `forceUppercase` - type: BOOLEAN * `letterCase` - type: STRING
- Draw text in uppercase. - Valid values are `none`, `uppercase`, `lowercase` or `capitalize`
- Default is `none` (original letter case is retained)
* `lineSpacing` - type: FLOAT * `lineSpacing` - type: FLOAT
- Controls the space between lines (as a multiple of font height). - Controls the space between lines (as a multiple of font height).
- Default is `1.5` - Default is `1.5`
@ -1018,8 +1021,9 @@ It's strongly recommended to use the same image dimensions for all badges as var
- Valid values are `left`, `center`, or `right`. Controls alignment on the X axis and `center` will also align vertically. - Valid values are `left`, `center`, or `right`. Controls alignment on the X axis and `center` will also align vertically.
* `color` - type: COLOR * `color` - type: COLOR
* `backgroundColor` - type: COLOR * `backgroundColor` - type: COLOR
* `forceUppercase` - type: BOOLEAN * `letterCase` - type: STRING
- Draw text in uppercase. - Valid values are `none`, `uppercase`, `lowercase` or `capitalize`
- Default is `none` (original letter case is retained)
* `lineSpacing` - type: FLOAT * `lineSpacing` - type: FLOAT
- Controls the space between lines (as a multiple of font height). - Controls the space between lines (as a multiple of font height).
- Default is `1.5` - Default is `1.5`
@ -1100,7 +1104,7 @@ Displays the game count (all games as well as favorites), any applied filters, a
#### carousel #### carousel
* `type` - type: STRING * `type` - type: STRING
- Sets the scoll direction of the carousel. - Sets the carousel type and scroll direction.
- Valid values are `horizontal`, `vertical`, `horizontal_wheel` or `vertical_wheel`. - Valid values are `horizontal`, `vertical`, `horizontal_wheel` or `vertical_wheel`.
- Default is `horizontal` - Default is `horizontal`
* `size` - type: NORMALIZED_PAIR * `size` - type: NORMALIZED_PAIR
@ -1154,10 +1158,9 @@ Displays the game count (all games as well as favorites), any applied filters, a
- Default is `000000FF` - Default is `000000FF`
* `textBackgroundColor` - type: COLOR * `textBackgroundColor` - type: COLOR
- Default is `FFFFFF00` - Default is `FFFFFF00`
* `textStyle` - type: STRING * `letterCase` - type: STRING
- The style of the text. - Valid values are `none`, `uppercase`, `lowercase` or `capitalize`
- Valid values are `original`, `uppercase`, `lowercase` or `camelcase` - Default is `none` (original letter case is retained)
- Default is `original` (original formatting is retained)
* `fontPath` - type: PATH * `fontPath` - type: PATH
- Path to a TrueType font (.ttf) used as fallback if there is no `logo` image defined or found, and if `defaultLogo` has not been defined. - Path to a TrueType font (.ttf) used as fallback if there is no `logo` image defined or found, and if `defaultLogo` has not been defined.
* `fontSize` - type: FLOAT * `fontSize` - type: FLOAT
@ -1201,8 +1204,9 @@ This is a list containing rows of text which can be navigated using the keyboard
- Valid values are `left`, `center`, or `right`. Controls alignment on the X axis. - Valid values are `left`, `center`, or `right`. Controls alignment on the X axis.
* `horizontalMargin` - type: FLOAT * `horizontalMargin` - type: FLOAT
- Horizontal offset for text from the alignment point. If `alignment` is "left", offsets the text to the right. If `alignment` is "right", offsets text to the left. No effect if `alignment` is "center". Given as a percentage of the element's parent's width (same unit as `size`'s X value). - Horizontal offset for text from the alignment point. If `alignment` is "left", offsets the text to the right. If `alignment` is "right", offsets text to the left. No effect if `alignment` is "center". Given as a percentage of the element's parent's width (same unit as `size`'s X value).
* `forceUppercase` - type: BOOLEAN * `letterCase` - type: STRING
- Draw text in uppercase. - Valid values are `none`, `uppercase`, `lowercase` or `capitalize`
- Default is `none` (original letter case is retained)
* `lineSpacing` - type: FLOAT * `lineSpacing` - type: FLOAT
- Controls the space between lines (as a multiple of font height). - Controls the space between lines (as a multiple of font height).
- Default is `1.5` - Default is `1.5`
@ -1237,9 +1241,8 @@ The help system is a special element that displays a context-sensitive list of a
* `iconTextSpacing` - type: FLOAT * `iconTextSpacing` - type: FLOAT
- Spacing in pixels within a help system element between its icon and text. - Spacing in pixels within a help system element between its icon and text.
- Default is `8.0` - Default is `8.0`
* `textStyle` - type: STRING * `letterCase` - type: STRING
- The style of the text. - Valid values are `uppercase`, `lowercase` or `capitalize`
- Valid values are `uppercase`, `lowercase` or `camelcase`
- Default is `uppercase` - Default is `uppercase`
* `customButtonIcon` - type: PATH * `customButtonIcon` - type: PATH
- A button icon override. Specify the button type in the attribute `button`. - A button icon override. Specify the button type in the attribute `button`.

2
THEMES-LEGACY.md
View file

@ -900,8 +900,6 @@ ES-DE borrows the concept of "nine patches" from Android (or "9-Slices"). Curren
- Spacing in pixels between the help system components. - Spacing in pixels between the help system components.
* `iconTextSpacing` - type: FLOAT. Default is 8.0. * `iconTextSpacing` - type: FLOAT. Default is 8.0.
- Spacing in pixels within a help system component between it's icon and text. - Spacing in pixels within a help system component between it's icon and text.
* `textStyle` - type: STRING. Default is `uppercase`.
- The style of the text. Options: `uppercase`, `lowercase`, `camelcase`.
* `customButtonIcon` - type: PATH. * `customButtonIcon` - type: PATH.
- A button icon override. Specify the button type in the attribute `button`. The available buttons are: - A button icon override. Specify the button type in the attribute `button`. The available buttons are:
`dpad_updown`, `dpad_updown`,

2
THEMES.md
View file

@ -872,8 +872,6 @@ ES-DE borrows the concept of "nine patches" from Android (or "9-Slices"). Curren
- Spacing in pixels between the help system components. - Spacing in pixels between the help system components.
* `iconTextSpacing` - type: FLOAT. Default is 8.0. * `iconTextSpacing` - type: FLOAT. Default is 8.0.
- Spacing in pixels within a help system component between it's icon and text. - Spacing in pixels within a help system component between it's icon and text.
* `textStyle` - type: STRING. Default is `uppercase`.
- The style of the text. Options: `uppercase`, `lowercase`, `camelcase`.
* `customButtonIcon` - type: PATH. * `customButtonIcon` - type: PATH.
- A button icon override. Specify the button type in the attribute `button`. The available buttons are: - A button icon override. Specify the button type in the attribute `button`. The available buttons are:
`dpad_updown`, `dpad_updown`,