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 2022-09-10 22:34:36 +02:00
parent efec1b9ceb
commit 9d5e0a140a
3 changed files with 16 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CHANGELOG.md
View file

@ -49,6 +49,7 @@
* Removed the "Preload gamelists on startup" setting * Removed the "Preload gamelists on startup" setting
* Removed the "Play videos immediately (override theme)" setting * Removed the "Play videos immediately (override theme)" setting
* Renamed the sound menu option "Play audio for videos in the gamelist view" to "Play audio for gamelist and system view videos" * Renamed the sound menu option "Play audio for videos in the gamelist view" to "Play audio for gamelist and system view videos"
* The media viewer now always loads all images upfront to avoid audio stutter when browsing the files
* Added support for defining which types of game media to use for all image elements (and also for the video component static image) * Added support for defining which types of game media 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)
@ -105,6 +106,7 @@
* Added the rlottie library as a Git subtree * Added the rlottie library as a Git subtree
* Updated to build correctly with FFmpeg 5.0 * Updated to build correctly with FFmpeg 5.0
* Updated FFmpeg to 5.0 and SDL to 2.0.20 on Windows and macOS * Updated FFmpeg to 5.0 and SDL to 2.0.20 on Windows and macOS
* Added a workaround for playing broken video files with invalid PTS values
* Refactored the rendering code from a shared namespace into proper classes * Refactored the rendering code from a shared namespace into proper classes
* Removed the deprecated OpenGL ES 1.0 renderer * Removed the deprecated OpenGL ES 1.0 renderer
* On Windows all dependencies were moved in-tree to the "external" directory to greatly simplify the build environment * On Windows all dependencies were moved in-tree to the "external" directory to greatly simplify the build environment
@ -150,6 +152,7 @@
### Bug fixes ### Bug fixes
* Multiple levels of symlinking in the ROMs directory tree could crash the application on startup
* During some menu operations that reloaded the gamelist view, the cached background could miss some components as they were not rendered in time * During some menu operations that reloaded the gamelist view, the cached background could miss some components as they were not rendered in time
* 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
@ -160,6 +163,7 @@
* Horizontal and vertical gradients were mixed up (showing the opposite gradient type if set in a theme) * Horizontal and vertical gradients were mixed up (showing the opposite gradient type if set in a theme)
* The VideoComponent static images were not fading out smoothly on gamelist fast-scrolling * The VideoComponent static images were not fading out smoothly on gamelist fast-scrolling
* Rating icon outlines would not fade out correctly when fast-scrolling in a gamelist * Rating icon outlines would not fade out correctly when fast-scrolling in a gamelist
* The rating icons would not fit into the designated space in the scraper GUI when running at some vertically oriented screen resolutions
* If setting an origin other than 0.5 for a video with pillarboxes enabled, the video would not get centered on the black rectangle * If setting an origin other than 0.5 for a video with pillarboxes enabled, the video would not get centered on the black rectangle
* If a gamelist scroll fade-in animation was playing when opening a menu, it would continue to play after closing the menu * If a gamelist scroll fade-in animation was playing when opening a menu, it would continue to play after closing the menu
* When a legacy theme set had a video view style but did not have a valid md_video entry then the video player would still start (and play the audio) * When a legacy theme set had a video view style but did not have a valid md_video entry then the video player would still start (and play the audio)
@ -175,6 +179,7 @@
* The bottom menu selector bar was not getting rendered when running at really low resolutions like 320x240 * The bottom menu selector bar was not getting rendered when running at really low resolutions like 320x240
* Doing a manual reload using Ctrl+r in debug mode would sometimes not update modified image files * Doing a manual reload using Ctrl+r in debug mode would sometimes not update modified image files
* Abbreviations of long words in multiline text entries sometimes exceeded the designated text area * Abbreviations of long words in multiline text entries sometimes exceeded the designated text area
* Navigation sounds would sometimes not play when browsing game media in the media viewer
* The text debug overlay had the wrong size for scrollable containers * The text debug overlay had the wrong size for scrollable containers
* StringUtil::delimitedStringToVector could return empty elements * StringUtil::delimitedStringToVector could return empty elements
* (Windows) File paths would get escaped with quotation marks even if they did not contain any spaces * (Windows) File paths would get escaped with quotation marks even if they did not contain any spaces

7
CONTRIBUTING.md
View file

@ -67,7 +67,7 @@ The roadmap is under constant review so expect it to change from time to time. S
#### v2.0 (in progress) #### v2.0 (in progress)
* New theme engine with generalized views (only System and Gamelist) and theme variants support * New theme engine with generalized views (only System and Gamelist) and theme variants support
* Multiple new gamelist components (wheels, wall/grid etc.) * Multiple new gamelist components (more carousel modes, grid component etc.)
* Lottie animation (vector graphics) and GIF animation support * Lottie animation (vector graphics) and GIF animation support
* OpenGL ES 3.0 renderer for use on the Raspberry Pi * OpenGL ES 3.0 renderer for use on the Raspberry Pi
* Replace the OpenGL fixed function pipeline with a shader-based renderer * Replace the OpenGL fixed function pipeline with a shader-based renderer
@ -75,8 +75,8 @@ The roadmap is under constant review so expect it to change from time to time. S
#### v2.1 #### v2.1
* Animated menu elements like switches, tick boxes, smooth scrolling etc. * New texture/cache manager with improved memory management and support for GIF and Lottie animations
* New texture/cache manager with support for SVG images and Lottie animations * Reduced amount of gamelist reloading to retain cached textures and improve overall performance
* Add scraping of game manuals and maps and create a viewer for these (with PDF, GIF, JPG and PNG support) * Add scraping of game manuals and maps and create a viewer for these (with PDF, GIF, JPG and PNG support)
* Support for additional scraper services (if feasible?) * Support for additional scraper services (if feasible?)
* Web proxy support for the scraper * Web proxy support for the scraper
@ -85,6 +85,7 @@ The roadmap is under constant review so expect it to change from time to time. S
#### v2.2 #### v2.2
* Animated menu elements like switches and tick boxes
* Simple file browsing component * Simple file browsing component
* Scrollbar component for the gamelist view which can be used by the themes * Scrollbar component for the gamelist view which can be used by the themes
* Background music * Background music

65
THEMES-DEV.md
View file

@ -787,7 +787,7 @@ Properties:
* `origin` - type: NORMALIZED_PAIR * `origin` - type: NORMALIZED_PAIR
- Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the element exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied. - Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the element exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied.
- Minimum value per axis is `0` and maximum value per axis is `1` - Minimum value per axis is `0` and maximum value per axis is `1`
- Default is `0.5 0.5` - Default is `0 0`
* `rotation` - type: FLOAT * `rotation` - type: FLOAT
- Angle in degrees that the image should be rotated. Positive values will rotate clockwise, negative values will rotate counterclockwise. - Angle in degrees that the image should be rotated. Positive values will rotate clockwise, negative values will rotate counterclockwise.
- Default is `0` - Default is `0`
@ -881,7 +881,7 @@ Properties:
* `origin` - type: NORMALIZED_PAIR * `origin` - type: NORMALIZED_PAIR
- Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the element exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied. - Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the element exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied.
- Minimum value per axis is `0` and maximum value per axis is `1` - Minimum value per axis is `0` and maximum value per axis is `1`
- Default is `0.5 0.5` - Default is `0 0`
* `metadataElement` - type: BOOLEAN * `metadataElement` - type: BOOLEAN
- By default game metadata and media are faded out during gamelist fast-scrolling and text metadata fields, ratings and badges are hidden when enabling the _Hide metadata fields_ setting for a game entry. Using this property it's possible to explicitly define static video elements that should be treated as if they were game media files. This property is ignored if `path` is not set. - By default game metadata and media are faded out during gamelist fast-scrolling and text metadata fields, ratings and badges are hidden when enabling the _Hide metadata fields_ setting for a game entry. Using this property it's possible to explicitly define static video elements that should be treated as if they were game media files. This property is ignored if `path` is not set.
* `path` - type: PATH * `path` - type: PATH
@ -962,7 +962,7 @@ Properties:
* `origin` - type: NORMALIZED_PAIR * `origin` - type: NORMALIZED_PAIR
- Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the element exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied. - Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the element exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied.
- Minimum value per axis is `0` and maximum value per axis is `1` - Minimum value per axis is `0` and maximum value per axis is `1`
- Default is `0.5 0.5` - Default is `0 0`
* `rotation` - type: FLOAT * `rotation` - type: FLOAT
- Angle in degrees that the animation should be rotated. Positive values will rotate clockwise, negative values will rotate counterclockwise. - Angle in degrees that the animation should be rotated. Positive values will rotate clockwise, negative values will rotate counterclockwise.
- Default is `0` - Default is `0`
@ -1023,7 +1023,7 @@ Properties:
* `origin` - type: NORMALIZED_PAIR * `origin` - type: NORMALIZED_PAIR
- Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the element exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied. - Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the element exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied.
- Minimum value per axis is `0` and maximum value per axis is `1` - Minimum value per axis is `0` and maximum value per axis is `1`
- Default is `0.5 0.5` - Default is `0 0`
* `rotation` - type: FLOAT * `rotation` - type: FLOAT
- Angle in degrees that the badges should be rotated. Positive values will rotate clockwise, negative values will rotate counterclockwise. - Angle in degrees that the badges should be rotated. Positive values will rotate clockwise, negative values will rotate counterclockwise.
- Default is `0` - Default is `0`
@ -1443,7 +1443,7 @@ Properties:
* `pos` - type: NORMALIZED_PAIR * `pos` - type: NORMALIZED_PAIR
- Default is `0 0.38378` - Default is `0 0.38378`
* `origin` - type: NORMALIZED_PAIR * `origin` - type: NORMALIZED_PAIR
- Where on the carousel `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the carousel exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied. - Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the carousel exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied.
- Minimum value per axis is `0` and maximum value per axis is `1` - Minimum value per axis is `0` and maximum value per axis is `1`
- Default is `0 0` - Default is `0 0`
* `color` - type: COLOR * `color` - type: COLOR
@ -1569,8 +1569,9 @@ Properties:
* `size` - type: NORMALIZED_PAIR * `size` - type: NORMALIZED_PAIR
- Default is `1 0.8` - Default is `1 0.8`
* `origin` - type: NORMALIZED_PAIR * `origin` - type: NORMALIZED_PAIR
- Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the element exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied. - Where on the element `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the textlist exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied.
- Minimum value per axis is `0` and maximum value per axis is `1` - Minimum value per axis is `0` and maximum value per axis is `1`
- Default is `0 0`
* `selectorHeight` - type: FLOAT * `selectorHeight` - type: FLOAT
- Height of the "selector bar". - Height of the "selector bar".
* `selectorOffsetY` - type: FLOAT * `selectorOffsetY` - type: FLOAT
@ -1726,55 +1727,3 @@ Properties:
`button_start_XBOX`, `button_start_XBOX`,
`button_back_XBOX360`, `button_back_XBOX360`,
`button_start_XBOX360` `button_start_XBOX360`
#### imagegrid
Deprecated.
* `pos` - type: NORMALIZED_PAIR.
* `size` - type: NORMALIZED_PAIR.
- The size of the grid. Take care the selected tile can go out of the grid size, so don't position the grid too close to another element or the screen border.
* `margin` - type: NORMALIZED_PAIR. Margin between tiles.
* `padding` - type: NORMALIZED_RECT.
- NEW : Padding for displaying tiles.
* `autoLayout` - type: NORMALIZED_PAIR.
- NEW : Number of column and rows in the grid (integer values).
* `autoLayoutSelectedZoom` - type: FLOAT.
- NEW : Zoom factor to apply when a tile is selected.
* `gameImage` - type: PATH.
- The default image used for games which doesn't have an image.
* `folderImage` - type: PATH.
- The default image used for folders which doesn't have an image.
* `imageSource` - type: STRING.
- Selects the image to display. `thumbnail` by default, can also be set to `image`, `miximage`, `screenshot`, `cover`, `marquee` or `3dbox`. If selecting `image`, the media type `miximage` will be tried first, with fallback to `screenshot` and then `cover`.
* `scrollDirection` - type: STRING.
- `vertical` by default, can also be set to `horizontal`. Not that in `horizontal` mod, the tiles are ordered from top to bottom, then from left to right.
* `centerSelection` - type: BOOLEAN.
- `false` by default, when `true` the selected tile will be locked to the center of the grid.
* `scrollLoop` - type: BOOLEAN.
- `false` by default, when `true` the grid will seamlessly loop around when scrolling reaches the end of the list. Only works when `centerSelection` is `true`.
* `animate` - type : BOOLEAN.
- `true` by default, when `false` the grid scrolling will not be animated.
* `zIndex` - type: FLOAT.
- z-index value for element. Elements will be rendered in order of zIndex value from low to high.
#### gridtile
Deprecated.
* `size` - type: NORMALIZED_PAIR.
- The size of the default gridtile is used to calculate how many tiles can fit in the imagegrid. If not explicitly set, the size of the selected gridtile is equal the size of the default gridtile * 1.2
* `padding` - type: NORMALIZED_PAIR.
- The padding around the gridtile content. Default `16 16`. If not explicitly set, the selected tile padding will be equal to the default tile padding.
* `imageColor` - type: COLOR.
- The default tile image color and selected tile image color have no influence on each others.
* `backgroundImage` - type: PATH.
- If not explicitly set, the selected tile background image will be the same as the default tile background image.
* `backgroundCornerSize` - type: NORMALIZED_PAIR.
- The corner size of the ninepatch used for the tile background. Default is `16 16`.
* `backgroundColor` - type: COLOR.
- A shortcut to define both the center color and edge color at the same time. The default tile background color and selected tile background color have no influence on each others.
* `backgroundCenterColor` - type: COLOR.
- Sets the color of the center part of the ninepatch. The default tile background center color and selected tile background center color have no influence on each others.
* `backgroundEdgeColor` - type: COLOR.
- Sets the color of the edge parts of the ninepatch. The default tile background edge color and selected tile background edge color have no influence on each others.