Documentation update.

CHANGELOG.md

@@ -107,6 +107,7 @@ Many bugs have been fixed, and numerous features that were only partially implem
 * Large text sizes at higher resolutions (such as 4K) would crash the application as fixed-size texture buffers were used which weren't big enough to hold the larger font textures
 * Fixed a massive memory leak related to SVG images
 * Fixed an issue where SVG images would sometimes be cut off slightly on the right side (e.g. logos on the system view carousel)
+* The audio volume control did not detect if there was a new default audio device or if the audio volume had been changed outside ES-DE
 * The scraper didn't handle error conditions correctly
 * The metadata editor insisted that changes were made although nothing was updated
 * Sorting by number of players did not work properly for games with ranges such as 1-2 or 1-8

CONTRIBUTING.md

@@ -22,7 +22,7 @@ This plan is under constant review so expect it to change from time to time. Sti
 
 #### v1.1
 
-* Support for Raspberry Pi 4 with OpenGL ES 2.0 (Ubuntu and Raspberry Pi OS)
+* Support for Raspberry Pi 4 with OpenGL 2.1 (Ubuntu and Raspberry Pi OS)
 * Mix image generation based on screenshots, 3D boxes and marquee files (as in Skyscraper)
 * Improve full-screen support, remove the temporary full screen hacks
 * Proper game launching screen
@@ -38,7 +38,6 @@ This plan is under constant review so expect it to change from time to time. Sti
 * Checksum support for the scraper to verify each file before accepting/saving it
 * Web proxy support for the scraper
 * Add GLM library dependency for matrix and vector operations, decommissioning the built-in functions
-* Shader support for the OpenGL ES renderer
 * Add to Linux repositories, BSD ports collections etc.
 
 #### v1.3

INSTALL.md

@@ -134,6 +134,11 @@ The most common tool is Memcheck to check for memory leaks, which you run like t
 valgrind --tool=memcheck --leak-check=full --log-file=../valgrind_run_01 ./emulationstation
 ```
 
+There are numerous flags that can be used, for example this will also track reachable memory which could indicate further leaks:
+```
+valgrind --tool=memcheck --leak-check=full --track-origins=yes --show-reachable=yes --log-file=../valgrind_run_01 ./emulationstation
+```
+
 Another helpful tool is the Callgrind call-graph analyzer:
 ```
 valgrind --tool=callgrind --log-file=../valgrind_run_01 ./emulationstation

THEMES.md

@@ -274,14 +274,13 @@ There are seven different navigation sounds that can be configured. The names as
 on the example below.
 Starting EmulationStation with the --debug flag will provide feedback on whether any navigation sound elements were read from the theme set. If no navigation sound is provided by the theme, ES will use the bundled navigation sound file as a fallback. This is done per sound, so the theme could provide for example one or two custom sound files while using the bundled ES sounds for the other samples.
 
-
 Example debug output:
 ```
-Jul 12 11:28:58 Debug:  Sound::getFromTheme(): Looking for navigation sound tag <sound name="quicksysselect">.
+Jul 12 11:28:58 Debug:  NavigationSounds::loadThemeNavigationSounds(): Theme set includes navigation sound support, loading custom sounds
-Jul 12 11:28:58 Debug:  Sound::getFromTheme(): Tag found, ready to load theme sound file.
+Jul 12 11:28:58 Debug:  Sound::getFromTheme(): Looking for tag <sound name="systembrowse">
-Jul 12 11:28:58 Debug:  Sound::getFromTheme(): Looking for navigation sound tag <sound name="select">.
+Jul 12 11:28:58 Debug:  Sound::getFromTheme(): Tag found, ready to load theme sound file
-Jul 12 11:28:58 Debug:  Sound::getFromTheme(): Tag not found, using fallback sound file.
+Jul 12 11:28:58 Debug:  Sound::getFromTheme(): Looking for tag <sound name="quicksysselect">
-
+Jul 12 11:28:58 Debug:  Sound::getFromTheme(): Tag not found, using fallback sound file
 ```
 
 Example `navigationsounds.xml`, to be included from the main theme file:
@@ -425,7 +424,7 @@ or to specify only a portion of the value of a theme property:
 * `textlist name="gamelist"` - ALL
     - The gamelist.  `primaryColor` is for games, `secondaryColor` is for folders.  Left aligned by default.
 * `text name="gamelistInfo"` - ALL
-    - Displays the game count (all games as well as favorites), any applied filters, and an folder icon if a folder has been entered.
+    - Displays the game count (all games as well as favorites), any applied filters, and a folder icon if a folder has been entered. If this text is left aligned, the folder icon will be placed to the right of the other information, and if it's right aligned, the folder icon will be placed to the left. Left aligned by default.
 
 * Metadata
     * Labels
@@ -476,7 +475,7 @@ or to specify only a portion of the value of a theme property:
 * `textlist name="gamelist"` - ALL
     - The gamelist.  `primaryColor` is for games, `secondaryColor` is for folders.  Left aligned by default.
 * `text name="gamelistInfo"` - ALL
-    - Displays the game count (all games as well as favorites), any applied filters, and an folder icon if a folder has been entered.
+    - Displays the game count (all games as well as favorites), any applied filters, and a folder icon if a folder has been entered. If this text is left aligned, the folder icon will be placed to the right of the other information, and if it's right aligned, the folder icon will be placed to the left. Left aligned by default.
 
 * Metadata
     * Labels
@@ -537,7 +536,7 @@ or to specify only a portion of the value of a theme property:
 * `gridtile name="selected"` - ALL
     - See default gridtile description right above.
 * `text name="gamelistInfo"` - ALL
-    - Displays the game count (all games as well as favorites), any applied filters, and an folder icon if a folder has been entered.
+    - Displays the game count (all games as well as favorites), any applied filters, and a folder icon if a folder has been entered. If this text is left aligned, the folder icon will be placed to the right of the other information, and if it's right aligned, the folder icon will be placed to the left. Left aligned by default.
 
 * Metadata
     * Labels
@@ -654,7 +653,7 @@ Can be created as an extra.
 * `folderImage` - type: PATH.
     - The default image used for folders which doesn't have an image.
 * `imageSource` - type: STRING.
-    - Selects the image to display. `thumbnail` by default, can also be set to `image` or `marquee`.
+    - Selects the image to display. `thumbnail` by default, can also be set to `image`, `miximage`, `screenshot`, `cover`, `marquee` or `3dbox`. If selecting `image`, the media type `miximage` will be tried first, with fallback to `screenshot` and then `cover`.
 * `scrollDirection` - type: STRING.
     - `vertical` by default, can also be set to `horizontal`. Not that in `horizontal` mod, the tiles are ordered from top to bottom, then from left to right.
 * `centerSelection` - type: BOOLEAN.

USERGUIDE.md

@@ -105,7 +105,7 @@ Theme folder:
 gc
 ```
 
-Be aware that there will be a lot of directories created if using the template es_systems.cfg files bundled with the installation, so it may be a good idea to delete the ones you don't need. Deleting unnecessary directories also reduces the application startup time significantly as ES-DE would otherwise need to scan for game files for all these systems.
+Be aware that there will be a lot of directories created if using the template es_systems.cfg file bundled with the installation, so it may be a good idea to remove the ones you don't need. It's recommended to move them to another location to be able to use them later if more systems should be added. For example a directory called DISABLED could be created inside the ROMs folder (i.e. ~/ROMs/DISABLED) and all game system directories you don't need could be moved there. Doing this reduces the application startup time significantly as ES-DE would otherwise need to scan for game files for all these systems.
 
 ![alt text](images/current/es-de_ui_easy_setup.png "ES-DE Easy Setup")
 _This is the dialog shown if no game files were found. It lets you configure the ROM directory if you don't want to use the default one, and you can also generate the game systems directory structure. Note that the directory is the real physical path, and that your operating system may present this as a localized path if you are using a language other than English._
@@ -172,7 +172,7 @@ Also note that the Video view style requires that the theme supports it. If not,
 
 It's possible to manually set a specific gamelist view style in the UI settings entry of the main menu, but this is applied globally regardless of what media files are available per game system. The manual setting also overrides the theme-supported view styles which has the potential of making ES-DE very ugly indeed.
 
-In addition to the styles just described, there is a **Grid** view style as well, but as of ES-DE version 1.0 this is very limited and not recommended. Future versions may update this style to a more useful state.
+In addition to the styles just described, there is a **Grid** view style as well, but as of ES-DE version 1.0 this is highly experimental and its use is not recommended. Future versions will update this style to a more useful state.
 
 If the theme supports it, there's a gamelist information field displayed in the gamelist view, showing the number of games for the system (total and favorites) as well as a folder icon if a folder has been entered. When applying any filters to the gamelist, the game counter is replaced with the amount of games filtered, as in 'filtered / total games', e.g. '19 / 77'. If there are game entries in the filter result that are marked not to be counted as games, the number of such files will be indicated as 'filtered + filtered non-games / total games', for example '23 + 4 / 77' indicating 23 normal games, 4 non-games out of a total of 77. Due to this approach it's theoretically possible that the combined filtered game amount exceeds the number of counted games in the collection, for instance '69 + 11 / 77'. This is not considered a bug and is so by design. This gamelist information field functionality is specific to EmulationStation Desktop Edition so older themes will not support this.
 
@@ -801,6 +801,10 @@ The order in which to sort your gamelists. This can be overriden per game system
 
 Animation to play when opening the main menu or the game options menu. Can be set to _Scale-up, _Fade-in_ or _None_.
 
+**Blur background when menu is open** _(OpenGL renderer only)_
+
+This option will blur the background behind the menu slightly. Normally this can be left enabled, but if you have a really slow GPU, disabling this option may make the application feel a bit more responsive.
+
 **Display pillarboxes for gamelist videos**
 
 With this option enabled, there are black pillarboxes (and to a lesser extent letterboxes) displayed around videos with non-standard aspect ratios. This will probably be most commonly used for vertical arcade shooters, or for game systems that has a screen in portrait orientation. For wider than normal videos, letterboxes are added, but this is quite rare compared to videos in portrait orientation. This option looks good with some theme sets such as rbsimple-DE, but on others it may be more visually pleasing to disable it. On less wide displays such as those in 4:3 aspect ratio this option should probably be disabled as it may otherwise add quite excessive letterboxing.
@@ -915,7 +919,7 @@ This will display an overlay in the upper left corner, showing the game name and
 
 **Render scanlines** _(OpenGL renderer only)_
 
-Whether to use a shader to render scanlines for the videos.
+Whether to use a shader to render scanlines for the videos. Be aware that this is quite demanding for the GPU.
 
 **Render blur** _(OpenGL renderer only)_
 
@@ -928,7 +932,7 @@ General sound settings.
 
 **System volume** _(Linux and Windows only)_
 
-As the name implies, this sets the overall system volume and not the volume specifically for ES-DE. Be aware that the volume change is applied only after leaving the sound settings menu.
+As the name implies, this sets the overall system volume and not the volume specifically for ES-DE. Note that the volume change is applied only after leaving the sound settings menu.
 
 **Navigation sounds volume**