Documentation update

CHANGELOG.md

@@ -4,27 +4,35 @@
 
 **Release date:** TBD
 
+### Release overview
+
+The 2.1 release brings a new look to ES-DE by changing the default menu color scheme from light to dark. There is however a setting to revert to the light color scheme if that's preferred. Scraping and viewing of PDF game manuals has also been added, with the PDF viewer being reachable from the gamelist media viewer.
+
+Miximages will now be generated with a proper image fit if the screenshot aspect ratio doesn't match the miximage frame. This will for instance occur for widescreen systems and vertically oriented arcade shooters. There are multiple new options to control this behavior in the miximage settings menu. System sorting has also been improved, making it possible to use a separate es_systems_sorting.xml file in the custom_systems directory, meaning it's no longer required to add systemsortname tags to the es_systems.xml file.
+
+For the Linux AppImage releases a built-in application updater has been added so that future versions can be installed automatically. Apart from all these changes many smaller improvements have been made and a couple of new systems have been added.
+
 ### Detailed list of changes
 
+* Added support for changing between dark and light color schemes for the menu system (with dark being the new default)
 * Added a PDF game manual viewer, accessible from the media viewer
 * Added an option to scrape game manuals using ScreenScraper
-* Added a game manual badge to indicate whether a game has a downloaded PDF manual
-* Added a separate es-pdf-convert binary to render PDF pages using Poppler (needed due to the restrictive GPL license for this library)
 * Added an application updater which downloads and installs ES-DE updates (currently only the AppImage releases are supported)
-* Added help prompts to the media viewer
-* 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 options to the miximage generator for how to fit screenshots that do not match the aspect ratio of the miximage frame
-* Added support for changing between light and dark color schemes for the menu system
-* Added a per-system game count to the multi-scraper in addition to the total game count
-* Changed the scraper auto-retry functionality to never run on non-recoverable errors such as insufficient file permissions
-* Added options to the video and slideshow screensavers to only include favorite games
 * Added support for a dedicated es_systems_sorting.xml file to change systems sorting without having to modify es_systems.xml
 * Bundled four complete es_systems_sorting.xml files with the application (they can be found in the resources/sorting/ directory)
 * Placing an es_find_rules.xml file in custom_systems will now complement rather than override the bundled file
+* Added help prompts to the media viewer
+* 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 a game manual badge to indicate whether a game has a downloaded PDF manual
+* Added options to the video and slideshow screensavers to only include favorite games
+* 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
 * Added support for the LowRes NX Fantasy Console (lowresnx) game system
 * Added support for the Epoch Super Cassette Vision (scv) game system
 * Added the SameBoy RetroArch core as an alternative emulator for the sgb system
+* Added an sgb (Nintendo Super Game Boy) platform to improve scraping when using ScreenScraper
 * Added MAME standalone as an alternative emulator for the amstradcpc, cdimono1 and x68000 systems
 * Added ares standalone as an alternative emulator for the n64dd system
 * Added ares [Benesse Pocket Challenge V2] standalone as an alternative emulator for the wonderswan system
@@ -34,23 +42,23 @@
 * (Linux) Added support for the official Citra AppImage release
 * (Windows) Added pcsx2-qt.exe as the primary executable name for the PCSX2 emulator
 * Added support for scraping the arduboy and ps4 systems using ScreenScraper
-* Added an sgb (Nintendo Super Game Boy) platform to improve scraping using ScreenScraper
+* Improved resilience to buggy controller drivers which could previously crash the application (mostly relevant for macOS)
 * Removed the experimental status for the theme downloader
 * Simplified ApplicationUpdater by only using the release number when checking for updates
 * Added more error checking to ApplicationUpdater by checking for blank name, filename, url and md5 keys in latest_release.json
-* Improved resilience to buggy controller drivers which could previously crash the application (mostly relevant for macOS)
+* Removed the custom SDL patch for the AppImage builds that prevented the device's virtual keyboard from being automatically displayed
-* Removed the custom SDL patch for the Linux AppImage builds that prevented the device virtual keyboard from being automatically displayed
+* If the SDL library release is 2.28.0 or higher then the automatic popup of the device's virtual keyboard is now disabled
-* If the SDL library release is 2.28.0 or higher, then the automatic popup of the device's virtual keyboard is now disabled
 * The SDL library version is now printed to es_log.txt on application startup
+* Added a separate es-pdf-convert binary to render PDF pages using Poppler (needed due to the restrictive GPL license for this library)
 * (Windows) A check is now performed on startup that OpenGL is actually supported by the GPU driver, to avoid crashes if it isn't
 * Added a setRawImage function to ImageComponent to load raw pixel data into textures (needed by PDFViewer)
 * Added the Poppler PDF rendering library as a dependency
 * Removed the unused graphics files resources/graphics/cartridge.svg and resources/graphics/folder.svg
 * Modified the resources/graphics/help/dpad_all.svg file to actually show all directions as available
 * Updated FFmpeg to 6.0, FreeType to 2.13.0, libgit2 to 1.6.4 and pugixml to 1.13 on Windows and macOS
-* Updated SDL to 2.28.0 on Windows, macOS and the Linux AppImage builds
+* Updated SDL to 2.28.1 on Windows, macOS and the Linux AppImage builds
 * (Windows) Updated curl to 8.1.2
-* (Windows) Changed all dependencies to not include version numbers in their directory names to simplify future updates
+* (Windows) Changed all dependencies to not include version numbers in their directory names to simplify future library updates
 * Updated LunaSVG to commit f924651b85cac47dbe15f51a4aa320461fc1d07b to fix a GCC 13 build error
 * Updated the MAME index files to include ROMs up to MAME version 0.256
 * Bundled the May 2023 release of the Mozilla TLS/SSL certificates

FAQ.md

@@ -102,7 +102,7 @@ ES-DE uses mostly the same system names as these other frontends, but there are
 
 ## Can ES-DE update itself automatically when a new release becomes available?
 
-ES-DE includes a check for new versions and will show a notification window on startup if there is a new release available for download. As a second step downloading of the new version will be implemented and on some platforms automatic updating will be added as well. It's however unlikely that automatic upgrading will be feasible for all package formats. The process to manually upgrade ES-DE is covered in the _Upgrading to a newer release_ section of the [User guide](USERGUIDE.md#upgrading-to-a-newer-release). If you find the update notification messages annoying you can change the frequency of update checks between _Always_, _Daily_, _Weekly_, _Monthly_ or _Never_ from the _Other settings_ menu.
+As of ES-DE 2.1.0 there is a built-in application updater that works with the Linux AppImage releases. And if using the AUR release then updates are handled via the operating system's package manager. Likewise if using RetroDECK, then ES-DE is updated as part of the overall RetroDECK Flatpak. For other package formats and operating systems only a version check and a notification window has been implemented, meaning the new release needs to be manually downloaded from the ES-DE website. The process to manually upgrade ES-DE is covered in the _Upgrading to a newer release_ section of the [User guide](USERGUIDE.md#upgrading-to-a-newer-release). If you find the update notification messages annoying you can change the frequency of update checks between _Always_, _Daily_, _Weekly_, _Monthly_ or _Never_ from the _Other settings_ menu.
 
 ## I can't find any game media links in the gamelist.xml files, where is this data stored?
 

INSTALL-DEV.md

@@ -1499,8 +1499,6 @@ These files include all systems supported by ES-DE and provide the following sor
 * Manufacturer, release year
 * Release year
 
-To use these es_systems_sorting.xml files, simply copy any of them to your custom_systems directory.
-
 ## es_find_rules.xml
 
 This file makes it possible to define rules for where to search for the emulator binaries and emulator cores.

ROADMAP.md

@@ -5,7 +5,6 @@ ES-DE is developed using an agile methodology so which features to include per r
 A more detailed breakdown can be found on the [Kanban](https://gitlab.com/es-de/emulationstation-de/-/boards) board, and for previous releases the [Changelog](CHANGELOG.md) contains all relevant details.
 
 **General functionality**
-* Game manual viewer (PDF documents)
 * RetroAchievements.org integration
 * "Time played" counter per game, similar to how it works in Steam
 * Bulk metadata editor
@@ -18,7 +17,6 @@ A more detailed breakdown can be found on the [Kanban](https://gitlab.com/es-de/
 
 **User interface**
 
-* Selection between light and dark color schemes for the menu system
 * Menu reorganization, possibly adding basic/advanced modes
 * Animated menu elements like switches and tick boxes
 * Simple file browsing component
@@ -30,7 +28,6 @@ A more detailed breakdown can be found on the [Kanban](https://gitlab.com/es-de/
 * Removal of legacy theme support
 
 **Scraper**
-* Scraping of game manuals
 * Checksum support for the scraper for exact searches and for determining when to overwrite files
 * Support for additional scraper services
 

USERGUIDE-DEV.md

@@ -2427,6 +2427,10 @@ Settings for the media viewer that is accessible from the gamelist views.
 
 Controls positioning of the navigation help prompts. The available options are _top_, _bottom_ or _disabled_.
 
+**Display media types**
+
+Whether the help prompts should include the media type of the currently viewed entry.
+
 **Keep videos running when viewing images**
 
 With this option enabled, the video will continue to run when viewing the images for the game. If disabling this setting, the video will stop immediately when browsing to the first image, and it will restart when navigating back to the video.
@@ -2961,7 +2965,7 @@ If a game video is available, then this will be played automatically when launch
 
 The following media can be displayed: _video, box cover, box back cover, title screen, screenshot_, _fan art_ and _miximage_.
 
-If the game has a downloaded PDF manual then you can view it by pressing the _up_ button which will change the media viewer to PDF viewing mode. To get back to displaying videos and images when in this mode, press the _down_ button. The navigation for this mode is identical to the game media mode.
+If the game has a downloaded PDF manual then you can view it by pressing the _up_ button which will change the media viewer to PDF viewing mode. To get back to displaying videos and images when in this mode, press the _down_ button. When in PDF viewing mode it's possible to zoom in and out using the shoulder buttons. When zoomed in, the left, right, up and down buttons will pan the view. So in order to re-enable page navigation either zoom out completely or reset the view by pressing the left or right trigger button.
 
 Pressing any other button than those mentioned above closes the media viewer.