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 2023-01-29 23:28:40 +01:00
parent 6c8985fe3e
commit e7cd799f07
3 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md
View file

@ -28,6 +28,7 @@ Overall application speed and performance has been greatly improved with faster
* Renamed the default theme set from rbsimple-DE to slate-es-de * Renamed the default theme set from rbsimple-DE to slate-es-de
* Ported modern-DE to the new theme engine and renamed it to modern-es-de * Ported modern-DE to the new theme engine and renamed it to modern-es-de
* Added variant trigger (override) support to replicate the legacy theme engine automatic view style switching * Added variant trigger (override) support to replicate the legacy theme engine automatic view style switching
* Events are now parsed during startup which avoids issues with the OS thinking the application has hung when loading
* Replaced the NanoSVG library with LunaSVG for greatly improved SVG rendering capabilities * Replaced the NanoSVG library with LunaSVG for greatly improved SVG rendering capabilities
* Added support for caching of SVG images * Added support for caching of SVG images
* Added support for sizing SVG images arbitrarily (overriding the image aspect ratio by stretching and squashing) * Added support for sizing SVG images arbitrarily (overriding the image aspect ratio by stretching and squashing)
@ -102,6 +103,7 @@ Overall application speed and performance has been greatly improved with faster
* Added a folder badge, including a folder link overlay in case a link has been configured * 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 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 * Added the ability to color shift badge icons, badge controller icons and badge folder link icons
* Added the ability to center-align badges
* Adjusted the splash screen sizing to be more consistent across various screen aspect ratios * 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 * 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 * 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
@ -126,6 +128,7 @@ Overall application speed and performance has been greatly improved with faster
* Renamed the sound menu option "Play audio for videos in the gamelist view" to "Play audio for gamelist and system view videos" * 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 * 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 * (Unix) Set the "Disable desktop composition" option as disabled by default as it caused issues with some GPU drivers
* (macOS) Enabled startup animations which were previously disabled specifically for this operating system
* The media viewer now always loads all images upfront to avoid audio stutter when browsing the files * 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 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 * Added a legacy (backward compatibility) mode for still supporting older RetroPie EmulationStation themes

4
FAQ.md
View file

@ -108,6 +108,10 @@ This functionality is planned but not yet implemented. It will probably be rolle
ES-DE works very differently compared to all other EmulationStation forks when it comes to handling of game media. There are no links in the gamelist.xml files, instead media files are simply matched against the ROM/game file names which makes for a much simpler, faster and completely portable setup. Migrating game media from other EmulationStation forks (and potentially from other frontends as well) can be accomplished quite easily. See the next question below for more information. Make sure to also read the _Migrating from other EmulationStation forks_ section of the [User guide](USERGUIDE.md#migrating-from-other-emulationstation-forks) to avoid data loss if running ES-DE with existing data from another EmulationStation fork. ES-DE works very differently compared to all other EmulationStation forks when it comes to handling of game media. There are no links in the gamelist.xml files, instead media files are simply matched against the ROM/game file names which makes for a much simpler, faster and completely portable setup. Migrating game media from other EmulationStation forks (and potentially from other frontends as well) can be accomplished quite easily. See the next question below for more information. Make sure to also read the _Migrating from other EmulationStation forks_ section of the [User guide](USERGUIDE.md#migrating-from-other-emulationstation-forks) to avoid data loss if running ES-DE with existing data from another EmulationStation fork.
## It seems like gamelist.xml files in the ROMs directory tree are no longer getting loaded in ES-DE 2.0?
Yes, to optionally read gamelist.xml files from the ROMs directory tree in previous releases was a mistake as it has caused a lot of confusion as well as invalid bug reports. As such the logic has now been changed to only read these files from .emulationstation/gamelists/ which is where they belong. If you insist on retaining the old logic you can do so by manually setting LegacyGamelistFileLocation to true in es_settings.xml as explained [here](INSTALL-DEV.md#settings-not-configurable-via-the-gui), but it's definitely not recommended.
## Why do I sometimes get error messages when scraping stating that files are less than 350 bytes in size? ## Why do I sometimes get error messages when scraping stating that files are less than 350 bytes in size?
This issue can occur occassionally as the ScreenScraper servers sometimes return invalid responses, in this case simply pressing the _RETRY_ button often works. But there is also a ScreenScraper bug where their cache could include entries that no longer exist. When a media file is removed from the ScreenScraper database, the cached link to that file is retained for some time and will be returned as a valid media file URL to ES-DE. However, when attempting to scrape such a file, it will only contain the text string _NOMEDIA_ which will trigger this error in ES-DE. The cache bug only affects the multi-scraper API call, so a workaround is to manually scrape such games using the single-game scraper (reachable via the metadata editor). The invalid cache entries seem to disappear within 24 hours so waiting for a while and rescraping should also resolve the problem. The issue has been reported to the ScreenScraper team but it's unclear if and when it will be resolved. This issue can occur occassionally as the ScreenScraper servers sometimes return invalid responses, in this case simply pressing the _RETRY_ button often works. But there is also a ScreenScraper bug where their cache could include entries that no longer exist. When a media file is removed from the ScreenScraper database, the cached link to that file is retained for some time and will be returned as a valid media file URL to ES-DE. However, when attempting to scrape such a file, it will only contain the text string _NOMEDIA_ which will trigger this error in ES-DE. The cache bug only affects the multi-scraper API call, so a workaround is to manually scrape such games using the single-game scraper (reachable via the metadata editor). The invalid cache entries seem to disappear within 24 hours so waiting for a while and rescraping should also resolve the problem. The issue has been reported to the ScreenScraper team but it's unclear if and when it will be resolved.

8
THEMES-DEV.md
View file

@ -688,7 +688,7 @@ Unlike the types just mentioned, aspectRatio entries can not be set to arbitrary
| 3:2 | 3:2_vertical | 2160x1440 | | 3:2 | 3:2_vertical | 2160x1440 |
| 4:3 | 4:3_vertical | 320x240, 640x480, 800x600, 1024x768, 1600x1200 | | 4:3 | 4:3_vertical | 320x240, 640x480, 800x600, 1024x768, 1600x1200 |
| 5:4 | 5:4_vertical | 1280x1024 | | 5:4 | 5:4_vertical | 1280x1024 |
| 21:9 | 21:9_vertical | 2560x1080, 2560x1440, 3840x1600, 5120x1440 | | 21:9 | 21:9_vertical | 2560x1080, 3840x1600, 5120x2160 |
| 32:9 | 32:9_vertical | 3840x1080, 5120x1440 | | 32:9 | 32:9_vertical | 3840x1080, 5120x1440 |
The 21:9 and 32:9 aspect ratios are approximate as monitors of slightly different ratios are collectively marketed using these numbers. The 21:9 and 32:9 aspect ratios are approximate as monitors of slightly different ratios are collectively marketed using these numbers.
@ -1223,9 +1223,9 @@ Properties:
- Valid values are `centered`, `ascending`, `ascendingRaised`, `descending` or `descendingRaised` - Valid values are `centered`, `ascending`, `ascendingRaised`, `descending` or `descendingRaised`
- Default is `centered` - Default is `centered`
* `selectedItemMargins` - type: NORMALIZED_PAIR * `selectedItemMargins` - type: NORMALIZED_PAIR
- By default items are evenly spaced across the carousel area, but this property makes it possible to define margins (extra space) around the currently selected item. The first value in the pair defines the margin to the left of the item if it's a horizontal carousel or above the item if it's a vertical carousel, and the second value of the pair sets the right or bottom margin for the selected item depending on the carousel orientation. - By default items are evenly spaced across the carousel area, but this property makes it possible to define margins (extra space or less space) around the currently selected item. The first value in the pair defines the margin to the left of the item if it's a horizontal carousel or above the item if it's a vertical carousel, and the second value of the pair sets the right or bottom margin for the selected item depending on the carousel orientation.
- This property can only be used when `type` is `horizontal` or `vertical` - This property can only be used when `type` is `horizontal` or `vertical`
- Minimum value per margin is `0` and maximum value per margin is `1` - Minimum value per margin is `-1` and maximum value per margin is `1`
- Default is `0 0` - Default is `0 0`
* `itemSize` - type: NORMALIZED_PAIR * `itemSize` - type: NORMALIZED_PAIR
- Size of the item prior to multiplication by the `itemScale` value, i.e. the size of all unselected items. Both axes need to be defined. - Size of the item prior to multiplication by the `itemScale` value, i.e. the size of all unselected items. Both axes need to be defined.
@ -1998,7 +1998,7 @@ Properties:
- Minimum value per axis is `0` and maximum value per axis is `1` - Minimum value per axis is `0` and maximum value per axis is `1`
- Default is `0.5 0.5`. - Default is `0.5 0.5`.
* `horizontalAlignment` - type: STRING. * `horizontalAlignment` - type: STRING.
- Valid values are `left` or `right` - Valid values are `left`, `center` or `right`
* `direction` - type: STRING * `direction` - type: STRING
- Controls the primary layout direction (line axis) for the badges. Lines will fill up in the specified direction. - Controls the primary layout direction (line axis) for the badges. Lines will fill up in the specified direction.
- Valid values are `row` or `column` - Valid values are `row` or `column`