From c50f1395883f5708355b93e9d670e523fb95252c Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Sun, 6 Aug 2023 23:54:15 +0200 Subject: [PATCH] Documentation update --- CHANGELOG.md | 9 +++++++++ THEMES-DEV.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 261fd4c65..3beb0a3cb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,7 @@ * Added a new Utilities menu to the main menu * Added an entry to the Utilities menu for rescanning the ROM directory * Added ares standalone as an alternative emulator for the gamegear, gb, gba, gbc and satellaview systems +* Removed atarijaguarcd as an extra platform for the atarijaguar system as it actually made scraping worse * (Linux) Added support for using the RetroArch AppImage release in portable mode (added corepath find rules) * (Linux) Added support for the AppImage release of Snes9x * Changed the "no games" dialog to no longer save the ROM directory to es_settings.xml if its value hasn't changed @@ -30,19 +31,27 @@ * 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 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 * Replaced a number of homecooked functions in FileSystemUtil with those from the C++ standard library +* 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) Improved the README.txt file for the portable release * (macOS) Changed the minimum required OS version from 10.14 "Mojave" to 10.15 "Catalina" * (macOS) Completely removed support for the legacy OS build +* Updated RapidJSON to commit a95e013b97ca6523f32da23f5095fcc9dd6067e5 +* Updated rlottie to commit f969abf62c8df773e3951a1176000e70fcde637f * Updated LunaSVG to 2.3.6 +* Updated CImg to 3.2.6 ### Bug fixes * 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 +* If multiple games had the same thumbnail in the interactive scraper, then this image would not get downloaded for all entries * (Windows) If the ROMDirectory setting had a value then all custom collection files contained absolute paths instead of relative paths * (Windows) Wide string conversions were not done correctly which caused issues when filenames contained 4-byte Unicode characters * (Windows) Attempting to capitalize multi-byte Unicode strings crashed the application if built using the MSVC compiler diff --git a/THEMES-DEV.md b/THEMES-DEV.md index 308683385..b73e5775d 100644 --- a/THEMES-DEV.md +++ b/THEMES-DEV.md @@ -1859,6 +1859,13 @@ Properties: - Point around which the image will be rotated. - Minimum value per axis is `0` and maximum value per axis is `1` - Default is `0.5 0.5` +* `stationary` - type: STRING + - If using slide transitions, then this property can be set to keep the element stationary during transition animations. This property has no effect when using instant or fade transitions. + - `withinView` - Set element as stationary when navigating within the same view, i.e. from system to system or from gamelist to gamelist. + - `betweenViews` - Set element as stationary when navigating between views, i.e. from system to gamelist or from gamelist to system. + - `always` - Set element as stationary during all transitions. + - `never` - Don't set element as stationary during any transitions. + - Default is `never` * `flipHorizontal` - type: BOOLEAN - Flips the image texture horizontally. - Default is `false` @@ -1970,6 +1977,13 @@ Properties: - 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` - Default is `0 0` +* `stationary` - type: STRING + - If using slide transitions, then this property can be set to keep the element stationary during transition animations. This property has no effect when using instant or fade transitions. + - `withinView` - Set element as stationary when navigating within the same view, i.e. from system to system or from gamelist to gamelist. + - `betweenViews` - Set element as stationary when navigating between views, i.e. from system to gamelist or from gamelist to system. + - `always` - Set element as stationary during all transitions. + - `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. * `default` - type: PATH @@ -2087,6 +2101,13 @@ Properties: - Point around which the animation will be rotated. - Minimum value per axis is `0` and maximum value per axis is `1` - Default is `0.5 0.5` +* `stationary` - type: STRING + - If using slide transitions, then this property can be set to keep the element stationary during transition animations. This property has no effect when using instant or fade transitions. + - `withinView` - Set element as stationary when navigating within the same view, i.e. from system to system or from gamelist to gamelist. + - `betweenViews` - Set element as stationary when navigating between views, i.e. from system to gamelist or from gamelist to system. + - `always` - Set element as stationary during all transitions. + - `never` - Don't set element as stationary during any transitions. + - Default is `never` * `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 animation elements that should be treated as if they were game media files. This is for example useful for hiding and fading out animations that are used as indicators for the various metadata types like genre, publisher, players etc. - Default is `false` @@ -2166,6 +2187,13 @@ Properties: - Point around which the image will be rotated. - Minimum value per axis is `0` and maximum value per axis is `1` - Default is `0.5 0.5`. +* `stationary` - type: STRING + - If using slide transitions, then this property can be set to keep the element stationary during transition animations. This property has no effect when using instant or fade transitions. + - `withinView` - Set element as stationary when navigating within the same view, i.e. from system to system or from gamelist to gamelist. + - `betweenViews` - Set element as stationary when navigating between views, i.e. from system to gamelist or from gamelist to system. + - `always` - Set element as stationary during all transitions. + - `never` - Don't set element as stationary during any transitions. + - Default is `never` * `horizontalAlignment` - type: STRING. - Valid values are `left`, `center` or `right` * `direction` - type: STRING @@ -2325,6 +2353,13 @@ Properties: - Point around which the text will be rotated. - Minimum value per axis is `0` and maximum value per axis is `1` - Default is `0.5 0.5` +* `stationary` - type: STRING + - If using slide transitions, then this property can be set to keep the element stationary during transition animations. This property has no effect when using instant or fade transitions. + - `withinView` - Set element as stationary when navigating within the same view, i.e. from system to system or from gamelist to gamelist. + - `betweenViews` - Set element as stationary when navigating between views, i.e. from system to gamelist or from gamelist to system. + - `always` - Set element as stationary during all transitions. + - `never` - Don't set element as stationary during any transitions. + - Default is `never` * `text` - type: STRING - A string literal to display. * `systemdata` - type: STRING @@ -2466,6 +2501,13 @@ Properties: - Point around which the text will be rotated. - Minimum value per axis is `0` and maximum value per axis is `1` - Default is `0.5 0.5`. +* `stationary` - type: STRING + - If using slide transitions, then this property can be set to keep the element stationary during transition animations. This property has no effect when using instant or fade transitions. + - `withinView` - Set element as stationary when navigating within the same view, i.e. from system to system or from gamelist to gamelist. + - `betweenViews` - Set element as stationary when navigating between views, i.e. from system to gamelist or from gamelist to system. + - `always` - Set element as stationary during all transitions. + - `never` - Don't set element as stationary during any transitions. + - Default is `never` * `metadata` - type: STRING - This displays the metadata values that are available for the game. If an invalid metadata field is defined, the text "unknown" or "never" will be printed. To use this property from the `system` view, you will first need to add a `gameselector` element. You can only define a single metadata value per datetime element. - Valid values: @@ -2553,6 +2595,13 @@ Properties: - Point around which the element will be rotated. - Minimum value per axis is `0` and maximum value per axis is `1` - Default is `0.5 0.5` +* `stationary` - type: STRING + - If using slide transitions, then this property can be set to keep the element stationary during transition animations. This property has no effect when using instant or fade transitions. + - `withinView` - Set element as stationary when navigating within the same view, i.e. from system to system or from gamelist to gamelist. + - `betweenViews` - Set element as stationary when navigating between views, i.e. from system to gamelist or from gamelist to system. + - `always` - Set element as stationary during all transitions. + - `never` - Don't set element as stationary during any transitions. + - Default is `never` * `fontPath` - type: PATH - Path to a TrueType font (.ttf). * `fontSize` - type: FLOAT @@ -2610,6 +2659,13 @@ Properties: - Point around which the rating will be rotated. - Minimum value per axis is `0` and maximum value per axis is `1` - Default is `0.5 0.5` +* `stationary` - type: STRING + - If using slide transitions, then this property can be set to keep the element stationary during transition animations. This property has no effect when using instant or fade transitions. + - `withinView` - Set element as stationary when navigating within the same view, i.e. from system to system or from gamelist to gamelist. + - `betweenViews` - Set element as stationary when navigating between views, i.e. from system to gamelist or from gamelist to system. + - `always` - Set element as stationary during all transitions. + - `never` - Don't set element as stationary during any transitions. + - Default is `never` * `gameselector` - type: STRING - If more than one gameselector element has been defined, this property makes it possible to state which one to use. If multiple gameselector elements have been defined and this property is missing then the first entry will be chosen and a warning message will be logged. If only a single gameselector has been defined, this property is ignored. The value of this property must match the `name` attribute value of the gameselector element. This property is only needed for the `system` view. * `gameselectorEntry` - type: UNSIGNED_INTEGER