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-02-07 21:23:36 +01:00
parent 71a647e0cb
commit d1cbbad8ee
4 changed files with 84 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -28,6 +28,7 @@
* Added the ability to set a manual sortname specifically for custom collections using the metadata editor * Added the ability to set a manual sortname specifically for custom collections using the metadata editor
* When scraping in semi-automatic mode, horizontal scrolling of long game names are no longer reset when automatically selecting the result * When scraping in semi-automatic mode, horizontal scrolling of long game names are no longer reset when automatically selecting the result
* Reduced CPU usage significantly when a menu is open by not rendering the bottom of the stack * Reduced CPU usage significantly when a menu is open by not rendering the bottom of the stack
* Reduced CPU usage by only rendering the currently visible system in SystemView
* Added an OpenGL ES 2.0 renderer (borrowed from the RetroPie fork of EmulationStation) * Added an OpenGL ES 2.0 renderer (borrowed from the RetroPie fork of EmulationStation)
* Added logging of the display refresh rate on startup * Added logging of the display refresh rate on startup
* Improved the theme loading error logging to make it consistent and easier to understand * Improved the theme loading error logging to make it consistent and easier to understand
@ -41,6 +42,7 @@
* Large refactoring to improve thread safety and improve singleton pattern usage * Large refactoring to improve thread safety and improve singleton pattern usage
* Moved all Platform functions to the utility namespace instead of using the global namespace * Moved all Platform functions to the utility namespace instead of using the global namespace
* Implemented proper XML attribute support in ThemeData that eliminated the risk of name collisions * Implemented proper XML attribute support in ThemeData that eliminated the risk of name collisions
* Migrated the carousel code from SystemView to a separate new CarouselComponent
* Changed all occurances of "GameList" to "Gamelist" throughout the codebase * Changed all occurances of "GameList" to "Gamelist" throughout the codebase
* Removed a huge amount of unnecessary Window* function parameters throughout the codebase * Removed a huge amount of unnecessary Window* function parameters throughout the codebase
* Refactored the six gamelist classes into two new classes; GamelistBase and GamelistView * Refactored the six gamelist classes into two new classes; GamelistBase and GamelistView

109
THEMES-DEV.md
View file

@ -946,7 +946,13 @@ It's strongly recommended to use the same image dimensions for all badges as var
- A string literal to display. - A string literal to display.
* `metadata` - type: STRING * `metadata` - type: STRING
- This translates to the metadata values that are available for the game. If an invalid metadata field is defined, it will be printed as a string literal. - This translates to the metadata values that are available for the game. If an invalid metadata field is defined, it will be printed as a string literal.
- Possible values: - Possible values for the system view:
- `sy_name` - Short system name as defined in es_systems.xml.
- `sy_fullname` - Full system name as defined in es_systems.xml.
- `sy_gamecount` - Number of games available for the system. Number of favorites are printed inside brackets if applicable.
- `sy_gamecount_games` - Number of games available for the system. Does not print the favorites count.
- `sy_gamecount_favorites` - Number of favorite games for the system, may be blank if favorites are not applicable.
- Possible values for the gamelist view:
- `md_name` - Game name. - `md_name` - Game name.
- `md_description` - Game description. Should be combined with the `container` property in most cases. - `md_description` - Game description. Should be combined with the `container` property in most cases.
- `md_rating` - The numerical representation of the game rating, for example `3` or `4.5`. - `md_rating` - The numerical representation of the game rating, for example `3` or `4.5`.
@ -962,9 +968,9 @@ It's strongly recommended to use the same image dimensions for all badges as var
- `md_controller` - The controller for the game. Will be blank if none has been selected. - `md_controller` - The controller for the game. Will be blank if none has been selected.
- `md_altemulator` - The alternative emulator for the game. Will be blank if none has been selected. - `md_altemulator` - The alternative emulator for the game. Will be blank if none has been selected.
* `container` - type: BOOLEAN * `container` - type: BOOLEAN
- Whether the text should be placed inside a scrollable container. - Whether the text should be placed inside a scrollable container. Only available for the gamelist view.
* `fontPath` - type: PATH * `fontPath` - type: PATH
- Path to a truetype font (.ttf). - Path to a TrueType font (.ttf).
* `fontSize` - type: FLOAT * `fontSize` - type: FLOAT
- Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height).
* `alignment` - type: STRING * `alignment` - type: STRING
@ -1005,7 +1011,7 @@ It's strongly recommended to use the same image dimensions for all badges as var
- `md_releasedate` - The release date of the game. - `md_releasedate` - The release date of the game.
- `md_lastplayed` - The time the game was last played. This will be displayed as a value relative to the current date and time. - `md_lastplayed` - The time the game was last played. This will be displayed as a value relative to the current date and time.
* `fontPath` - type: PATH * `fontPath` - type: PATH
- Path to a truetype font (.ttf). - Path to a TrueType font (.ttf).
* `fontSize` - type: FLOAT * `fontSize` - type: FLOAT
- Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height).
* `alignment` - type: STRING * `alignment` - type: STRING
@ -1054,7 +1060,7 @@ Displays the game count (all games as well as favorites), any applied filters, a
- Default is `0.5 0.5` - Default is `0.5 0.5`
* `backgroundColor` - type: COLOR * `backgroundColor` - type: COLOR
* `fontPath` - type: PATH * `fontPath` - type: PATH
- Path to a truetype font (.ttf). - Path to a TrueType font (.ttf).
* `fontSize` - type: FLOAT * `fontSize` - type: FLOAT
- Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). - Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height).
* `color` - type: COLOR * `color` - type: COLOR
@ -1095,7 +1101,7 @@ Displays the game count (all games as well as favorites), any applied filters, a
* `type` - type: STRING * `type` - type: STRING
- Sets the scoll direction of the carousel. - Sets the scoll direction of the carousel.
- Accepted values are `horizontal`, `vertical`, `horizontal_wheel` or `vertical_wheel`. - Valid values are `horizontal`, `vertical`, `horizontal_wheel` or `vertical_wheel`.
- Default is `horizontal` - Default is `horizontal`
* `size` - type: NORMALIZED_PAIR * `size` - type: NORMALIZED_PAIR
- Default is `1 0.2325` - Default is `1 0.2325`
@ -1104,12 +1110,25 @@ Displays the game count (all games as well as favorites), any applied filters, a
* `origin` - type: NORMALIZED_PAIR * `origin` - type: NORMALIZED_PAIR
- Where on the carousel `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the carousel exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied. - Where on the carousel `pos` refers to. For example, an origin of `0.5 0.5` and a `pos` of `0.5 0.5` would place the carousel exactly in the middle of the screen. If the position and size attributes are themeable, origin is implied.
* `color` - type: COLOR * `color` - type: COLOR
- Controls the color of the carousel background. - Color of the carousel background panel. Setting a value of `00000000` makes the background panel transparent.
- Default is `FFFFFFD8` - Default is `FFFFFFD8`
* `colorEnd` - type: COLOR
- Setting this to something other than what is defined for `color` creates a color gradient on the background panel.
- Default is `0xFFFFFFD8`
* `gradientType` - type: STRING
- The direction to apply the color gradient if both `color` and `colorEnd` have been defined.
- Possible values are `horizontal` or `vertical`
- Default is `horizontal`
* `logo` - type: PATH
- Path to the logo image file. Most common extensions are supported (including .jpg, .png, and unanimated .gif).
* `defaultLogo` - type: PATH
- Path to the default logo file which will be displayed if the image defined via the `logo` property is not found. Most common extensions are supported (including .jpg, .png, and unanimated .gif).
* `logoSize` - type: NORMALIZED_PAIR * `logoSize` - type: NORMALIZED_PAIR
- Minimum value is `0.05` and maximum value is `1`
- Default is `0.25 0.155` - Default is `0.25 0.155`
* `logoScale` - type: FLOAT. * `logoScale` - type: FLOAT.
- Selected logo is increased in size by this scale - Selected logo is increased in size by this scale
- Minimum value is `0.5` and maximum value is `3`
- Default is `1.2` - Default is `1.2`
* `logoRotation` - type: FLOAT * `logoRotation` - type: FLOAT
- Angle in degrees that the logos should be rotated. Value should be positive. - Angle in degrees that the logos should be rotated. Value should be positive.
@ -1118,21 +1137,39 @@ Displays the game count (all games as well as favorites), any applied filters, a
* `logoRotationOrigin` - type: NORMALIZED_PAIR * `logoRotationOrigin` - type: NORMALIZED_PAIR
- Point around which the logos will be rotated. - Point around which the logos will be rotated.
- This property only applies when `type` is "horizontal_wheel" or "vertical_wheel". - This property only applies when `type` is "horizontal_wheel" or "vertical_wheel".
- Default is `-5 0.5` - Default is `-3 0.5`
* `logoAlignment` - type: STRING * `logoAlignment` - type: STRING
- Sets the alignment of the logos relative to the carousel. - Sets `logo` and `text` alignment relative to the carousel.
- Accepted values are `top`, `bottom` or `center` when `type` is "horizontal" or "horizontal_wheel". - Valid values are `top`, `bottom` or `center` when `type` is "horizontal"
- Accepted values are `left`, `right` or `center` when `type` is "vertical" or "vertical_wheel". - Valid values are `left`, `right` or `center` when `type` is "vertical"
- All values are valid when `type` is "horizontal_wheel" or "vertical_wheel".
- Default is `center` - Default is `center`
* `maxLogoCount` - type: FLOAT * `maxLogoCount` - type: FLOAT
- Sets the number of logos to display in the carousel. - Sets the number of logos to display in the carousel.
- Minimum value is `2` and maximum value is `30`
- Default is `3` - Default is `3`
* `text` - type: STRING
- A string literal to display if there is no `logo` or `defaultLogo` properties defined and if no images were found.
* `textColor` - type: COLOR
- Default is `000000FF`
* `textBackgroundColor` - type: COLOR
- Default is `FFFFFF00`
* `textStyle` - type: STRING
- The style of the text.
- Valid values are `original`, `uppercase`, `lowercase` or `camelcase`
- Default is `original` (original formatting is retained)
* `fontPath` - type: PATH
- Path to a TrueType font (.ttf) used as fallback if there is no `logo` image defined or found, and if `defaultLogo` has not been defined.
* `fontSize` - type: FLOAT
- Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height).
- Default is `0.085`
* `lineSpacing` - type: FLOAT
- Controls the space between lines (as a multiple of font height).
- Minimum value is `0.5` and maximum value is `3`
- Default is `1.5`
* `zIndex` - type: FLOAT * `zIndex` - type: FLOAT
- z-index value for element. Elements will be rendered in order of zIndex value from low to high. - z-index value for element. Elements will be rendered in order of zIndex value from low to high.
- Default is `50` - Default is `50`
* `legacyZIndexMode` - type: BOOLEAN
- If true, the carousel will ignore zIndex and always render on top of other elements.
- Default is `true`
#### textlist #### textlist
@ -1177,24 +1214,36 @@ This is a list containing rows of text which can be navigated using the keyboard
The help system is a special element that displays a context-sensitive list of actions the user can take at any time. You should try and keep the position constant throughout every screen. Keep in mind the "default" settings (including position) are used whenever the user opens a menu. The help system is a special element that displays a context-sensitive list of actions the user can take at any time. You should try and keep the position constant throughout every screen. Keep in mind the "default" settings (including position) are used whenever the user opens a menu.
* `pos` - type: NORMALIZED_PAIR. Default is "0.012 0.9515" * `pos` - type: NORMALIZED_PAIR
* `origin` - type: NORMALIZED_PAIR. - Default is `0.012 0.9515`
* `origin` - type: NORMALIZED_PAIR
- 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 - 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. the element exactly in the middle of the screen.
* `textColor` - type: COLOR. Default is 777777FF. * `textColor` - type: COLOR
* `textColorDimmed` - type: COLOR. Default is the same value as textColor. Must be placed under the 'system' view. - Default is `777777FF`
* `iconColor` - type: COLOR. Default is 777777FF. * `textColorDimmed` - type: COLOR
* `iconColorDimmed` - type: COLOR. Default is the same value as iconColor. Must be placed under the 'system' view. - Must be placed under the 'system' view.
* `fontPath` - type: PATH. - Default is the same value as textColor.
* `fontSize` - type: FLOAT. * `iconColor` - type: COLOR
* `entrySpacing` - type: FLOAT. Default is 16.0. - Default is `777777FF`
* `iconColorDimmed` - type: COLOR
- Must be placed under the 'system' view.
- Default is the same value as iconColor.
* `fontPath` - type: PATH
* `fontSize` - type: FLOAT
* `entrySpacing` - type: FLOAT
- Spacing in pixels between the help system elements. - Spacing in pixels between the help system elements.
* `iconTextSpacing` - type: FLOAT. Default is 8.0. - Default is `16.0`
- Spacing in pixels within a help system element between it's icon and text. * `iconTextSpacing` - type: FLOAT
* `textStyle` - type: STRING. Default is `uppercase`. - Spacing in pixels within a help system element between its icon and text.
- The style of the text. Options: `uppercase`, `lowercase`, `camelcase`. - Default is `8.0`
* `customButtonIcon` - type: PATH. * `textStyle` - type: STRING
- A button icon override. Specify the button type in the attribute `button`. The available buttons are: - The style of the text.
- Valid values are `uppercase`, `lowercase` or `camelcase`
- Default is `uppercase`
* `customButtonIcon` - type: PATH
- A button icon override. Specify the button type in the attribute `button`.
- The available buttons are: \
`dpad_updown`, `dpad_updown`,
`dpad_leftright`, `dpad_leftright`,
`dpad_all`, `dpad_all`,
@ -1225,7 +1274,7 @@ The help system is a special element that displays a context-sensitive list of a
`button_back_XBOX`, `button_back_XBOX`,
`button_start_XBOX`, `button_start_XBOX`,
`button_back_XBOX360`, `button_back_XBOX360`,
`button_start_XBOX360`. `button_start_XBOX360`
#### imagegrid #### imagegrid

15
THEMES-LEGACY.md
View file

@ -364,8 +364,6 @@ Below are the default zIndex values per element type:
* System Logo/Text - 50 * System Logo/Text - 50
* `image name="logo"` * `image name="logo"`
* `text name="logoText"` * `text name="logoText"`
* `image name="logoPlaceholderImage"`
* `text name="logoPlaceholderText"`
* Gamelist information - 50 * Gamelist information - 50
* `text name="gamelistInfo"` * `text name="gamelistInfo"`
* Badges - 50 * Badges - 50
@ -418,15 +416,8 @@ or to specify only a portion of the value of a theme property:
- The system logo carousel - The system logo carousel
* `image name="logo"` - PATH | COLOR * `image name="logo"` - PATH | COLOR
- A logo image, to be displayed in the system logo carousel. - A logo image, to be displayed in the system logo carousel.
* `image name="logoPlaceholderImage"` - ALL
- A logo image, to be displayed system name in the system logo carousel when no logo is available. Set the position
to `0.5 0.5` to center the image.
* `text name="logoPlaceholderText"` - ALL
- Logo text, to be displayed system name in the system logo carousel when no logo is available. The logo text is
displayed on top of `logoPlaceholderImage`. Set the position to `0.5 0.5` to center the text.
* `text name="logoText"` - FONT_PATH | COLOR | FORCE_UPPERCASE | LINE_SPACING | TEXT * `text name="logoText"` - FONT_PATH | COLOR | FORCE_UPPERCASE | LINE_SPACING | TEXT
- **Deprecated:** A logo text, to be displayed system name in the system logo carousel when no logo is available. - A logo text, to be displayed system name in the system logo carousel when no logo is available.
Ignored when `logoPlaceholderImage` or `logoPlaceholderText` are set.
* `text name="systemInfo"` - ALL * `text name="systemInfo"` - ALL
- Displays details of the system currently selected in the carousel. - Displays details of the system currently selected in the carousel.
* You can use extra elements (elements with `extra="true"`) to add your own backgrounds, etc. They will be displayed * You can use extra elements (elements with `extra="true"`) to add your own backgrounds, etc. They will be displayed
@ -1023,9 +1014,7 @@ It's strongly recommended to use the same image dimensions for all badges as var
- Sets the number of logos to display in the carousel. - Sets the number of logos to display in the carousel.
- Default is 3 - Default is 3
* `zIndex` - type: FLOAT. * `zIndex` - type: FLOAT.
- z-index value for component. Components will be rendered in order of z-index value from low to high. - z-index value for component. Components will be rendered in order of z-index value from low to high with the carousel above all other components.
* `legacyZIndexMode` - type: BOOLEAN
- If true, the carousel will ignore zIndex and always render on top of other components. Default is `true`.
The help system is a special element that displays a context-sensitive list of actions the user can take at any time. You should try and keep the position constant throughout every screen. Keep in mind the "default" settings (including position) are used whenever the user opens a menu. The help system is a special element that displays a context-sensitive list of actions the user can take at any time. You should try and keep the position constant throughout every screen. Keep in mind the "default" settings (including position) are used whenever the user opens a menu.

13
THEMES.md
View file

@ -362,8 +362,6 @@ Below are the default zIndex values per element type:
* System Logo/Text - 50 * System Logo/Text - 50
* `image name="logo"` * `image name="logo"`
* `text name="logoText"` * `text name="logoText"`
* `image name="logoPlaceholderImage"`
* `text name="logoPlaceholderText"`
* Gamelist information - 50 * Gamelist information - 50
* `text name="gamelistInfo"` * `text name="gamelistInfo"`
* Badges - 50 * Badges - 50
@ -416,15 +414,8 @@ or to specify only a portion of the value of a theme property:
- The system logo carousel - The system logo carousel
* `image name="logo"` - PATH | COLOR * `image name="logo"` - PATH | COLOR
- A logo image, to be displayed in the system logo carousel. - A logo image, to be displayed in the system logo carousel.
* `image name="logoPlaceholderImage"` - ALL
- A logo image, to be displayed system name in the system logo carousel when no logo is available. Set the position
to `0.5 0.5` to center the image.
* `text name="logoPlaceholderText"` - ALL
- Logo text, to be displayed system name in the system logo carousel when no logo is available. The logo text is
displayed on top of `logoPlaceholderImage`. Set the position to `0.5 0.5` to center the text.
* `text name="logoText"` - FONT_PATH | COLOR | FORCE_UPPERCASE | LINE_SPACING | TEXT * `text name="logoText"` - FONT_PATH | COLOR | FORCE_UPPERCASE | LINE_SPACING | TEXT
- **Deprecated:** A logo text, to be displayed system name in the system logo carousel when no logo is available. - A logo text, to be displayed system name in the system logo carousel when no logo is available.
Ignored when `logoPlaceholderImage` or `logoPlaceholderText` are set.
* `text name="systemInfo"` - ALL * `text name="systemInfo"` - ALL
- Displays details of the system currently selected in the carousel. - Displays details of the system currently selected in the carousel.
* You can use extra elements (elements with `extra="true"`) to add your own backgrounds, etc. They will be displayed * You can use extra elements (elements with `extra="true"`) to add your own backgrounds, etc. They will be displayed
@ -996,8 +987,6 @@ It's strongly recommended to use the same image dimensions for all badges as var
- Default is 3 - Default is 3
* `zIndex` - type: FLOAT. * `zIndex` - type: FLOAT.
- z-index value for component. Components will be rendered in order of z-index value from low to high. - z-index value for component. Components will be rendered in order of z-index value from low to high.
* `legacyZIndexMode` - type: BOOLEAN
- If true, the carousel will ignore zIndex and always render on top of other components. Default is `true`.
The help system is a special element that displays a context-sensitive list of actions the user can take at any time. You should try and keep the position constant throughout every screen. Keep in mind the "default" settings (including position) are used whenever the user opens a menu. The help system is a special element that displays a context-sensitive list of actions the user can take at any time. You should try and keep the position constant throughout every screen. Keep in mind the "default" settings (including position) are used whenever the user opens a menu.