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-08 20:14:31 +02:00
parent c164f3bfdc
commit d3b4f2f252
2 changed files with 23 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -34,10 +34,14 @@
* Improved menu system font rendering on GPUs without proper texture filtering support * Improved menu system font rendering on GPUs without proper texture filtering support
* Added a "stationary" property to all secondary elements to set them as stationary during slide transitions * Added a "stationary" property to all secondary elements to set them as stationary during slide transitions
* Added a "containerType" property to the text element to select between vertical and horizontal containers * Added a "containerType" property to the text element to select between vertical and horizontal containers
* Added new "textHorizontalScrolling", "textHorizontalScrollSpeed" and "textHorizontalScrollDelay" textlist properties
* Added theme support for the "manual" metadata type for the text element * Added theme support for the "manual" metadata type for the text element
* Changed the application updater to not use the scraper's transfer and connection timeout settings * Changed the application updater to not use the scraper's transfer and connection timeout settings
* Added support to MathUtil::md5Hash() for streaming files in chunks * Added support to MathUtil::md5Hash() for streaming files in chunks
* Replaced a number of homecooked functions in FileSystemUtil with those from the C++ standard library * Replaced a number of homecooked functions in FileSystemUtil with those from the C++ standard library
* Added horizontal text scrolling functionality to TextComponent
* Removed all horizontal text scrolling code from ComponentList and TextListComponent
* Refactored TextListComponent to work more like the other primary components
* Added a lot more debug log output to the scraper * Added a lot more debug log output to the scraper
* (Windows) Added a warning dialog on startup if an unsafe upgrade of the portable release has been made * (Windows) Added a warning dialog on startup if an unsafe upgrade of the portable release has been made
* (Windows) Improved the README.txt file for the portable release * (Windows) Improved the README.txt file for the portable release

25
THEMES-DEV.md
View file

@ -1769,6 +1769,19 @@ Properties:
* `selectedSecondaryBackgroundColor` - type: COLOR * `selectedSecondaryBackgroundColor` - type: COLOR
- Background color of the highlighted entry for the secondary entry type. This follows the sizing of the selector bar and is expanded downwards so you'll probably want to adjust its position using `selectorVerticalOffset` if you have defined a custom selector height using `selectorHeight` - Background color of the highlighted entry for the secondary entry type. This follows the sizing of the selector bar and is expanded downwards so you'll probably want to adjust its position using `selectorVerticalOffset` if you have defined a custom selector height using `selectorHeight`
- Default is the same value as `selectedBackgroundColor` - Default is the same value as `selectedBackgroundColor`
* `textHorizontalScrolling` - type: BOOLEAN
- If this property is enabled then text that does not fit within the element width (minus margins) will scroll horizontally. If the property is disabled, the text will instead be truncated with an ellipsis (...) if it exceeds the width.
- Default is `true`
* `textHorizontalScrollSpeed` - type: FLOAT
- A relative speed for how fast to scroll the text.
- Minimum value is `0.1` and maximum value is `10`
- Default is `1`
- This property can only be used when `textHorizontalScrolling` has been set to `true`
* `textHorizontalScrollDelay` - type: FLOAT
- Delay in seconds before scrolling starts.
- Minimum value is `0` and maximum value is `10`
- Default is `3`
- This property can only be used when `textHorizontalScrolling` has been set to `true`
* `fontPath` - type: PATH * `fontPath` - type: PATH
* `fontSize` - type: FLOAT * `fontSize` - type: FLOAT
- Size of the font as a percentage of screen height for horizontally oriented screens or screen width for vertically oriented screens (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). This calculation is based on the reference 'S' character so other glyphs may not fill this area, or they may exceed this area. - Size of the font as a percentage of screen height for horizontally oriented screens or screen width for vertically oriented screens (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). This calculation is based on the reference 'S' character so other glyphs may not fill this area, or they may exceed this area.
@ -2341,7 +2354,7 @@ Properties:
- Possible combinations: - Possible combinations:
- `0 0` - automatically size so text fits on one line (expanding horizontally). - `0 0` - automatically size so text fits on one line (expanding horizontally).
- `w 0` - automatically wrap text so it doesn't go beyond `w` (expanding vertically). - `w 0` - automatically wrap text so it doesn't go beyond `w` (expanding vertically).
- `w h` - works like a "text box". If `h` is non-zero and `h` <= `fontSize` (implying it should be a single line of text), text that goes beyond `w` will be truncated with an elipses (...). - `w h` - works like a "text box". If `h` is non-zero and `h` <= `fontSize` (implying it should be a single line of text), text that goes beyond `w` will be truncated with an ellipsis (...)
* `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`
@ -2424,17 +2437,17 @@ Properties:
- If `container` has been set, then it's possible to select between a vertically or horizontally scrolling type using this property. If choosing the horizontal container then all line breaks in the text will be automatically converted to spaces. - If `container` has been set, then it's possible to select between a vertically or horizontally scrolling type using this property. If choosing the horizontal container then all line breaks in the text will be automatically converted to spaces.
- Valid values are `vertical` or `horizontal` - Valid values are `vertical` or `horizontal`
- Default is `vertical` - Default is `vertical`
- This property can only be used when `container` is `true` - This property can only be used when `container` has been explicitly set to `true`
* `containerVerticalSnap` - type: BOOLEAN * `containerVerticalSnap` - type: BOOLEAN
- Whether the text should be vertically snapped to the font height. With this property enabled the container will have its height reduced as needed so that only complete rows of text are displayed at the start and end positions. This will not affect the "real" size of the container as set by the `size` property which means that the overall element placement will still be predictable if a vertical origin other than zero is used. - Whether the text should be vertically snapped to the font height. With this property enabled the container will have its height reduced as needed so that only complete rows of text are displayed at the start and end positions. This will not affect the "real" size of the container as set by the `size` property which means that the overall element placement will still be predictable if a vertical origin other than zero is used.
- Default is `true` - Default is `true`
- This property can only be used when `containerType` is `vertical` - This property can only be used when `containerType` is `vertical`
* `containerScrollSpeed` - type: FLOAT * `containerScrollSpeed` - type: FLOAT
- A base speed is automatically calculated based on the container and font sizes, so this property applies relative to the auto-calculated value. - For vertical containers a base speed is automatically calculated based on the container and font sizes, so this property applies relative to the auto-calculated value for that type.
- Minimum value is `0.1` and maximum value is `10` - Minimum value is `0.1` and maximum value is `10`
- Default is `1` - Default is `1`
* `containerStartDelay` - type: FLOAT * `containerStartDelay` - type: FLOAT
- Delay in seconds before scrolling starts. Note that the text fade-in animation that plays when resetting from the end position will cause a slight delay even if this property is set to zero. - Delay in seconds before scrolling starts. Note that for vertical containers the text fade-in animation that plays when resetting from the end position will cause a slight delay even if this property is set to zero.
- Minimum value is `0` and maximum value is `10` - Minimum value is `0` and maximum value is `10`
- Default is `4.5` for vertical containers and `1.5` for horizontal containers - Default is `4.5` for vertical containers and `1.5` for horizontal containers
* `containerResetDelay` - type: FLOAT * `containerResetDelay` - type: FLOAT
@ -2496,7 +2509,7 @@ Properties:
- Possible combinations: - Possible combinations:
- `0 0` - automatically size so text fits on one line (expanding horizontally). - `0 0` - automatically size so text fits on one line (expanding horizontally).
- `w 0` - automatically wrap text so it doesn't go beyond `w` (expanding vertically). - `w 0` - automatically wrap text so it doesn't go beyond `w` (expanding vertically).
- `w h` - works like a "text box". If `h` is non-zero and `h` <= `fontSize` (implying it should be a single line of text), text that goes beyond `w` will be truncated with an elipses (...). - `w h` - works like a "text box". If `h` is non-zero and `h` <= `fontSize` (implying it should be a single line of text), text that goes beyond `w` will be truncated with an ellipsis (...)
* `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`
@ -2590,7 +2603,7 @@ Properties:
- Possible combinations: - Possible combinations:
- `0 0` - automatically size so text fits on one line (expanding horizontally). - `0 0` - automatically size so text fits on one line (expanding horizontally).
- `w 0` - automatically wrap text so it doesn't go beyond `w` (expanding vertically). - `w 0` - automatically wrap text so it doesn't go beyond `w` (expanding vertically).
- `w h` - works like a "text box". If `h` is non-zero and `h` <= `fontSize` (implying it should be a single line of text), text that goes beyond `w` will be truncated with an elipses (...). - `w h` - works like a "text box". If `h` is non-zero and `h` <= `fontSize` (implying it should be a single line of text), text that goes beyond `w` will be truncated with an ellipsis (...)
* `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`