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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2024-01-11 01:04:42 +01:00
parent 0535f0d333
commit d4c6760bf2
3 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -18,6 +18,8 @@
* Changed the default slideshow custom image directory from slideshow/custom_images to screensavers/custom_slideshow * Changed the default slideshow custom image directory from slideshow/custom_images to screensavers/custom_slideshow
* Changed the custom slideshow image directory setting from ScreensaverSlideshowImageDir to ScreensaverSlideshowCustomDir * Changed the custom slideshow image directory setting from ScreensaverSlideshowImageDir to ScreensaverSlideshowCustomDir
* The HTTP error code will now be shown on scraper errors instead of the "File is smaller than 350 bytes" message * The HTTP error code will now be shown on scraper errors instead of the "File is smaller than 350 bytes" message
* Removed the ScraperHaltOnInvalidMedia option as it has been superseded by the HTTP error code logic
* Added a ScraperIgnoreHTTP404Errors option that can be manually set in es_settings.xml to ignore 404 errors (resource not found)
* Added Mednafen standalone as an alternative emulator for the gb, gba and gbc systems * Added Mednafen standalone as an alternative emulator for the gb, gba and gbc systems
* (Linux) Added support for the AppImage release of Vita3K * (Linux) Added support for the AppImage release of Vita3K
* Added the .zso file extension to the ps2 system * Added the .zso file extension to the ps2 system
@ -31,6 +33,7 @@
* Added a "renderDuringTransitions" property to the image element * Added a "renderDuringTransitions" property to the image element
* Placeholder entries in es_systems.xml are now skipped by default when creating the system directories and systeminfo.txt files * Placeholder entries in es_systems.xml are now skipped by default when creating the system directories and systeminfo.txt files
* Added a CreatePlaceholderSystemDirectories option that can be manually set in es_settings.xml to still create placeholder directories * Added a CreatePlaceholderSystemDirectories option that can be manually set in es_settings.xml to still create placeholder directories
* Changed the ScreenScraper URL from https://www.screenscraper.fr/api2 to https://api.screenscraper.fr/api2
* Added support for more extreme vertical resolutions than previously allowed * Added support for more extreme vertical resolutions than previously allowed
* Added support for the 19.5:9, 20:9 and 1:1 display aspect ratios * Added support for the 19.5:9, 20:9 and 1:1 display aspect ratios
* The relevant SDL error message is now printed to the log if a controller could not be added * The relevant SDL error message is now printed to the log if a controller could not be added
@ -40,6 +43,7 @@
### Bug fixes ### Bug fixes
* Attempting to create the system directories with invalid entries in es_systems.xml could crash the application * Attempting to create the system directories with invalid entries in es_systems.xml could crash the application
* Sometimes controllers were not added correctly when there was a mix of supported and unsupported devices present
* Stationary image elements could sometimes glitch out during carousel navigation * Stationary image elements could sometimes glitch out during carousel navigation
* Font textures were sometimes updated with empty glyhps which generated OpenGL errors on some mobile GPUs * Font textures were sometimes updated with empty glyhps which generated OpenGL errors on some mobile GPUs

4
INSTALL-DEV.md
View file

@ -1109,6 +1109,10 @@ Sets the server connection timeout for the scraper. Minimum value is 0 seconds (
Sets the transfer timeout per HTTPS request. Minimum value is 0 seconds (infinity) and maximum value is 300 seconds. Default value is 120 seconds. Sets the transfer timeout per HTTPS request. Minimum value is 0 seconds (infinity) and maximum value is 300 seconds. Default value is 120 seconds.
**ScraperIgnoreHTTP404Errors**
Normally the scraper will stop whenever an HTTP error code with value 400 or above is returned from the scraper service, but by default there is an exception for 404 errors (resource not found). Changing this setting to _false_ will make the scraper handle 404 errors as all other error codes, meaning it will run through the configured retry attempts and then display an error notification dialog if the resource could not be retrieved.
**UIMode_passkey** **UIMode_passkey**
The passkey to use to change from the _Kiosk_ or _Kid_ UI modes to the _Full_ UI mode. The passkey to use to change from the _Kiosk_ or _Kid_ UI modes to the _Full_ UI mode.

4
USERGUIDE-DEV.md
View file

@ -3058,10 +3058,6 @@ If file hash searching is enabled, then this specifies the maximum allowed file
Affects both overwriting of metadata as well as actual game media files on the filesystem. Even with this option disabled, metadata entries which are set to their default values will be populated by the scraper. In other words, this option only affects overwriting of previously scraped data, or data manually entered via the metadata editor. Game names are considered as set to their default values if either corresponding to the physical game file on disk minus the extension (e.g. the entry _Commando_ if the file is named _Commando.zip_), or for arcade games if corresponding to the MAME names as defined in the bundled mamenames.xml. Note that this setting does not affect generated miximages, that is instead controlled by the setting _Overwrite miximages (scraper/offline generator)_ found in the miximage settings menu. Affects both overwriting of metadata as well as actual game media files on the filesystem. Even with this option disabled, metadata entries which are set to their default values will be populated by the scraper. In other words, this option only affects overwriting of previously scraped data, or data manually entered via the metadata editor. Game names are considered as set to their default values if either corresponding to the physical game file on disk minus the extension (e.g. the entry _Commando_ if the file is named _Commando.zip_), or for arcade games if corresponding to the MAME names as defined in the bundled mamenames.xml. Note that this setting does not affect generated miximages, that is instead controlled by the setting _Overwrite miximages (scraper/offline generator)_ found in the miximage settings menu.
**Halt on invalid media files**
With this setting enabled, if any media files returned by the scraper seem to be invalid, the scraping is halted and an error message is presented where it's possible to retry or cancel the scraping of the specific game. In the case of multi-scraping it's also possible to skip the game and proceed to the next one in the queue. With this setting disabled, all media files will always be accepted and saved to disk. The file verification is quite basic and future versions may improve on this by using file checksums or other file integrity checks. There is an exception in place for box back covers when using ScreenScraper. As many of these specific images are broken, there is an automatic filter built in that is always active and which removes blank images and those containing only a few lines of pixels.
**Search using file hashes (non-interactive mode)** _(ScreenScraper only)_ **Search using file hashes (non-interactive mode)** _(ScreenScraper only)_
When running the non-interactive scraper it's possible to search using a hash value calculated from the actual game file. Assuming ScreenScraper has a match for your file in their database, this will lead to 100% accuracy as the game name will be completely ignored. If there is no match for the hash value, then a fallback will be made to the game name and the normal search logic applies. The maximum allowed file size to apply this type of search to can be set using the _Hash searches max file size_ slider. Note that file hash searching can increase scraping times significantly if applied to large game files as the entire file needs to be read and processed to calculate its hash value. And obviously file hash searching will not work for directories, scripts, shortcuts, .m3u files and so on which will have no matching entries in the ScreenScraper database. When running the non-interactive scraper it's possible to search using a hash value calculated from the actual game file. Assuming ScreenScraper has a match for your file in their database, this will lead to 100% accuracy as the game name will be completely ignored. If there is no match for the hash value, then a fallback will be made to the game name and the normal search logic applies. The maximum allowed file size to apply this type of search to can be set using the _Hash searches max file size_ slider. Note that file hash searching can increase scraping times significantly if applied to large game files as the entire file needs to be read and processed to calculate its hash value. And obviously file hash searching will not work for directories, scripts, shortcuts, .m3u files and so on which will have no matching entries in the ScreenScraper database.