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 2021-10-25 19:17:40 +02:00
parent be74fd26ef
commit c0f37cd088
4 changed files with 16 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -23,14 +23,16 @@
* Improved the gamelist filter screen to not allow filtering of values where there is no actual data to filter, e.g. Favorites for a system with no favorite games * Improved the gamelist filter screen to not allow filtering of values where there is no actual data to filter, e.g. Favorites for a system with no favorite games
* Grayed out all fields in the gamelist filter screen where there is no data to filter, previously some fields were removed entirely and some could still be used * Grayed out all fields in the gamelist filter screen where there is no data to filter, previously some fields were removed entirely and some could still be used
* Added the ability to filter on blank/unknown values for Genre, Player, Developer, Publisher and Alternative emulator. * Added the ability to filter on blank/unknown values for Genre, Player, Developer, Publisher and Alternative emulator.
* Added a filter for "Alternative emulator" and sorted the filters in the same order as the metadata editor fields * Added filters for "Alternative emulator" and "Controller badges" and sorted the filters in the same order as the metadata editor fields
* Added a menu option to change the application exit key combination * Added a menu option to change the application exit key combination
* Added an option to preload the gamelists on startup which leads to smoother navigation when first entering each gamelist
* Lowered the minimum supported screen resolution from 640x480 to 224x224 to support arcade cabinet displays such as those running at 384x224 and 224x384 * Lowered the minimum supported screen resolution from 640x480 to 224x224 to support arcade cabinet displays such as those running at 384x224 and 224x384
* Expanded the themeable options for "helpsystem" to support custom button graphics, dimmed text and icon colors, upper/lower/camel case and custom spacing * Expanded the themeable options for "helpsystem" to support custom button graphics, dimmed text and icon colors, upper/lower/camel case and custom spacing
* Made the scrolling speed of ScrollableContainer more consistent across various screen resolutions and display aspect ratios * Made the scrolling speed of ScrollableContainer more consistent across various screen resolutions and display aspect ratios
* Decreased the amount of text that ScrollableContainer renders above and below the starting position as content is scrolled * Decreased the amount of text that ScrollableContainer renders above and below the starting position as content is scrolled
* Made the game name and description stop scrolling when running the media viewer, the screensaver or when running in the background while a game is launched * Made the game name and description stop scrolling when running the media viewer, the screensaver or when running in the background while a game is launched
* Added notification popups when plugging in or removing controllers * Added notification popups when plugging in or removing controllers
* Made large optimizations to the SVG rendering which reduces application startup time dramatically when many systems are populated
* Changed to loading the default theme set rbsimple-DE instead of the first available theme if the currently configured theme is missing * Changed to loading the default theme set rbsimple-DE instead of the first available theme if the currently configured theme is missing
* Added support for using the left and right trigger buttons in the help prompts * Added support for using the left and right trigger buttons in the help prompts
* Removed the "Choose" entry from the help prompts in the gamelist view * Removed the "Choose" entry from the help prompts in the gamelist view

4
CONTRIBUTING.md
View file

@ -47,8 +47,8 @@ This plan is under constant review so expect it to change from time to time. Sti
#### v1.4 #### v1.4
* Bulk metadata editor
* Localization/multi-language support * Localization/multi-language support
* Reorganize the menus, possibly adding basic/advanced modes
* Authoring tools to clean up orphaned gamelist entries, media files etc. * Authoring tools to clean up orphaned gamelist entries, media files etc.
* Add scraping of game manuals and maps and create a viewer for these (with PDF, GIF, JPG and PNG support) * Add scraping of game manuals and maps and create a viewer for these (with PDF, GIF, JPG and PNG support)
* Scrollbar component for the gamelist view which can be used by the themes * Scrollbar component for the gamelist view which can be used by the themes
@ -58,7 +58,7 @@ This plan is under constant review so expect it to change from time to time. Sti
#### v1.5 #### v1.5
* Bulk metadata editor * Reorganize the menus, possibly adding basic/advanced modes
* Simple file browsing component * Simple file browsing component
* Improve the performance of the GLSL shader code * Improve the performance of the GLSL shader code
* Animated menu elements like switches, tick boxes, smooth scrolling etc. * Animated menu elements like switches, tick boxes, smooth scrolling etc.

12
THEMES-DEV.md
View file

@ -910,7 +910,7 @@ ES-DE borrows the concept of "nine patches" from Android (or "9-Slices"). Curren
#### badges #### badges
It's strongly recommended to use the same image dimensions for all badges as varying aspect ratios will lead to alignment issues. For the controller images it's recommended to keep to the square canvas size used by the default bundled graphics as otherwise sizing and placement will be inconsistent (unless all controller graphic files are customized of course). Overall it's a very good idea to keep the image dimensions small. This is especially true for SVG graphics as rasterization will otherwise take a long time which will slow down application startup and gamelist navigation. It's strongly recommended to use the same image dimensions for all badges as varying aspect ratios will lead to alignment issues. For the controller images it's recommended to keep to the square canvas size used by the default bundled graphics as otherwise sizing and placement will be inconsistent (unless all controller graphic files are customized of course).
* `pos` - type: NORMALIZED_PAIR. * `pos` - type: NORMALIZED_PAIR.
* `size` - type: NORMALIZED_PAIR. * `size` - type: NORMALIZED_PAIR.
@ -922,10 +922,12 @@ It's strongly recommended to use the same image dimensions for all badges as var
- angle in degrees that the image should be rotated. Positive values will rotate clockwise, negative values will rotate counterclockwise. Default is `0`. - angle in degrees that the image should be rotated. Positive values will rotate clockwise, negative values will rotate counterclockwise. Default is `0`.
* `rotationOrigin` - type: NORMALIZED_PAIR. * `rotationOrigin` - type: NORMALIZED_PAIR.
- Point around which the image will be rotated. Default is `0.5 0.5`. - Point around which the image will be rotated. Default is `0.5 0.5`.
* `itemsPerRow` - type: FLOAT. * `direction` - type: STRING.
- Number of badges that fit on a row. When more badges are available a new row will be started. Default is `4`. - Valid values are "row" or "column". Controls the primary layout direction (line axis) for the badges. Lines will fill up in the specified direction. Default is `row`.
* `rows` - type: FLOAT. * `lines` - type: FLOAT.
- The number of rows available. Default is `2`. - The number of lines available. Default is `2`.
* `itemsPerLine` - type: FLOAT.
- Number of badges that fit on a line. When more badges are available a new line will be started. Default is `4`.
* `itemMargin` - type: NORMALIZED_PAIR. * `itemMargin` - type: NORMALIZED_PAIR.
- The margins between badges. Possible combinations: - The margins between badges. Possible combinations:
- `x y` - horizontal and vertical margins. Minimum value per axis is `0`, maximum value is `0.2`. Default is `0.01 0.01`. If one of the axis is set to `-1` the margin of the other axis (in pixels) will be used, which makes it possible to get identical spacing between all items regardless of screen aspect ratio. - `x y` - horizontal and vertical margins. Minimum value per axis is `0`, maximum value is `0.2`. Default is `0.01 0.01`. If one of the axis is set to `-1` the margin of the other axis (in pixels) will be used, which makes it possible to get identical spacing between all items regardless of screen aspect ratio.

4
USERGUIDE-DEV.md
View file

@ -1252,6 +1252,10 @@ Enabling this option offloads video decoding to the GPU. Whether this actually i
With this option enabled, videos with lower frame rates than 60 FPS, such as 24 and 30 will get upscaled to 60 FPS. This results in slightly smoother playback for some videos. There is a small performance hit from this option, so on weaker machines it may be necessary to disable it for fluent video playback. This setting has no effect when using the VLC video player. If the VLC video player is not included in the ES-DE build, the "(FFmpeg)" text is omitted from the setting name. With this option enabled, videos with lower frame rates than 60 FPS, such as 24 and 30 will get upscaled to 60 FPS. This results in slightly smoother playback for some videos. There is a small performance hit from this option, so on weaker machines it may be necessary to disable it for fluent video playback. This setting has no effect when using the VLC video player. If the VLC video player is not included in the ES-DE build, the "(FFmpeg)" text is omitted from the setting name.
**Preload gamelists on startup**
When this option is enabled, all gamelists will be loaded on application startup. This will increase the startup time slightly and lead to a higher initial memory utilization, but navigation will be smoother the first time a gamelist is entered. The improvement is especially noticeable when the _slide_ transition style has been selected.
**Enable alternative emulators per game** **Enable alternative emulators per game**
If enabled, you will be able to select alternative emulators per game using the metadata editor. It's only recommended to disable this option for testing purposes. If enabled, you will be able to select alternative emulators per game using the metadata editor. It's only recommended to disable this option for testing purposes.