Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-22 06:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-04-13 18:34:57 +02:00
parent 2dadcf4c7d
commit 9ed1bc3d71
2 changed files with 17 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -15,6 +15,7 @@
* Made gamelist theming much more flexible by allowing any number of elements of any types to be defined * Made gamelist theming much more flexible by allowing any number of elements of any types to be defined
* Deprecated multiple older theming concepts like features, extras and hardcoded metadata attributes * Deprecated multiple older theming concepts like features, extras and hardcoded metadata attributes
* Added support for folder links, used for launching game files inside folders without having to enter them * 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
* Modernized the OpenGL renderer by replacing the fixed function pipeline with shaders * 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 (as default) and OpenGL ES 3.0 respectively * Unified the desktop OpenGL and OpenGL ES renderers and upgraded to OpenGL 3.3 (as default) and OpenGL ES 3.0 respectively
* OpenGL: Added an OpenGLVersion setting for choosing between OpenGL 3.3, 4.2 and 4.6 (has to be manually set in es_settings.xml) * OpenGL: Added an OpenGLVersion setting for choosing between OpenGL 3.3, 4.2 and 4.6 (has to be manually set in es_settings.xml)

30
THEMES-DEV.md
View file

@ -1014,21 +1014,24 @@ Properties:
- Minimum value per axis is `0` and maximum value per axis is `0.2` - Minimum value per axis is `0` and maximum value per axis is `0.2`
- Default is `0.01 0.01`. - Default is `0.01 0.01`.
* `slots` - type: STRING * `slots` - type: STRING
- The badge types that should be displayed. Should be specified as a list of strings delimited by commas or by whitespace characters (tabs, spaces or line breaks). The order in which they are defined will be followed when placing badges on screen. Available badges are: - The badge types that should be displayed. Specified as a list of strings delimited by commas or by whitespace characters (tabs, spaces or line breaks). The order in which they are defined will be followed when placing badges on screen. Available badges are:
- `folder` - Will be shown when the current entry is a folder. If a folder link has been setup, then a configurable link icon will overlay this badge.
- `favorite` - Will be shown when the game is marked as favorite. - `favorite` - Will be shown when the game is marked as favorite.
- `completed` - Will be shown when the game is marked as completed. - `completed` - Will be shown when the game is marked as completed.
- `kidgame` - Will be shown when the game is marked as a kids game. - `kidgame` - Will be shown when the game is marked as a kids game.
- `broken` - Will be shown when the game is marked as broken. - `broken` - Will be shown when the game is marked as broken.
- `controller` - Will be shown and overlaid by the corresponding controller icon if a controller type has been selected for the game (using the metadata editor or via scraping). - `controller` - Will be shown and overlaid by the corresponding controller icon if a controller type has been selected for the game (using the metadata editor or via scraping).
- `altemulator` - Will be shown when an alternative emulator is setup for the game. - `altemulator` - Will be shown when an alternative emulator is setup for the game.
- `all` - Including this value will enable all badges. If some badges have been added already they will be shown in the order they were defined and the remaining ones will be added at the end, in the order listed above.
* `controllerPos` - type: NORMALIZED_PAIR * `controllerPos` - type: NORMALIZED_PAIR
- The position of the controller icon relative to the parent `controller` badge. - The position of the controller icon relative to the parent `controller` badge.
- Minimum value per axis is `-1` and maximum value per axis is `2` - Minimum value per axis is `-1` and maximum value per axis is `2`
- Default is `0.5 0.5` which centers the controller icon on the badge. - Default is `0.5 0.5` which centers the controller icon on the badge.
* `controllerSize` - type: FLOAT * `controllerSize` - type: FLOAT
- The size of the controller icon relative to the parent `controller` badge. - The size of the controller icon relative to the parent `controller` badge.
- Setting the value to `1` sizes the controller icon to the same width as the parent badge. The image aspect ratio is always maintained. - Setting the value to `1` sizes the icon to the same width as the parent badge. The image aspect ratio is always maintained.
- Minimum value is `0.1` and maximum value is `2` - Minimum value is `0.1` and maximum value is `2`
- Default is `0.5`
* `customBadgeIcon` - type: PATH * `customBadgeIcon` - type: PATH
- A badge icon override. Specify the badge type in the attribute `badge`. The available badges are the ones listed above. - A badge icon override. Specify the badge type in the attribute `badge`. The available badges are the ones listed above.
* `customControllerIcon` - type: PATH * `customControllerIcon` - type: PATH
@ -1065,6 +1068,17 @@ Properties:
`joycon_left_or_right_nintendo`, `joycon_left_or_right_nintendo`,
`joycon_pair_nintendo`, `joycon_pair_nintendo`,
`unknown` `unknown`
* `folderLinkPos` - type: NORMALIZED_PAIR
- The position of the folder link icon relative to the parent `folder` badge.
- Minimum value per axis is `-1` and maximum value per axis is `2`
- Default is `0.5 0.5` which centers the folder link icon on the badge.
* `folderLinkSize` - type: FLOAT
- The size of the folder link icon relative to the parent `folder` badge.
- Setting the value to `1` sizes the icon to the same width as the parent badge. The image aspect ratio is always maintained.
- Minimum value is `0.1` and maximum value is `1`
- Default is `0.5`
* `customFolderLinkIcon` - type: PATH
- Folder link icon override.
* `opacity` - type: FLOAT * `opacity` - type: FLOAT
- Controls the level of transparency. If set to `0` the element will be disabled. - Controls the level of transparency. If set to `0` the element will be disabled.
- Minimum value is `0` and maximum value is `1` - Minimum value is `0` and maximum value is `1`
@ -1659,15 +1673,3 @@ Deprecated.
- Set the color of the center part of the ninepatch. The default tile background center color and selected tile background center color have no influence on each others. - Set the color of the center part of the ninepatch. The default tile background center color and selected tile background center color have no influence on each others.
* `backgroundEdgeColor` - type: COLOR. * `backgroundEdgeColor` - type: COLOR.
- Set the color of the edge parts of the ninepatch. The default tile background edge color and selected tile background edge color have no influence on each others. - Set the color of the edge parts of the ninepatch. The default tile background edge color and selected tile background edge color have no influence on each others.
## Example legacy theme sets
To see some example EmulationStation legacy themes, the following resources are recommended:
https://aloshi.com/emulationstation#themes
https://github.com/RetroPie
https://gitlab.com/recalbox/recalbox-themes
https://wiki.batocera.org/themes