Documentation update.

This commit is contained in:
Leon Styhre 2023-01-28 11:37:15 +01:00
parent 530fd26a3b
commit 295b93c852
3 changed files with 38 additions and 1 deletions

View file

@ -101,6 +101,7 @@ Overall application speed and performance has been greatly improved with faster
* Added support for folder links, used for launching game files inside folders without having to enter them
* Added a folder badge, including a folder link overlay in case a link has been configured
* Added a collection badge, shown when editing custom collections to indicate that a game is part of the collection
* Added the ability to color shift badge icons, badge controller icons and badge folder link icons
* Adjusted the splash screen sizing to be more consistent across various screen aspect ratios
* Modernized the OpenGL renderer by replacing the fixed function pipeline with shaders
* Unified the desktop OpenGL and OpenGL ES renderers and upgraded to OpenGL 3.3 (4.6 on the Steam Deck) and OpenGL ES 3.0 respectively

View file

@ -67,7 +67,7 @@ The latest prerelease version is 2.0.0-beta-2023-01-27
| Windows installer | Windows 11, 10 and 8.1 | x64 (x86) | [EmulationStation-DE-2.0.0-beta-2023-01-27-x64.exe](https://gitlab.com/es-de/emulationstation-de/-/package_files/66759574/download)|
| macOS DMG installer | macOS 11 "Big Sur" to 13 "Ventura" | arm64 (M1) | [EmulationStation-DE-2.0.0-beta-2023-01-27-arm64.dmg](https://gitlab.com/es-de/emulationstation-de/-/package_files/66759479/download)|
| macOS DMG installer | macOS 10.14 "Mojave" to 13 "Ventura" | x64 (x86) | [EmulationStation-DE-2.0.0-beta-2023-01-27-x64.dmg](https://gitlab.com/es-de/emulationstation-de/-/package_files/66759558/download)|
| Debian DEB package | Ubuntu 20.04 to 22.04, Linux Mint 20, possibly others | x64 (x86) | [emulationstation-de-2.0.0-beta-2023-01-27-x64.deb](https://gitlab.com/es-de/emulationstation-de/-/package_files/66759536/download)|
| Debian DEB package | Ubuntu 22.04, Linux Mint 20, possibly others | x64 (x86) | [emulationstation-de-2.0.0-beta-2023-01-27-x64.deb](https://gitlab.com/es-de/emulationstation-de/-/package_files/66759536/download)|
| Fedora RPM package | Fedora Workstation 37, possibly others | x64 (x86) | [emulationstation-de-2.0.0-beta-2023-01-27-x64.rpm](https://gitlab.com/es-de/emulationstation-de/-/package_files/66759592/download)|
| Linux AppImage | Most Linux distributions | x64 (x86) | [EmulationStation-DE-2.0.0-beta-2023-01-27-x64.AppImage](https://gitlab.com/es-de/emulationstation-de/-/package_files/66759522/download)|
| Linux AppImage | Steam Deck / SteamOS 3.x specific | x64 (x86) | [EmulationStation-DE-2.0.0-beta-2023-01-27-x64_SteamDeck.AppImage](https://gitlab.com/es-de/emulationstation-de/-/package_files/66759612/download)|

View file

@ -1508,6 +1508,10 @@ Properties:
* `text` - type: STRING
- A string literal to display if there is no `staticImage` or `defaultImage` property defined or if no image is found. This property can only be used in the `system` view as for the gamelist view the game name is always used as fallback.
- Default is the full system name.
* `textRelativeScale` - type: FLOAT.
- This property makes it possible to size the text relative to the overall item size.
- Minimum value is `0.2` and maximum value is `1`
- Default is `1`
* `textColor` - type: COLOR
- Default is `000000FF`
* `textBackgroundColor` - type: COLOR
@ -2064,6 +2068,36 @@ Properties:
- Default is `0.5`
* `customFolderLinkIcon` - type: PATH
- Folder link icon override.
* `badgeIconColor` - type: COLOR
- Applies a color shift to the badge icon by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the image by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel.
- Default is `FFFFFFFF` (no color shift applied)
* `badgeIconColorEnd` - type: COLOR
- Works in the exact same way as `badgeIconColor` but can be set as the end color to apply a color shift gradient.
- Default is the same value as `badgeIconColor`
* `badgeIconGradientType` - type: STRING
- The direction to apply the color shift gradient if both `badgeIconColor` and `badgeIconColorEnd` have been defined.
- Valid values are `horizontal` or `vertical`
- Default is `horizontal`
* `controllerIconColor` - type: COLOR
- Applies a color shift to the controller icon by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the image by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel.
- Default is `FFFFFFFF` (no color shift applied)
* `controllerIconColorEnd` - type: COLOR
- Works in the exact same way as `controllerIconColor` but can be set as the end color to apply a color shift gradient.
- Default is the same value as `controllerIconColor`
* `controllerIconGradientType` - type: STRING
- The direction to apply the color shift gradient if both `controllerIconColor` and `controllerIconColorEnd` have been defined.
- Valid values are `horizontal` or `vertical`
- Default is `horizontal`
* `folderLinkIconColor` - type: COLOR
- Applies a color shift to the folder link icon by multiplying each pixel's color by this color value. For example, an all-white image with `FF0000` applied would become completely red. You can also control the transparency of the image by setting the value to for example `FFFFFFAA`. This keeps all pixels at their normal color and only affects the alpha channel.
- Default is `FFFFFFFF` (no color shift applied)
* `folderLinkIconColorEnd` - type: COLOR
- Works in the exact same way as `folderLinkIconColor` but can be set as the end color to apply a color shift gradient.
- Default is the same value as `folderLinkIconColor`
* `folderLinkIconGradientType` - type: STRING
- The direction to apply the color shift gradient if both `folderLinkIconColor` and `folderLinkIconColorEnd` have been defined.
- Valid values are `horizontal` or `vertical`
- Default is `horizontal`
* `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`
@ -2442,6 +2476,8 @@ The helpsystem is a special element that displays a context-sensitive list of ac
It's possible to set this element as right-aligned or center-aligned using a combination of the `pos` and `origin` properties. For example `<pos>1 1</pos>` and `<origin>1 1</origin>` will place it in the lower right corner of the screen.
Keep in mind that the width of this element can vary depending on a number of factors, for example the _Toggle favorites_ and _Random system or game_ buttons can be enabled or disabled via the _UI Settings_ menu. Test extensively with the menu system as well, especially the virtual keyboard which displays a number of helpsystem entries.
Supported views:
* `system`
* `gamelist`