Documentation update.

This commit is contained in:
Leon Styhre 2023-01-10 22:32:49 +01:00
parent e560ab0f58
commit 244de994b6
3 changed files with 11 additions and 4 deletions

View file

@ -104,6 +104,7 @@
* 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"
* Added an "Ignore keyboard input" option to the input device settings menu
* (Unix) Set the "Disable desktop composition" option as disabled by default as it caused issues with some GPU drivers
* 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 a legacy (backward compatibility) mode for still supporting older RetroPie EmulationStation themes
@ -113,6 +114,7 @@
* Added support to the system view for displaying videos, Lottie animations, GIF animations, date/time components and game ratings
* Replaced the forceUppercase theme property with a more versatile letterCase property (forceUppercase is retained for legacy theme compatibility)
* Added two letterCaseCollections and letterCaseGroupedCollections properties to control the letter case more specifically for the primary components
* Added support for overriding the default "unknown" values for the datetime and text elements (in case of missing game metadata)
* Renamed the textlist property selectorOffsetY to selectorVerticalOffset
* Added a selectorHorizontalOffset textlist property to control the selector's relative horizontal position
* Added a selectedSecondaryColor property to the textlist to highlight folder entries in the gamelist view with a different color than file entries
@ -185,6 +187,7 @@
* Increased the default VRAM limit from 256 MiB to 512 MiB
* Increased the default VRAM limit for the Raspberry Pi from 184 MiB to 192 MiB
* (Unix) Removed the RetroArch core directory for the NixOS and nixpkgs repository
* The .emulationstation/gamelists directory is now created on application startup instead of when scraping for the first time
* On Windows all dependencies were moved in-tree to the "external" directory to greatly simplify the build environment
* Updated the build scripts to support native M1/ARM builds on macOS
* Improved the in-tree build on macOS to not needing to install any libraries when compiling the "external" dependencies

View file

@ -2044,6 +2044,8 @@ Properties:
- `playcount` - How many times the game has been played.
- `controller` - The controller for the game. Will be blank if none has been selected.
- `altemulator` - The alternative emulator for the game. Will be blank if none has been selected.
* `defaultValue` - type: STRING
- This property makes it possible to override the default "unknown" text that is displayed if `metadata` has been set to `developer`, `publisher`, `genre` or `players` and there is no metadata available for the defined type. Any string can be used but you can't set it to a blank value. If you don't want to display anything when there is no metadata available, then set this property to `:space:` in which case a blankspace will be used. This property has no effect on the metadata editor where "unknown" will still be shown for blank values.
* `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 additional text elements that should be treated as if they were game metadata entries. This is for example useful for hiding and fading out text labels for the various metadata types like genre, publisher, players etc. Note that it's not possible to disable the metadata hiding functionality for the default metadata fields as that would break basic application behavior. Also note that there is a slight exception to the hiding logic for text containers with the metadata value set to `description`. In this case the element is by default not hidden when enabling the _Hide metadata fields_ setting. To also hide such containers, set this property to true.
- Default is `false`
@ -2135,10 +2137,12 @@ Properties:
- Minimum value per axis is `0` and maximum value per axis is `1`
- Default is `0.5 0.5`.
* `metadata` - type: STRING
- This displays the metadata values that are available for the game. If an invalid metadata field is defined, the text "unknown" 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.
- 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:
- `releasedate` - The release date of the game.
- `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.
* `defaultValue` - type: STRING
- This property makes it possible to override the default "unknown" text that is displayed if `metadata` has been set to `releasedate` or the default "never" text that is displayed if `metadata` has been set to `lastplayed`. Any string can be used but you can't set it to a blank value. If you don't want to display anything when there is no metadata available, then set this property to `:space:` in which case a blankspace will be used. This property has no effect on the metadata editor where "unknown" will still be shown for undefined release date values.
* `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
@ -2178,7 +2182,7 @@ Properties:
- %S: The second [00,59]
* `displayRelative` - type: BOOLEAN.
- Renders the datetime as a relative string (e.g. 'x days ago').
- Default is `false`
- Default is `false` if `metadata` has been set to `releasedate` and `true` if `metadata` has been set to `lastplayed`
* `opacity` - type: FLOAT
- Controls the level of transparency. If set to `0` the element will be disabled.
- Minimum value is `0` and maximum value is `1`

View file

@ -2585,7 +2585,7 @@ The amount of video RAM to use for the application. Defaults to 512 MiB (192 MiB
**Anti-aliasing (MSAA) (requires restart)**
Sets the level of anti-aliasing for the application. You can select between _disabled_, _2x_ or _4x_. Note that this is a potentially dangerous option which may prevent the application from starting altogether with some GPU drivers. If you're unable to run the application after changing this option then you can reset it via the `--anti-alias 0` command line option. This option also has a performance impact and may lead to slightly less leglible text so in general it's recommended to keep it disabled unless you really need it.
Sets the level of anti-aliasing for the application. You can select between _disabled_, _2x_ or _4x_. Note that this is a potentially dangerous option which may prevent the application from starting altogether with some GPU drivers. If you're unable to run the application after changing this option then you can reset it via the `--anti-alias 0` command line option. This option also has a performance impact and may lead to slightly less legible text so in general it's recommended to keep it disabled unless you really need it.
**Display/monitor index (requires restart)**
@ -2633,7 +2633,7 @@ If enabled, only ROMs that have metadata saved to the gamelist.xml files will be
**Disable desktop composition (requires restart)** _(Unix and X11/Xorg only)_
The window manager desktop composition can adversely affect the framerate of ES-DE, especially on weaker graphics cards and when running at higher resolution. As such the desktop compositor is disabled by default, although the window manager has to be configured to allow applications to do this for the option to have any effect. Note that this setting can cause problems with some graphics drivers (notably the Nvidia proprietary drivers) so if you see strange flickering and similar after quitting ES-DE, then disable the setting. In case of such issues, make sure that the emulator is also not blocking the composition (e.g. RetroArch has a corresponding option). This setting has no effect if using Wayland, it only applies to X11/Xorg.
The window manager desktop composition can adversely affect the framerate of ES-DE, especially on weaker graphics cards and when running at higher resolution. As such the desktop compositor can be disabled when running ES-DE, although the window manager has to be configured to allow applications to do this for the option to have any effect. Note that enabling this setting can cause problems with some graphics drivers so if you experience strange flickering and similar, then make sure to keep this setting disabled. In case of such issues, make sure that the emulator is also not blocking the composition (e.g. RetroArch has a corresponding option). This setting has no effect if using Wayland, it only applies to X11/Xorg.
**Display GPU statistics overlay**