From 8ea2ead679b871d20936300631e06b62d6e2d52b Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Mon, 7 Aug 2023 23:50:42 +0200 Subject: [PATCH] Documentation update --- CHANGELOG.md | 3 +++ THEMES-DEV.md | 9 ++++++++- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3beb0a3cb..035c392a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -27,11 +27,13 @@ * Removed Linux DEB package support from ApplicationUpdater as these packages are no longer provided * Changed ComponentList to fixed row heights which fixed many alignment issues * Improved the layout for the scraper and theme downloader to look more consistent across different display aspect ratios +* When an invalid media file is detected by the scraper, the media type is now included in the error message * Added a download percentage indicator to the application updater * Made the miximage offline generator GUI sizing more consistent across different display aspect ratios * Removed the es_log.txt entry when an es_systems.cfg legacy systems configuration file was found on startup * 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 "containerType" property to the text element to select between vertical and horizontal containers * 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 * Added support to MathUtil::md5Hash() for streaming files in chunks @@ -58,6 +60,7 @@ * The camera offset in ComponentList was not correctly calculated when reaching the bottom of a list * The textlist properties selectedBackgroundColor and selectedSecondaryBackgroundColor were not offset by selectorVerticalOffset * SDL_StartTextInput() was sometimes set when not actually inputting any text +* Some theme loading warning messages for the gamelistinfo element were not formatted correctly ## Version 2.1.1 diff --git a/THEMES-DEV.md b/THEMES-DEV.md index b73e5775d..70cf224d6 100644 --- a/THEMES-DEV.md +++ b/THEMES-DEV.md @@ -2420,9 +2420,15 @@ Properties: * `container` - type: BOOLEAN - Whether the text should be placed inside a scrollable container. - Default is `true` if `metadata` is set to `description`, otherwise `false` +* `containerType` - type: STRING + - 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` + - Default is `vertical` + - This property can only be used when `container` is `true` * `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. - Default is `true` + - This property can only be used when `containerType` is `vertical` * `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. - Minimum value is `0.1` and maximum value is `10` @@ -2430,11 +2436,12 @@ Properties: * `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. - Minimum value is `0` and maximum value is `10` - - Default is `4.5` + - Default is `4.5` for vertical containers and `1.5` for horizontal containers * `containerResetDelay` - type: FLOAT - Delay in seconds before resetting to the start position after reaching the scrolling end position. - Minimum value is `0` and maximum value is `20` - Default is `7` + - This property can only be used when `containerType` is `vertical` * `fontPath` - type: PATH - Path to a TrueType font (.ttf). * `fontSize` - type: FLOAT