From 4bbc7adb97849fa23136a6dfb84156cf80b235bd Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Thu, 15 Dec 2022 18:34:48 +0100 Subject: [PATCH] Documentation update. --- CHANGELOG.md | 2 ++ THEMES-DEV.md | 23 ++++++++++++++++++++++- USERGUIDE-DEV.md | 7 ------- 3 files changed, 24 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bd133cd51..6abd06f34 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -140,6 +140,7 @@ * Added scraping of fan art and updated the media viewer to display these images * Added scraping of box back covers when using TheGamesDB * If a wheel (marquee) image on ScreenScraper falls back to another region, then the wheel-hd image is now used instead if it matches the set region +* Removed scraping of arcade controller information using ScreenScraper as they have ruined this functionality * Added a ScreenScraper-specific option to remove dots from game name searches when using the multi-scraper in automatic mode * Moved the option "Scrape actual folders" higher up in the scraper options menu * Added the ability to set a manual sortname specifically for custom collections using the metadata editor @@ -178,6 +179,7 @@ * (Windows) Changed many logging entries to use backslashes instead of forward slashes as directory separators * Added the build date to to main menu for alpha and dev builds * Added a left trigger + right trigger help system icon and removed the deprecated hotkey icon +* Added an arcade twin stick controller badge icon * Moved all Platform functions to the utility namespace instead of using the global namespace * Implemented proper XML attribute support in ThemeData that eliminates the risk of name collisions * Added size restrictions to images and fonts so incorrect theme configuration would not lead to crashes or excessive memory utilization diff --git a/THEMES-DEV.md b/THEMES-DEV.md index 3df84c34e..b903cdd06 100644 --- a/THEMES-DEV.md +++ b/THEMES-DEV.md @@ -1491,6 +1491,10 @@ Properties: - Default is `false` * `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 and only if the `imageType` property is utilized. +* `gameselectorEntry` - type: UNSIGNED_INTEGER + - This property which is only available in the `system` view makes it possible to select which `gameselector` entry to use to populate the `imageType` property. This assumes that a `gameCount` property for the gameselector element has been defined with a value higher than `1`. By defining multiple `image` elements with different values for the `gameselectorEntry` property it's possible to display multiple game entries at the same time, for example listing a couple of games that were last played, or a selection of random games. If the requested entry does not exist (for instance if `gameCount` has been set to 5 and `gameselectorEntry` has been set to `4` but the system only contains 3 games), then the overall element will not get rendered. Note that the first entry is defined as `0`, the second entry as `1` etc. + - Minimum value is `0` and maximum value is the value of the `gameselector` element property `gameCount` minus 1. If a value outside this range is defined, then it will be automatically clamped to a valid value. + - Default is `0` * `tile` - type: BOOLEAN - If true, the image will be tiled instead of stretched to fit its size. Useful for backgrounds. - Default is `false` @@ -1588,6 +1592,10 @@ Properties: - Default is `false` * `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. +* `gameselectorEntry` - type: UNSIGNED_INTEGER + - This property which is only available in the `system` view makes it possible to select which `gameselector` entry to use to populate the `imageType` property and to use for playing the video stream. This assumes that a `gameCount` property for the gameselector element has been defined with a value higher than `1`. By defining multiple `video` elements with different values for the `gameselectorEntry` property it's possible to display multiple game entries at the same time, for example listing a couple of games that were last played, or a selection of random games. If the requested entry does not exist (for instance if `gameCount` has been set to 5 and `gameselectorEntry` has been set to `4` but the system only contains 3 games), then the overall element will not get rendered. Note that the first entry is defined as `0`, the second entry as `1` etc. + - Minimum value is `0` and maximum value is the value of the `gameselector` element property `gameCount` minus 1. If a value outside this range is defined, then it will be automatically clamped to a valid value. + - Default is `0` * `audio` - type: BOOLEAN - Whether to enable or disable audio playback for the video. For static videos in the gamelist view it's strongly recommended to set this to `false` if there is also a separate video element playing game videos. - Default is `true` @@ -1627,7 +1635,7 @@ Properties: - If enabled, a short fade-in animation will be applied when scrolling through games in the gamelist view. This animation is only applied to images and not to actual videos, so if no image metadata has been defined then this property has no effect. For this to work correctly the `delay` property also needs to be set. - Default is `false` * `brightness` - type: FLOAT - - Controls the relative level of brightness. This affects both the static image and the video stream. This is intended primarily for fine adjustments, for example if a color shift has been applied which may have lowered the overall brightness of the image. + - Controls the relative level of brightness. This affects both the static image and the video stream. This is intended primarily for fine adjustments, for example if a color shift has been applied which may have lowered the overall brightness of the image/video. - Minimum value is `-2` and maximum value is `2` - Default is `0` (no brightness adjustments applied) * `opacity` - type: FLOAT @@ -1788,6 +1796,7 @@ Properties: `gamepad_xbox`, `joystick_generic`, `joystick_arcade_no_buttons`, + `joystick_arcade_no_buttons_twin`, `joystick_arcade_1_button`, `joystick_arcade_2_buttons`, `joystick_arcade_3_buttons`, @@ -1893,6 +1902,10 @@ Properties: - Default is `false` * `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 and only if the `metadata` property is utilized. +* `gameselectorEntry` - type: UNSIGNED_INTEGER + - This property which is only available in the `system` view makes it possible to select which `gameselector` entry to use to populate the `metadata` property. This assumes that a `gameCount` property for the gameselector element has been defined with a value higher than `1`. By defining multiple `text` elements with different values for the `gameselectorEntry` property it's possible to display multiple game entries at the same time, for example listing a couple of games that were last played, or a selection of random games. If the requested entry does not exist (for instance if `gameCount` has been set to 5 and `gameselectorEntry` has been set to `4` but the system only contains 3 games), then the overall element will not get rendered. Note that the first entry is defined as `0`, the second entry as `1` etc. + - Minimum value is `0` and maximum value is the value of the `gameselector` element property `gameCount` minus 1. If a value outside this range is defined, then it will be automatically clamped to a valid value. + - Default is `0` * `container` - type: BOOLEAN - Whether the text should be placed inside a scrollable container. Only available for the `gamelist` view. - Default is `false` @@ -1981,6 +1994,10 @@ Properties: - `lastplayed` - The time the game was last played. This will be displayed as a value relative to the current date and time by default, but can be overridden using the `displayRelative` property. * `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 and only if the `metadata` property is utilized. +* `gameselectorEntry` - type: UNSIGNED_INTEGER + - This property which is only available in the `system` view makes it possible to select which `gameselector` entry to use to populate the `metadata` property. This assumes that a `gameCount` property for the gameselector element has been defined with a value higher than `1`. By defining multiple `datetime` elements with different values for the `gameselectorEntry` property it's possible to display multiple game entries at the same time, for example listing a couple of games that were last played, or a selection of random games. If the requested entry does not exist (for instance if `gameCount` has been set to 5 and `gameselectorEntry` has been set to `4` but the system only contains 3 games), then the overall element will not get rendered. Note that the first entry is defined as `0`, the second entry as `1` etc. + - Minimum value is `0` and maximum value is the value of the `gameselector` element property `gameCount` minus 1. If a value outside this range is defined, then it will be automatically clamped to a valid value. + - Default is `0` * `fontPath` - type: PATH - Path to a TrueType font (.ttf). * `fontSize` - type: FLOAT @@ -2113,6 +2130,10 @@ Properties: - Default is `0.5 0.5` * `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 + - This property which is only available in the `system` view makes it possible to select which `gameselector` entry to use to populate the rating value. This assumes that a `gameCount` property for the gameselector element has been defined with a value higher than `1`. By defining multiple `rating` elements with different values for the `gameselectorEntry` property it's possible to display multiple game entries at the same time, for example listing a couple of games that were last played, or a selection of random games. If the requested entry does not exist (for instance if `gameCount` has been set to 5 and `gameselectorEntry` has been set to `4` but the system only contains 3 games), then the overall element will not get rendered. Note that the first entry is defined as `0`, the second entry as `1` etc. + - Minimum value is `0` and maximum value is the value of the `gameselector` element property `gameCount` minus 1. If a value outside this range is defined, then it will be automatically clamped to a valid value. + - Default is `0` * `interpolation` - type: STRING - Interpolation method to use when scaling the images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. The effect of this property is primarily visible for raster graphic images, but it has a limited effect also when using scalable vector graphics (SVG) images, and even more so if rotation is applied. - Valid values are `nearest` or `linear` diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index 3946733f4..826584ef5 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -1915,7 +1915,6 @@ Here's an overview of what's supported when using these scrapers: | Multi-language | Yes | No | | Game names | Yes | Yes | | Ratings | Yes | No | -| Controllers (arcade systems only) | Yes | No | | Other game metadata | Yes | Yes | | Videos | Yes | No | | Screenshots | Yes | Yes | @@ -1931,8 +1930,6 @@ The category **Other game metadata** includes Description, Release date, Develop The **Multi-language** support includes translated game genres and game descriptions for a number of languages. -**Controllers** is metadata indicating the controller type (it's not images of controllers). - **Physical media** means images of cartridges, diskettes, tapes, CD-ROMs etc. that were used to distribute the games. There are two approaches to scraping, either for a single game from the metadata editor, or for multiple games and systems using the multi-scraper. @@ -2103,10 +2100,6 @@ Whether to scrape the names of the games. This does not affect the actual files Downloads game ratings. -**Controllers (arcade systems only)** _(ScreenScraper only)_ - -Scrapes controller metadata which is used to set the correct controller badge. This is only available for MAME arcade games, for systems such as _arcade_, _mame_, _neogeo_, _fba_ etc. This is so because ScreenScraper does not seem to provide controller information for other platforms. The type of controllers that are scraped are _joystick_ (separated into entries from no buttons up to 6 buttons), _steering wheel_, _flight stick_, _spinner_, _trackball_ and _lightgun_. - **Other metadata** This includes the game description, release date, developer, publisher, genre and the number of players.