Documentation update

CHANGELOG.md

@@ -10,12 +10,15 @@
 * 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
 * Placing an es_find_rules.xml file in custom_systems will now complement rather than override the bundled file
 * Added the SameBoy RetroArch core as an alternative emulator for the sgb system
@@ -26,6 +29,7 @@
 * (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
 * Removed the experimental status for the theme downloader
 * Improved resilience to buggy controller drivers which could previously crash the application (mostly relevant for macOS)
 * Removed the custom SDL patch for the Linux AppImage builds that prevented the device virtual keyboard from being automatically displayed
@@ -47,6 +51,7 @@
 * (Windows) The log output time stamp was missing in es_log.txt when built using MinGW
 * The scraper auto-retry functionality was triggered when scraping manually
 * TextureResource::initFromPixels() was not setting the source size correctly
+* The fallback to argv[0] in FileSystemUtil::setExePath() was not working correctly
 
 ## Version 2.0.1
 

FAQ.md

@@ -18,7 +18,7 @@ ES-DE runs on Windows, macOS and BSD Unix as well as on multiple Linux distribut
 
 ## What is the relationship between ES-DE and EmuDeck?
 
-ES-DE and [EmuDeck](http://www.emudeck.com) are completely separate projects, but we collaborate to give the best possible user experience. EmuDeck is an installer that downloads emulators and applies configuration to these, and it can also download and install ES-DE. EmuDeck is not needed to run ES-DE, but on the Steam Deck it provides a convenient way of setting up an emulator environment. It's a good idea to read the _Specific notes for Steam Deck_ section of the [User guide](USERGUIDE.md#specific-notes-for-steam-deck) if ES-DE has been installed using EmuDeck.
+[EmuDeck](http://www.emudeck.com) is an installer that installs ES-DE and a number of emulators. It's a completely separate project and it's not required in order to use ES-DE.
 
 ## What is the relationship between ES-DE and RetroDECK?
 

USERGUIDE-DEV.md

@@ -133,13 +133,20 @@ _This is the dialog shown if no game files were found. It lets you configure the
 
 ## Upgrading to a newer release
 
-**Note:** Before upgrading ES-DE, make sure that you have not made any system customizations anywhere in the installation directory structure as these files will be overwritten during the upgrade process. All customizations should go into ~/.emulationstation/custom_systems/ as described elsewhere in this guide. None of the upgrade methods mentioned below will ever touch any files inside your .emulationstation directory.
+**Note:** Before upgrading ES-DE, make sure that you have not made any system customizations anywhere in the installation directory structure as these files will be overwritten during the upgrade process. All customizations should go into ~/.emulationstation/custom_systems/ as described elsewhere in this guide. None of the upgrade methods mentioned below will ever touch any files inside your .emulationstation directory tree.
 
-It's possible that the new ES-DE release adds support for more systems and emulators compared to the version you previously had installed, so you may want to recreate the ROMs directory tree after you've completed the installation. The easiest way to do that is to start ES-DE once with the _--create-system-dirs_ command line option which will create any missing system directories and also update the systems.txt and systeminfo.txt files. This is a safe operation as it will not overwrite or delete your game files.
+As of ES-DE 2.1.0 there is a built-in application updater that can update the Linux AppImage releases. Later on this will hopefully be expanded to cover more package formats and operating systems. Its use is straightforward, just follow the on-screen instructions. The old AppImage file is retained by renaming it, adding the text _OLD_ and its version to the filename, for example `EmulationStation-DE-x64_SteamDeck.AppImage_OLD_2.1.0`
 
-**Linux .deb and .rpm packages**
+Note that the updater will keep whatever filename you had for your running AppImage file, which could potentially be confusing if you for example added version information to the filename. It's always recommend to keep the default AppImage filenames, i.e. `EmulationStation-DE-x64.AppImage` and `EmulationStation-DE-x64_SteamDeck.AppImage`
 
-Upgrading ES-DE using these packages is very straightforward, just run them through the package manager of your operating system and the process should be entirely automatic.
+Regardless of package format and operating system it's a good idea to update the ROMs directory tree after upgrading to a new version. It's possible that the new ES-DE release adds support for more systems and emulators compared to the version you previously had installed. The easiest way to do this is to start ES-DE once with the _--create-system-dirs_ command line option which will create any missing system directories and also update the systems.txt and systeminfo.txt files. This is a safe operation as it will not overwrite or delete your game files.
+
+![alt text](images/es-de_application_updater.png "ES-DE Application Updater")
+_This is what the application updater looks like when the update process has been completed._
+
+**Linux .deb packages**
+
+Upgrading ES-DE using this package type is very straightforward, just run it through the package manager of your operating system and the process should be entirely automatic.
 
 **Linux AUR**
 
@@ -147,7 +154,7 @@ AUR upgrades should be automatically handled via your package manager and it sho
 
 **Linux AppImage**
 
-As the ES-DE AppImages always retain their filenames between stable releases you only need to replace the previous AppImage with the new one and you're done. Just make sure to set the new AppImage as executable so it can be launched.
+Use the built-in application updater as described above.
 
 **macOS**
 
@@ -2460,6 +2467,10 @@ Options specific to the slideshow screensaver.
 
 For how long to display images before changing to the next game. Allowed range is between 2 and 120 seconds in 2-second increments. The default value is 10 seconds.
 
+**Only include favorite games**
+
+Whether to only include games marked as favorites.
+
 **Stretch images to screen resolution**
 
 This will fill the entire screen surface but will probably break the aspect ratio of the image.
@@ -2492,6 +2503,10 @@ Options specific to the video screensaver.
 
 For how long to play videos before changing to the next game. Allowed range is between 0 and 120 seconds in 2-second increments. If set to 0 (which is the default value), the next game will be selected after the entire video has finished playing. If set to a higher value than the length of a game video, it will loop until reaching the swap time.
 
+**Only include favorite games**
+
+Whether to only include games marked as favorites.
+
 **Stretch videos to screen resolution**
 
 This will fill the entire screen surface but will probably break the aspect ratio of the video.