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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2023-05-11 19:23:17 +02:00
parent 9e6cf91797
commit 085ac4c49b
5 changed files with 23 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CHANGELOG.md
View file

@ -1,27 +1,30 @@
# EmulationStation Desktop Edition (ES-DE) - Changelog # EmulationStation Desktop Edition (ES-DE) - Changelog
[[_TOC_]]
## Version 2.1.0 (in development) ## Version 2.1.0 (in development)
**Release date:** TBD **Release date:** TBD
### Detailed list of changes ### Detailed list of changes
* Added support for changing between light and dark color schemes for the menu system
* Added an option to scrape game manuals using ScreenScraper
* Changed the scraper auto-retry functionality to never run on non-recoverable errors such as insufficient file permissions
* Added support for a dedicated es_systems_sorting.xml file to change systems sorting without having to modify es_systems.xml * 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 * Placing an es_find_rules.xml file in custom_systems will now complement rather than override the bundled file
* Added support for changing between light and dark color schemes for the menu system
* Added the SameBoy RetroArch core as an alternative emulator for the sgb system * Added the SameBoy RetroArch core as an alternative emulator for the sgb system
* Added the .sh file extension to the ags system on Unix and macOS and set the %STARTDIR% variable to the game directory * Added the .sh file extension to the ags system on Unix and macOS and set the %STARTDIR% variable to the game directory
* (Linux) Added "AppImage (Suspend ES-DE)" and "AppImage (Keep ES-DE running)" as alternative emulators for the windows system * (Linux) Added "AppImage (Suspend ES-DE)" and "AppImage (Keep ES-DE running)" as alternative emulators for the windows system
* (Linux) Added the .AppImage file extension to the windows system * (Linux) Added the .AppImage file extension to the windows system
* (Linux) Added support for the official Citra AppImage release * (Linux) Added support for the official Citra AppImage release
* Removed the experimental status for the theme downloader * Removed the experimental status for the theme downloader
* Improved resilience to buggy controller drivers which would sometimes crash the application (mostly relevant for macOS) * Improved resilience to buggy controller drivers which could previously crash the application (mostly relevant for macOS)
* Updated LunaSVG to commit f924651b85cac47dbe15f51a4aa320461fc1d07b to fix a GCC 13 build error
* Changed the default OpenGL version from 4.6 to 3.3 when building for RetroDECK * Changed the default OpenGL version from 4.6 to 3.3 when building for RetroDECK
### Bug fixes ### Bug fixes
* The scraper auto-retry functionality was triggered when scraping manually
## Version 2.0.1 ## Version 2.0.1
**Release date:** 2023-04-23 **Release date:** 2023-04-23

1
ROADMAP.md
View file

@ -58,6 +58,7 @@ A more detailed breakdown can be found on the [Kanban](https://gitlab.com/es-de/
* Scraping of game manuals and maps plus a viewer for these (with PDF and raster image support) * Scraping of game manuals and maps plus a viewer for these (with PDF and raster image support)
* Support for additional scraper services * Support for additional scraper services
* Checksum support for the scraper for exact searches and for determining when to overwrite files * Checksum support for the scraper for exact searches and for determining when to overwrite files
* _Selection between light and dark color schemes for the menu system_
* RetroAchievements.org integration * RetroAchievements.org integration
#### v2.2 #### v2.2

4
THEMES-DEV.md
View file

@ -133,9 +133,9 @@ Note that the legacy theme engine had quite inaccurate text sizing and font rend
* The defined line spacing was not always applied for automatically sized text elements * The defined line spacing was not always applied for automatically sized text elements
* Font sizes were rounded to integers, leading to imprecise text sizing across different resolutions (the rounding was also done incorrectly) * Font sizes were rounded to integers, leading to imprecise text sizing across different resolutions (the rounding was also done incorrectly)
## System metadata and logos repositories ## System metadata and logo repositories
There are two useful repositories hosted by the ES-DE project that provide system metadata and system logotypes. These greatly simplifies the work of adding support for all systems that ES-DE supports. There are two useful repositories hosted by the ES-DE project that provide system metadata and system logotypes. This greatly simplifies the work of adding support for all systems that ES-DE supports.
**Metadata** **Metadata**

4
THEMES.md
View file

@ -131,9 +131,9 @@ Note that the legacy theme engine had quite inaccurate text sizing and font rend
* The defined line spacing was not always applied for automatically sized text elements * The defined line spacing was not always applied for automatically sized text elements
* Font sizes were rounded to integers, leading to imprecise text sizing across different resolutions (the rounding was also done incorrectly) * Font sizes were rounded to integers, leading to imprecise text sizing across different resolutions (the rounding was also done incorrectly)
## System metadata and logos repositories ## System metadata and logo repositories
There are two useful repositories hosted by the ES-DE project that provide system metadata and system logotypes. These greatly simplifies the work of adding support for all systems that ES-DE supports. There are two useful repositories hosted by the ES-DE project that provide system metadata and system logotypes. This greatly simplifies the work of adding support for all systems that ES-DE supports.
**Metadata** **Metadata**

12
USERGUIDE-DEV.md
View file

@ -1921,6 +1921,7 @@ Here's an overview of what's supported when using these scrapers:
| 3D boxes | Yes | No | | 3D boxes | Yes | No |
| Fan art | Yes | Yes | | Fan art | Yes | Yes |
| Physical media | Yes | No | | Physical media | Yes | No |
| Game manuals (PDF) | Yes | No |
The category **Other game metadata** includes Description, Release date, Developer, Publisher, Genre and Players. The category **Other game metadata** includes Description, Release date, Developer, Publisher, Genre and Players.
@ -2000,6 +2001,7 @@ The media directories per game system are:
* backcovers * backcovers
* covers * covers
* fanart * fanart
* manuals
* marquees * marquees
* miximages * miximages
* physicalmedia * physicalmedia
@ -2138,6 +2140,10 @@ Images of cartridges, diskettes, tapes, CD-ROMs etc. that were used to distribut
Fan art. These can get quite large so if you don't need them then disable this option to speed up the scraping process. Fan art. These can get quite large so if you don't need them then disable this option to speed up the scraping process.
**Game manuals** _(ScreenScraper only)_
Manuals in PDF format. Note that these files can be quite large.
#### Miximage settings #### Miximage settings
These are the settings for the miximage generator, which can either be run from the scraper (single-game scraper or multi-scraper) or from the offline generator. The miximage combines the screenshot, marquee, box/cover and physical media images to make a composite picture that is displayed in the gamelist view. There are various settings for the generator. These are the settings for the miximage generator, which can either be run from the scraper (single-game scraper or multi-scraper) or from the offline generator. The miximage combines the screenshot, marquee, box/cover and physical media images to make a composite picture that is displayed in the gamelist view. There are various settings for the generator.
@ -2212,7 +2218,7 @@ Multiple languages are supported by ScreenScraper, and this affects translations
**Automatic retries on error** **Automatic retries on error**
How many times to automatically retry scraping if an error is encountered, from 0 to 10. How many times to automatically retry scraping if an error is encountered, from 0 to 10. Note that this is only applied when running in automatic or semi-automatic mode and not when for instance using the single-game scraper. It also doesn't apply to non-recoverable errors such as insufficient permissions or if the disk is full.
**Retry attempt timer** **Retry attempt timer**
@ -2310,6 +2316,10 @@ If set to _None_, the system view will be displayed. Any other value will jump t
The order in which to sort your gamelists. This can be overriden per game system using the gamelist options menu, but that override will only be persistent during the application session. The _System_ sorting can not be selected here as it's only applicable to collection systems. The order in which to sort your gamelists. This can be overriden per game system using the gamelist options menu, but that override will only be persistent during the application session. The _System_ sorting can not be selected here as it's only applicable to collection systems.
**Menu color scheme**
Provides a selection between a _Light_ and a _Dark_ color scheme. This will affect the entire menu system as well as the launch screen.
**Menu opening effect** **Menu opening effect**
Animation to play when opening the main menu or the gamelist options menu. Also sets the animation for the game launch screen. Can be set to _Scale-up_ or _None_. Animation to play when opening the main menu or the gamelist options menu. Also sets the animation for the game launch screen. Can be set to _Scale-up_ or _None_.