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-07-13 16:04:45 +02:00
parent 8e24c7b1d4
commit 6cfe0467a9
2 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -27,6 +27,8 @@ For the Linux AppImage releases a built-in application updater has been added so
* Added trigger button support to the media viewer for jumping to the first and last entries * Added trigger button support to the media viewer for jumping to the first and last entries
* Added trigger button support to the theme downloader screenshot viewer for jumping to the first and last entries * Added trigger button support to the theme downloader screenshot viewer for jumping to the first and last entries
* Added a game manual badge to indicate whether a game has a downloaded PDF manual * Added a game manual badge to indicate whether a game has a downloaded PDF manual
* Enabled textlist fast-scrolling for the system view
* The textlist navigation sound will now always start playing immediately when scrolling a single entry
* Added options to the video and slideshow screensavers to only include favorite games * Added options to the video and slideshow screensavers to only include favorite games
* Added a per-system game count to the multi-scraper * Added a per-system game count to the multi-scraper
* Changed the scraper auto-retry functionality to never run on non-recoverable errors such as insufficient file permissions * Changed the scraper auto-retry functionality to never run on non-recoverable errors such as insufficient file permissions

2
THEMES-DEV.md
View file

@ -987,6 +987,8 @@ Just remember, _this only works if the elements have the same type._
Navigation sounds are configured globally per theme set, so it needs to be defined using the special `all` view. Navigation sounds are configured globally per theme set, so it needs to be defined using the special `all` view.
It's recommended to put these elements in a separate file and include it from the main theme file (e.g. `<include>./navigationsounds.xml</include>`). Starting ES-DE with the --debug flag will provide feedback on whether any navigation sound elements were read from the theme set. If no navigation sounds are provided by the theme, ES-DE will use the bundled navigation sounds as a fallback. This is done per sound file, so the theme could provide for example one or two custom sounds while using the bundled ES-DE sounds for the rest. It's recommended to put these elements in a separate file and include it from the main theme file (e.g. `<include>./navigationsounds.xml</include>`). Starting ES-DE with the --debug flag will provide feedback on whether any navigation sound elements were read from the theme set. If no navigation sounds are provided by the theme, ES-DE will use the bundled navigation sounds as a fallback. This is done per sound file, so the theme could provide for example one or two custom sounds while using the bundled ES-DE sounds for the rest.
When fast-scrolling the textlist (by holding the up/down or shoulder buttons) the _scroll_ and _systembrowse_ sounds always play to completion before being played again, so it will sound weird if you have long samples such as those with reverb or silence added to the end. As such make sure to always use short samples for these sounds and test thoroughly with fast-scrolling. This is not an issue if using the carousel or grid elements.
Example debug output: Example debug output:
``` ```
Jul 12 11:28:58 Debug: NavigationSounds::loadThemeNavigationSounds(): Theme set includes navigation sound support, loading custom sounds Jul 12 11:28:58 Debug: NavigationSounds::loadThemeNavigationSounds(): Theme set includes navigation sound support, loading custom sounds