Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-25 07:35:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-01-22 22:04:53 +01:00
parent 098cde5f98
commit 906450f82e
3 changed files with 20 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CHANGELOG.md
View file

@ -17,6 +17,7 @@
* Set the option "Scrape actual folders" as enabled by default and moved it higher up in the scraper options menu * Set the option "Scrape actual folders" as enabled by default and moved it higher up in the scraper options menu
* Added the ability to set a manual sortname specifically for custom collections using the metadata editor * Added the ability to set a manual sortname specifically for custom collections using the metadata editor
* When scraping in semi-automatic mode, horizontal scrolling of long game names are no longer reset when automatically selecting the result * When scraping in semi-automatic mode, horizontal scrolling of long game names are no longer reset when automatically selecting the result
* Reduced CPU usage significantly when a menu is open by not rendering the bottom of the stack
* Added an OpenGL ES 2.0 renderer (borrowed from the RetroPie fork of EmulationStation) * Added an OpenGL ES 2.0 renderer (borrowed from the RetroPie fork of EmulationStation)
* Added logging of the display refresh rate on startup * Added logging of the display refresh rate on startup
* Added a color model conversion shader for converting from BGRA to RGBA * Added a color model conversion shader for converting from BGRA to RGBA
@ -25,9 +26,14 @@
* On Windows all dependencies were moved in-tree to the "external" directory to greatly simplify the build environment * On Windows all dependencies were moved in-tree to the "external" directory to greatly simplify the build environment
* Large refactoring to improve thread safety and improve singleton pattern usage * Large refactoring to improve thread safety and improve singleton pattern usage
* Moved all Platform functions to the utility namespace instead of using the global namespace * Moved all Platform functions to the utility namespace instead of using the global namespace
* Renamed GameList to Gamelist throughout the codebase * Changed all occurances of "GameList" to "Gamelist" throughout the codebase
* Renamed Gamelist.cpp and Gamelist.h to GamelistFileParser.cpp and GamelistFileParser.h and moved it to its own namespace instead of the global namespace * Removed a huge amount of unnecessary Window* function parameters throughout the codebase
* Renamed GuiGameScraper.cpp and GuiGameScraper.h to GuiScraperSingle.cpp and GuiScraperSingle.h * Refactored the six gamelist classes into two new classes; GamelistBase and GamelistView
* Rewrote the gamelist logic to handle an arbitrary amount of components per type and split the legacy code into a separate file
* Renamed Gamelist.cpp to GamelistFileParser.cpp and moved it to its own namespace instead of using the global namespace
* Renamed GuiGameScraper.cpp to GuiScraperSingle.cpp
* Renamed SystemScreensaver.cpp to Screensaver.cpp
* Moved UIModeController.cpp from the es-app/views directory to es-app
* Set the clang-format option SpaceBeforeCpp11BracedList to true and reformatted the codebase * Set the clang-format option SpaceBeforeCpp11BracedList to true and reformatted the codebase
* Removed some unnecessary typedefs and replaced the remaining ones with the more modern "using" keyword * Removed some unnecessary typedefs and replaced the remaining ones with the more modern "using" keyword
* Removed the deprecated VideoVlcComponent * Removed the deprecated VideoVlcComponent

2
INSTALL-DEV.md
View file

@ -1048,7 +1048,7 @@ You can use **--help** or **-h** to view the list of command line options, as sh
--max-vram [size] Max VRAM to use (in mebibytes) before swapping --max-vram [size] Max VRAM to use (in mebibytes) before swapping
--no-splash Don't show the splash screen during startup --no-splash Don't show the splash screen during startup
--gamelist-only Skip automatic game ROM search, only read from gamelist.xml --gamelist-only Skip automatic game ROM search, only read from gamelist.xml
--ignore-gamelist Ignore the gamelist files (useful for troubleshooting) --ignore-gamelist Ignore the gamelist.xml files (useful for troubleshooting)
--show-hidden-files Show hidden files and folders --show-hidden-files Show hidden files and folders
--show-hidden-games Show hidden games --show-hidden-games Show hidden games
--force-full Force the UI mode to Full --force-full Force the UI mode to Full

20
USERGUIDE-DEV.md
View file

@ -155,7 +155,7 @@ _This is the dialog shown if no game files were found. It lets you configure the
## Disabling game systems ## Disabling game systems
The way ES-DE works is that it will always try to load any system for which there are game files available, so to disable a system it needs to be hidden from ES-DE. This is easily accomplished by renaming the game directory to something that is not recognized, for example changing `~/ROMs/c64` to `~/ROMs/c64_DISABLED`. Another approach is to create a subdirectory named DISABLED (or whatever name you prefer that is not matching a supported system) in the ROMs directory and move the game folder there, such as `~/ROMs/DISABLED/c64`. This makes it easy to disable and re-enable game systems in ES-DE. Note that the gamelist and any game media files are retained while the system is disabled so this is an entirely safe thing to do. The way ES-DE works is that it will always try to load any system for which there are game files available, so to disable a system it needs to be hidden from ES-DE. This is easily accomplished by renaming the game directory to something that is not recognized, for example changing `~/ROMs/c64` to `~/ROMs/c64_DISABLED`. Another approach is to create a subdirectory named DISABLED (or whatever name you prefer that is not matching a supported system) in the ROMs directory and move the game folder there, such as `~/ROMs/DISABLED/c64`. This makes it easy to disable and re-enable game systems in ES-DE. Note that the gamelist.xml file and any game media files are retained while the system is disabled so this is an entirely safe thing to do.
## Using the Steam release of RetroArch ## Using the Steam release of RetroArch
@ -1230,7 +1230,7 @@ Submenu containing all the settings for the media viewer. These are described in
Submenu containing all the settings for the screensaver. These are described in detailed below. Submenu containing all the settings for the screensaver. These are described in detailed below.
**Blur background when menu is open** _(OpenGL renderer only)_ **Blur background when menu is open**
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. 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.
@ -1238,7 +1238,7 @@ This option will blur the background behind the menu slightly. Normally this can
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. 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.
**Render scanlines for gamelist videos** _(OpenGL renderer only)_ **Render scanlines for gamelist videos**
Whether to use a shader to render scanlines for videos in the gamelist view. The effect is usually pretty subtle as the video is normally renderered in a limited size in the GUI and the scanlines are sized relative to the video window size. Whether to use a shader to render scanlines for videos in the gamelist view. The effect is usually pretty subtle as the video is normally renderered in a limited size in the GUI and the scanlines are sized relative to the video window size.
@ -1306,15 +1306,15 @@ With this option enabled, the video will continue to run when viewing the images
This will fill the entire screen surface but will probably break the aspect ratio of the video. This will fill the entire screen surface but will probably break the aspect ratio of the video.
**Render scanlines for videos** _(OpenGL renderer only)_ **Render scanlines for videos**
Whether to use a shader to render scanlines for the videos. Be aware that this is quite demanding for the GPU. Whether to use a shader to render scanlines for the videos. Be aware that this is quite demanding for the GPU.
**Render blur for videos** _(OpenGL renderer only)_ **Render blur for videos**
Whether to use a shader to render a slight horizontal blur which somewhat simulates a well-used CRT monitor. Be aware that this is quite demanding for the GPU. Whether to use a shader to render a slight horizontal blur which somewhat simulates a well-used CRT monitor. Be aware that this is quite demanding for the GPU.
**Render scanlines for screenshots and titles** _(OpenGL renderer only)_ **Render scanlines for screenshots and titles**
Whether to use a shader to render scanlines for the screenshot and title screen images. Whether to use a shader to render scanlines for the screenshot and title screen images.
@ -1350,7 +1350,7 @@ This will fill the entire screen surface but will probably break the aspect rati
This will display an overlay in the upper left corner, showing the game name and the game system name. A star symbol following the game name indicates that it's flagged as a favorite. This will display an overlay in the upper left corner, showing the game name and the game system name. A star symbol following the game name indicates that it's flagged as a favorite.
**Render scanlines** _(OpenGL renderer only)_ **Render scanlines**
Whether to use a shader to render scanlines for the images. Whether to use a shader to render scanlines for the images.
@ -1382,11 +1382,11 @@ This will fill the entire screen surface but will probably break the aspect rati
This will display an overlay in the upper left corner, showing the game name and the game system name. A star symbol following the game name indicates that it's flagged as a favorite. This will display an overlay in the upper left corner, showing the game name and the game system name. A star symbol following the game name indicates that it's flagged as a favorite.
**Render scanlines** _(OpenGL renderer only)_ **Render scanlines**
Whether to use a shader to render scanlines for the videos. Be aware that this is quite demanding for the GPU. 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)_ **Render blur**
Whether to use a shader to render a slight horizontal blur which somewhat simulates a well-used CRT monitor. Be aware that this is quite demanding for the GPU. Whether to use a shader to render a slight horizontal blur which somewhat simulates a well-used CRT monitor. Be aware that this is quite demanding for the GPU.
@ -2084,7 +2084,7 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
| pokemini | Nintendo Pokémon Mini | PokeMini | | No | | | pokemini | Nintendo Pokémon Mini | PokeMini | | No | |
| ports | Ports | N/A | | No | Shell/batch script in separate folder (possibly combined with game data) | | ports | Ports | N/A | | No | Shell/batch script in separate folder (possibly combined with game data) |
| ps2 | Sony PlayStation 2 | PCSX2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 **(Standalone)** [UW] | Yes | | | ps2 | Sony PlayStation 2 | PCSX2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 **(Standalone)** [UW] | Yes | |
| ps3 | Sony PlayStation 3 | RPCS3 **(Standalone)** [UW*] | | Yes | In separate folder (one folder per game with complete file structure retained, renamed to the .ps3dir extension) | | ps3 | Sony PlayStation 3 | RPCS3 **(Standalone)** [UMW*] | | Yes | In separate folder (one folder per game with complete file structure retained, renamed to the .ps3dir extension) |
| ps4 | Sony PlayStation 4 | _Placeholder_ | | | | | ps4 | Sony PlayStation 4 | _Placeholder_ | | | |
| psp | Sony PlayStation Portable | PPSSPP | | | | | psp | Sony PlayStation Portable | PPSSPP | | | |
| psvita | Sony PlayStation Vita | _Placeholder_ | | | | | psvita | Sony PlayStation Vita | _Placeholder_ | | | |