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 2021-10-12 23:40:58 +02:00
parent b9b4bd120d
commit 5b2725ba76
3 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
CHANGELOG.md
View file

@ -13,8 +13,10 @@
* Added alternative emulators support where additional emulators can be defined in es_systems.xml and be selected system-wide or per game via the user interface * Added alternative emulators support where additional emulators can be defined in es_systems.xml and be selected system-wide or per game via the user interface
* Populated the bundled es_systems.xml files with alternative emulator entries for most RetroArch cores * Populated the bundled es_systems.xml files with alternative emulator entries for most RetroArch cores
* Added a virtual keyboard, partly based on code from batocera-emulationstation * Added a virtual keyboard, partly based on code from batocera-emulationstation
* Added badges that indicate favorite/completed/broken games as well as games suitable for children and those with a selected alternative emulator
* Added the ability to make complementary game system customizations without having to replace the entire bundled es_systems.xml file * Added the ability to make complementary game system customizations without having to replace the entire bundled es_systems.xml file
* Added support for an optional \<systemsortname\> tag for es_systems.xml that can be used to override the default \<fullname\> systems sorting * Added support for an optional \<systemsortname\> tag for es_systems.xml that can be used to override the default \<fullname\> systems sorting
* Added menu scroll indicators showing if there are additional entries available below or above what's currently shown on screen
* 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.
@ -25,6 +27,7 @@
* 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
* 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
* 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
* Changed the "Toggle screensaver" help entry in the system view to simply "Screensaver" * Changed the "Toggle screensaver" help entry in the system view to simply "Screensaver"
@ -35,6 +38,7 @@
* Added a blinking cursor to TextEditComponent * Added a blinking cursor to TextEditComponent
* Changed the filter description "Text filter (game name)" to "Game name" * Changed the filter description "Text filter (game name)" to "Game name"
* Added support for multi-select total count and exclusive multi-select to OptionListComponent * Added support for multi-select total count and exclusive multi-select to OptionListComponent
* Added support for a maximum name length to OptionListComponent (non-multiselect only) with an abbreviation of the name if it exceeds this value
* Added support for key repeat to OptionListComponent, making it possible to cycle through the options by holding the left or right button * Added support for key repeat to OptionListComponent, making it possible to cycle through the options by holding the left or right button
* Added key repeat for the "Jump to" and "Sort games by" selectors on the game options menu * Added key repeat for the "Jump to" and "Sort games by" selectors on the game options menu
* Added key repeat when editing the "Release date" entry in the metadata editor (DateTimeEditComponent) * Added key repeat when editing the "Release date" entry in the metadata editor (DateTimeEditComponent)
@ -74,14 +78,19 @@
* Leading and trailing whitespace characters would get included in scraper search refines and TheGamesDB searches * Leading and trailing whitespace characters would get included in scraper search refines and TheGamesDB searches
* Game name (text) filters were matching the system names for collection systems if the "Show system names in collections" setting was enabled * Game name (text) filters were matching the system names for collection systems if the "Show system names in collections" setting was enabled
* Brackets such as () and [] were filtered from game names in collection systems if the "Show system names in collections" setting was enabled * Brackets such as () and [] were filtered from game names in collection systems if the "Show system names in collections" setting was enabled
* Fixed multiple issues where ComponentGrid would display incorrect help prompts
* Help prompts were missing for the "Rating" and "Release date" fields in the metadata editor * Help prompts were missing for the "Rating" and "Release date" fields in the metadata editor
* There was some strange behavior in DateTimeEditComponent when changing the date all the way down to 1970-01-01 * There was some strange behavior in DateTimeEditComponent when changing the date all the way down to 1970-01-01
* When navigating menus, the separator lines and menu components did not align properly and moved up and down slightly * When navigating menus, the separator lines and menu components did not align properly and moved up and down slightly
* Under some circumstances and at some screen resolutions, the last menu separator line would not get rendered (still an issue at extreme resolutions like 320x240)
* When scrolling in menus, pressing other buttons than "Up" or "Down" did not stop the scrolling which caused all sorts of weird behavior * When scrolling in menus, pressing other buttons than "Up" or "Down" did not stop the scrolling which caused all sorts of weird behavior
* With the menu scale-up effect enabled and entering a submenu before the parent menu was completely scaled up, the parent would get stuck at a semi-scaled size * With the menu scale-up effect enabled and entering a submenu before the parent menu was completely scaled up, the parent would get stuck at a semi-scaled size
* If there was an abbreviated full system name for the "Gamelist on startup" option, that abbreviation would also get displayed when opening the selector window
* Really long theme set names would not get abbreviated in the UI settings menu, leading to a garbled "Theme set" setting row
* Disabling a collection while its gamelist was displayed would lead to a slide transition from a black screen if a gamelist on startup had been set * Disabling a collection while its gamelist was displayed would lead to a slide transition from a black screen if a gamelist on startup had been set
* When marking a game to not be counted in the metadata editor and the game was part of a custom collection, no collection disabling notification was displayed * When marking a game to not be counted in the metadata editor and the game was part of a custom collection, no collection disabling notification was displayed
* Horizontal sizing of the TextComponent input field was not consistent across different screen resolutions * Horizontal sizing of the TextComponent input field was not consistent across different screen resolutions
* The sizing of the metadata editor was strange, which was clearly visible when activating the Ctrl+G debug mode
* The "sortname" window header was incorrectly spelled when editing this type of entry in the metadata editor * The "sortname" window header was incorrectly spelled when editing this type of entry in the metadata editor
* When the last row of a menu had its text color changed, this color was completely desaturated when navigating to a button below the list * When the last row of a menu had its text color changed, this color was completely desaturated when navigating to a button below the list

8
CONTRIBUTING.md
View file

@ -30,7 +30,6 @@ This plan is under constant review so expect it to change from time to time. Sti
* Support for pre-defined alternative emulators and cores (configured in es_systems.xml) * Support for pre-defined alternative emulators and cores (configured in es_systems.xml)
* Badges highlighting things like favorite games, completed games etc. (will require theme support) * Badges highlighting things like favorite games, completed games etc. (will require theme support)
* Improved full-screen support, removing the temporary full-screen hacks
* Virtual (on-screen) keyboard * Virtual (on-screen) keyboard
* Support for the Raspberry Pi 4 (Raspberry Pi OS) * Support for the Raspberry Pi 4 (Raspberry Pi OS)
* Add GLM library dependency for matrix and vector operations, decommission the built-in functions * Add GLM library dependency for matrix and vector operations, decommission the built-in functions
@ -39,21 +38,22 @@ This plan is under constant review so expect it to change from time to time. Sti
#### v1.3 #### v1.3
* Localization/multi-language support
* New theme engine with generalized views (only System and Gamelist) and theme variants support * New theme engine with generalized views (only System and Gamelist) and theme variants support
* Add multiple new gamelist components (wheels, wall/grid etc.) * Add multiple new gamelist components (wheels, wall/grid etc.)
* Move existing theme logic to legacy support, only to be used for backwards compatibility * Move existing theme logic to legacy support, only to be used for backwards compatibility
* Improve full-screen support and make game launching more seamless, remove the temporary full-screen hacks
* Checksum support for the scraper for exact searches and for determining when to overwrite files * Checksum support for the scraper for exact searches and for determining when to overwrite files
* Improved text and font functions, e.g. faster and cleaner line wrapping and more exact sizing * Improve text and font functions, e.g. faster and cleaner line wrapping and more exact sizing
#### v1.4 #### v1.4
* Localization/multi-language support
* Authoring tools to clean up orphaned gamelist entries, media files etc. * Authoring tools to clean up orphaned gamelist entries, media files etc.
* 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
* Web proxy support for the scraper * Web proxy support for the scraper
* Add "time played" counter per game, similar to how it works in Steam * Add "time played" counter per game, similar to how it works in Steam
* Preload all built-in resources and never clear them from the cache * Preload all built-in resources and never clear them from the cache
* Improved multi-threading * Improve multi-threading
#### v1.5 #### v1.5

4
USERGUIDE-DEV.md
View file

@ -970,6 +970,10 @@ With this option enabled, there will be an overlay displayed when scrolling the
This enables a virtual (on-screen) keyboard that can be used at various places throughout the application to input text and numbers using a controller. The Shift and Alt keys can be toggled individually or combined together to access many special characters. The general use of the virtual keyboard should hopefully be self-explanatory. This enables a virtual (on-screen) keyboard that can be used at various places throughout the application to input text and numbers using a controller. The Shift and Alt keys can be toggled individually or combined together to access many special characters. The general use of the virtual keyboard should hopefully be self-explanatory.
**Enable menu scroll indicators**
With this option enabled, "up and down" scroll indicators will be displayed in the upper right corner of menus (including the metadata editor) if there are more entries available than can be shown on the screen at the same time. These indicators will change dynamically as the list is scrolled. If the setting is disabled, a simplified static indicator will be displayed instead.
**Enable toggle favorites button** **Enable toggle favorites button**
This setting enables the _Y_ button for quickly toggling a game as favorite. Although this may be convenient at times, it's also quite easy to accidentally remove a favorite tagging of a game when using the application more casually. As such it could sometimes make sense to disable this functionality. It's of course still possible to mark a game as favorite using the metadata editor when this setting is disabled. The option does not affect the use of the _Y_ button to add or remove games when editing custom collections. This setting enables the _Y_ button for quickly toggling a game as favorite. Although this may be convenient at times, it's also quite easy to accidentally remove a favorite tagging of a game when using the application more casually. As such it could sometimes make sense to disable this functionality. It's of course still possible to mark a game as favorite using the metadata editor when this setting is disabled. The option does not affect the use of the _Y_ button to add or remove games when editing custom collections.