From d5343ac80b34f2c0c8c1f52e422ad541cd1d970a Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Sun, 4 Jul 2021 12:30:00 +0200 Subject: [PATCH] Documentation update. --- CHANGELOG.md | 5 +++++ CONTRIBUTING.md | 15 +++++++-------- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5cf54d972..930014f4c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -54,6 +54,7 @@ Apart from this, many small improvements and bug fixes are part of the release, * The quit menu is now disabled by default, instead showing the "Quit EmulationStation" entry unless configured otherwise * Removed the "Display game media from ROM directories" setting as it doesn't make sense to support this legacy functionality any longer * Added support for using the %ESPATH% and %ROMPATH% variables in the slideshow screensaver custom image directory setting +* Improved scaling relative to the screen aspect ratio for various GUI components which enhances the layout on 4:3 displays and ultrawide monitors * Removed the menu fade-in effect as it looked terrible * Enabled the menu scale-up effect for the OpenGL ES renderer * Renamed es_systems.cfg, es_settings.cfg and es_input.cfg to es_systems.xml, es_settings.xml and es_input.xml @@ -78,9 +79,11 @@ Apart from this, many small improvements and bug fixes are part of the release, ### Bug fixes * Marking all games as favorites for a system or folder or removing all favorite markings would sometimes crash the application +* Attempting to load a non-existent font file defined by the theme crashed the application instead of using the bundled fallback font * Games that were filtered out were included in the random game selection for the grouped custom collections view * After switching theme sets with only a single system available, diagonal slide transitions would sometimes play when moving to the system view * Ongoing slide transition animations would continue to play after switching theme sets +* When using the Video view style, the static image would not get rendered during the first Slide transition when coming from the System view * Long game names that were horizontally scrolling in the gamelist view would sometimes flicker when returning to the start position * On Windows, images with Unicode characters in the game name that were resized when scraping would not get saved with valid filenames * The glitches when configuring trigger buttons in GuiInputConfig have been fixed @@ -88,7 +91,9 @@ Apart from this, many small improvements and bug fixes are part of the release, * GuiInputConfig didn't correctly inform which buttons could be skipped for some rows * The scraper would sometimes consider very small images to be invalid * The Quick System Select help prompt was shown even when there was only a single game system present +* The "Back (cancel)" help prompt was missing for the single-game scraper * The "Y" button help prompt wasn't displayed correctly when using the Grid view style +* Encountering a corrupt image file would lead to a continuous loop of attempts to load the image while filling the log file with error messages * Cropping in ImageComponent didn't work correctly * The debug logging for the analog controller inputs had some inconsistent signs diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ce04d3967..4bae964e8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,22 +43,22 @@ This plan is under constant review so expect it to change from time to time. Sti * Badges highlighting things like favorite games, completed games etc. (will require theme support) * On-screen keyboard * Web proxy support for the scraper -* Add GLM library dependency for matrix and vector operations, decommissioning the built-in functions +* Add GLM library dependency for matrix and vector operations, starting to decommission the built-in functions +* Flatpak and Snap releases on Linux #### v1.3 * Localization/multi-language support +* Overhaul of the theme handling, adding capabilities and improving compatibility with Recalbox and Batocera themes +* Scrapping the Grid view style and adding a general grid/wall component instead * Checksum support for the scraper for exact searches and for determining when to overwrite files -* Complete overhaul of the grid view style -* A nice and useful grid view implementation in rbsimple-DE -* Improved text and font functions, e.g. faster and cleaner line wrapping -* Flatpak and Snap support on Linux +* Improved text and font functions, e.g. faster and cleaner line wrapping and more exact sizing #### v1.4 * Authoring tools to clean up orphaned gamelist entries, media files etc. +* Scrollbars for menus and gamelists * Support for pre-defined alternative emulators and cores (configured in es_systems.xml) -* Simple file browsing component * 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 * Improved multi-threading @@ -66,8 +66,7 @@ This plan is under constant review so expect it to change from time to time. Sti #### v1.5 * Bulk metadata editor -* Overhaul of the GUI element scaling and placement logic to make ES-DE look more consistent across different resolutions -* Scrollbars for menus and gamelists +* Simple file browsing component * Improve the performance of the GLSL shader code * Animated menu elements like switches, tick boxes, smooth scrolling etc. * Support for additional scraper services (if feasible?)