Documentation update.

CHANGELOG.md

@@ -158,10 +158,16 @@ v1.2 maintenance release.
 * Added experimental support for PCSX2 Qt standalone for the ps2 system on Unix
 * Added ScummVM standalone as an alternative emulator for the scummvm system
 * Added the Kronos RetroArch core as an alternative emulator for the arcade and mame systems
+* Added connection and transfer timeout settings to the scraper (not configurable via the GUI)
+* Added an es_log.txt entry when the "Only show ROMs from gamelist.xml files" setting is enabled
+* Passing the --ignore-gamelist command line option now immediately disables the ParseGamelistOnly setting
 * (macOS) Improved Apple compliance for the Info.plist file
+* (rbsimple-DE) Added console graphics for the psvita system
 
 ### Bug fixes
 
+* The IgnoreGamelist setting was saved to es_settings.xml although it shouldn't
+
 ## Version 1.2.5
 
 **Release date:** 2022-06-22

INSTALL-DEV.md

@@ -77,7 +77,7 @@ Use pkg to install the dependencies:
 pkg install llvm-devel git pkgconf cmake sdl2 ffmpeg freeimage pugixml
 ```
 
-Clang/LLVM and cURL should already be included in the base OS installation.
+Clang/LLVM and curl should already be included in the base OS installation.
 
 **NetBSD**
 
@@ -95,7 +95,7 @@ Use pkg_add to install the dependencies:
 pkg_add clang-tools-extra cmake pkgconf sdl2 ffmpeg freeimage
 ```
 
-In the same manner as for FreeBSD, Clang/LLVM and cURL should already be installed by default.
+In the same manner as for FreeBSD, Clang/LLVM and curl should already be installed by default.
 
 Pugixml does exist in the package collection but somehow this version is not properly detected by CMake, so you need to compile this manually as well:
 
@@ -1091,10 +1091,47 @@ For the following options, the es_settings.xml file is immediately updated/saved
 ```
 --display
 --max-vram
+--gamelist-only
 --show-hidden-files
 --show-hidden-games
 ```
 
+As well, passing the option --ignore-gamelist will disable the ParseGamelistOnly setting controlled by --gamelist-only and immediately save the es_settings.xml file. If passing both the --ignore-gamelist and --gamelist-only parameters then --ignore-gamelist will take precedence and --gamelist-only will be ignored.
+
+The --ignore-gamelist option is only active during the program session and is not saved to es_settings.xml. But --gamelist-only is however saved, so in order to return to the normal operation of parsing the gamelist.xml files after starting ES-DE with the --gamelist-only option, you will need to disable the setting _Only show ROMs from gamelist.xml files_ in the _Other settings_ menu (or manually change the ParseGamelistOnly entry in es_settings.xml).
+
+## Settings not configurable via the GUI
+
+There are some settings which are not configurable via the GUI as modifying these should normally not be required. To change these, edit the es_settings.xml file directly.
+
+**DebugSkipInputLogging**
+
+Enabling this will skip all input event logging (button and key presses).
+
+**LottieMaxFileCache**
+
+Sets the maximum per-file animation cache for Lottie animations. Minimum value is 0 MiB and maximum value is 1024 MiB. Default value is 150 MiB.
+
+**LottieMaxTotalCache**
+
+Sets the maximum total animation cache for Lottie animations. Minimum value is 0 MiB and maximum value is 4096 MiB. Default value is 1024 MiB.
+
+**OpenGLVersion**
+
+If using the regular desktop OpenGL renderer, the allowed values are 3.3 (the default), 4.2 or 4.6. If using the OpenGL ES renderer, the allowed values are 3.0 (the default), 3.1 or 3.2.
+
+**ScraperConnectionTimeout**
+
+Sets the server connection timeout for the scraper. Minimum value is 0 seconds (infinity) and maximum value is 300 seconds. Default value is 60 seconds.
+
+**ScraperTransferTimeout**
+
+Sets the transfer timeout per HTTPS request (i.e. per media file). Minimum value is 0 seconds (infinity) and maximum value is 300 seconds. Default value is 120 seconds.
+
+**UIMode_passkey**
+
+The passkey to use to change from the _Kiosk_ or _Kid_ UI modes to the _Full_ UI mode.
+
 ## es_systems.xml
 
 The es_systems.xml file contains the game systems configuration data for ES-DE, written in XML format. This defines the system name, the full system name, the ROM path, the allowed file extensions, the launch command, the platform (for scraping) and the theme to use.

INSTALL.md

@@ -99,7 +99,7 @@ If building with the optional VLC video player, the following package is also ne
 pkg install vlc
 ```
 
-Clang/LLVM and cURL should already be included in the base OS installation.
+Clang/LLVM and curl should already be included in the base OS installation.
 
 **NetBSD**
 
@@ -127,7 +127,7 @@ If building with the optional VLC video player, the following package is also ne
 pkg_add vlc
 ```
 
-In the same manner as for FreeBSD, Clang/LLVM and cURL should already be installed by default.
+In the same manner as for FreeBSD, Clang/LLVM and curl should already be installed by default.
 
 Pugixml does exist in the package collection but somehow this version is not properly detected by CMake, so you need to compile this manually as well:
 
@@ -812,7 +812,7 @@ FFmpeg (choose the n4.4 package with win64-gpl-shared in the filename, the snaps
 FreeImage (binary distribution) \
 [https://sourceforge.net/projects/freeimage](https://sourceforge.net/projects/freeimage)
 
-cURL (Windows 64 bit binary, select the MinGW version even if using MSVC) \
+curl (Windows 64 bit binary, select the MinGW version even if using MSVC) \
 [https://curl.haxx.se/download.html](https://curl.haxx.se/download.html)
 
 SDL2 (development libraries, MinGW or VC/MSVC) \
@@ -905,7 +905,7 @@ As there is no standardized include directory structure in Windows, you need to
 
 Make a directory in your build environment tree, for instance under `C:\Programming\include`
 
-Copy the include files for cURL, FFmpeg, FreeImage, FreeType, GLEW, pugixml, SDL2 and optionally VLC to this directory.
+Copy the include files for curl, FFmpeg, FreeImage, FreeType, GLEW, pugixml, SDL2 and optionally VLC to this directory.
 
 You may need to create the SDL2 directory manually and copy the header files there.
 

USERGUIDE-DEV.md

@@ -959,14 +959,14 @@ On Windows the Vita3K installation is straightforward, but on Linux you may need
 
 Although a macOS release of Vita3K seems to be in the works this does not seem to be readily available for download so there is currently no macOS support for this system in ES-DE.
 
-After you've installed Vita3K, add your games to the GUI and make sure that they work correctly when launched from inside the emulator.
+After you've installed Vita3K, add your games via the GUI and make sure that they work correctly when launched from inside the emulator.
 
 To add an installed game to ES-DE, create an empty file in `~/ROMs/psvita` and name it as the game name followed by the .psvita file extension, such as the following:
 ```
 ~/ROMs/psvita/WipEout 2048.psvita
 ```
 
-Then add the game Title ID to this file. This ID can be found inside the Vita3K GUI, in the _Title ID_ column. For example the game _WipEout 2048_ has an ID that is _PCSF00007_. So simply add the string PCSF00007 to the `WipEout 2048.psvita` file and the setup for this game is complete.
+Then add the game Title ID to this file. This ID can be found inside the Vita3K GUI, in the _Title ID_ column. For example the game _WipEout 2048_ has an ID that is PCSF00007. So simply add the string PCSF00007 to the `WipEout 2048.psvita` file and the setup for this game is complete.
 
 Game launching and scraping should now work fine in ES-DE.