mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-24 23:25:38 +00:00
Documentation update.
This commit is contained in:
parent
035b1004db
commit
1c10fb7466
|
@ -171,6 +171,8 @@
|
||||||
* During some menu operations that reloaded the gamelist view, the cached background could miss some components as they were not rendered in time
|
* During some menu operations that reloaded the gamelist view, the cached background could miss some components as they were not rendered in time
|
||||||
* Changing some values using the metadata editor could lead to an incorrect sort order if the changes were done from within a grouped custom collection
|
* Changing some values using the metadata editor could lead to an incorrect sort order if the changes were done from within a grouped custom collection
|
||||||
* Changing the setting "Group unthemed custom collections" could lead to incorrect custom collections sorting under some circumstances
|
* Changing the setting "Group unthemed custom collections" could lead to incorrect custom collections sorting under some circumstances
|
||||||
|
* Games located in subdirectories were not added back to custom collections when disabling the "Exclude from game counter" metadata option
|
||||||
|
* Enabling and then disabling the "Exclude from game counter" metadata option would remove a game from all currently disabled custom collections
|
||||||
* Navigation sounds for the trigger buttons would play when repeatedly pressed at the start or end of text lists
|
* Navigation sounds for the trigger buttons would play when repeatedly pressed at the start or end of text lists
|
||||||
* Slide and fade transitions would sometimes stop working after changing theme sets
|
* Slide and fade transitions would sometimes stop working after changing theme sets
|
||||||
* Using fade transitions, when holding a direction button to scroll the system view carousel, the key repeat would cause an unwanted background rendering
|
* Using fade transitions, when holding a direction button to scroll the system view carousel, the key repeat would cause an unwanted background rendering
|
||||||
|
@ -179,6 +181,7 @@
|
||||||
* The VideoComponent static images were not fading out smoothly on gamelist fast-scrolling
|
* The VideoComponent static images were not fading out smoothly on gamelist fast-scrolling
|
||||||
* Rating icon outlines would not fade out correctly when fast-scrolling in a gamelist
|
* Rating icon outlines would not fade out correctly when fast-scrolling in a gamelist
|
||||||
* The rating icons would not fit into the designated space in the scraper GUI when running at some vertically oriented screen resolutions
|
* The rating icons would not fit into the designated space in the scraper GUI when running at some vertically oriented screen resolutions
|
||||||
|
* The game description would start to scroll too late when running the multi-scraper in semi-automatic mode
|
||||||
* If setting an origin other than 0.5 for a video with pillarboxes enabled, the video would not get centered on the black rectangle
|
* If setting an origin other than 0.5 for a video with pillarboxes enabled, the video would not get centered on the black rectangle
|
||||||
* If a gamelist scroll fade-in animation was playing when opening a menu, it would continue to play after closing the menu
|
* If a gamelist scroll fade-in animation was playing when opening a menu, it would continue to play after closing the menu
|
||||||
* The gamelist quick list scrolling overlay would not disappear as intended under some circumstances
|
* The gamelist quick list scrolling overlay would not disappear as intended under some circumstances
|
||||||
|
|
2
FAQ.md
2
FAQ.md
|
@ -102,7 +102,7 @@ ES-DE works very differently compared to all other EmulationStation forks when i
|
||||||
|
|
||||||
## 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 is caused by a ScreenScraper bug where their cache sometimes includes 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.
|
||||||
|
|
||||||
## Can I use an external scraper application instead of the built-in scraper?
|
## Can I use an external scraper application instead of the built-in scraper?
|
||||||
|
|
||||||
|
|
|
@ -1423,7 +1423,7 @@ Properties:
|
||||||
|
|
||||||
A carousel for navigating and selecting games or systems.
|
A carousel for navigating and selecting games or systems.
|
||||||
|
|
||||||
On the system view when using fade transitions, any elements placed below or at the same zIndex value as the carousel will be faded to black during transitions, and any elements with a higher zIndex value than the carousel will be faded to transparent.
|
On the system view when using fade transitions, any elements placed below or at the same zIndex value as the carousel will be faded to black during transitions, and any elements with a higher zIndex value than the carousel will be faded to transparent. These two fading methods do not mix well, so if you for example want to overlay some elements with a semi-transparent mask or similar, make sure to keep this in mind. As long as the elements are all above or below the carousel everything will look fine.
|
||||||
|
|
||||||
Supported views:
|
Supported views:
|
||||||
* `system`
|
* `system`
|
||||||
|
|
|
@ -1194,7 +1194,7 @@ For this example, the contents of Tyrian.bat could look like the following:
|
||||||
TYRIAN.EXE
|
TYRIAN.EXE
|
||||||
```
|
```
|
||||||
|
|
||||||
The second approach for DOS games is to keep the directory structure intact for each game, just as if running the game on a real DOS PC. If going for this approach it's recommended to set the metadata field _Count as game_ to off for all files except the actual file used to launch the game, i.e. the binary or the .bat batch file. This is done so that the game counter correctly reflects the number of games you have installed. It's also possible to mark files and subdirectories as hidden to avoid seeing them in ES-DE. Both of these fields can be set using the metadata editor. While this setup is a bit tedious and not as tidy, it can be used with all DOSBox forks while still being able to easily access all files inside the game directory, such as any game configuration utilities.
|
The second approach for DOS games is to keep the directory structure intact for each game, just as if running the game on a real DOS PC. If going for this approach it's recommended to set the metadata field _Exclude from game counter_ to enabled for all files except the actual file used to launch the game, i.e. the binary or the .bat batch file. This is done so that the game counter correctly reflects the number of games you have installed. It's also possible to mark files and subdirectories as hidden to avoid seeing them in ES-DE. Both of these fields can be set using the metadata editor. While this setup is a bit tedious and not as tidy, it can be used with all DOSBox forks while still being able to easily access all files inside the game directory, such as any game configuration utilities.
|
||||||
|
|
||||||
When going for this approach the game folders can be scraped so that it looks nice when browsing the gamelist, but make sure to also scrape the files used to launch the games or otherwise their entries in the collections _All games, Favorites_ and _Last played_ as well as any custom collections will miss the game metadata and game media. If you don't have these collections activated, then this can of course be skipped.
|
When going for this approach the game folders can be scraped so that it looks nice when browsing the gamelist, but make sure to also scrape the files used to launch the games or otherwise their entries in the collections _All games, Favorites_ and _Last played_ as well as any custom collections will miss the game metadata and game media. If you don't have these collections activated, then this can of course be skipped.
|
||||||
|
|
||||||
|
|
|
@ -1152,7 +1152,7 @@ For this example, the contents of Tyrian.bat could look like the following:
|
||||||
TYRIAN.EXE
|
TYRIAN.EXE
|
||||||
```
|
```
|
||||||
|
|
||||||
The second approach for DOS games is to keep the directory structure intact for each game, just as if running the game on a real DOS PC. If going for this approach it's recommended to set the metadata field _Count as game_ to off for all files except the actual file used to launch the game, i.e. the binary or the .bat batch file. This is done so that the game counter correctly reflects the number of games you have installed. It's also possible to mark files and subdirectories as hidden to avoid seeing them in ES-DE. Both of these fields can be set using the metadata editor. While this setup is a bit tedious and not as tidy, it can be used with all DOSBox forks while still being able to easily access all files inside the game directory, such as any game configuration utilities.
|
The second approach for DOS games is to keep the directory structure intact for each game, just as if running the game on a real DOS PC. If going for this approach it's recommended to set the metadata field _Exclude from game counter_ to enabled for all files except the actual file used to launch the game, i.e. the binary or the .bat batch file. This is done so that the game counter correctly reflects the number of games you have installed. It's also possible to mark files and subdirectories as hidden to avoid seeing them in ES-DE. Both of these fields can be set using the metadata editor. While this setup is a bit tedious and not as tidy, it can be used with all DOSBox forks while still being able to easily access all files inside the game directory, such as any game configuration utilities.
|
||||||
|
|
||||||
When going for this approach the game folders can be scraped so that it looks nice when browsing the gamelist, but make sure to also scrape the files used to launch the games or otherwise their entries in the collections _All games, Favorites_ and _Last played_ as well as any custom collections will miss the game metadata and game media. If you don't have these collections activated, then this can of course be skipped.
|
When going for this approach the game folders can be scraped so that it looks nice when browsing the gamelist, but make sure to also scrape the files used to launch the games or otherwise their entries in the collections _All games, Favorites_ and _Last played_ as well as any custom collections will miss the game metadata and game media. If you don't have these collections activated, then this can of course be skipped.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue