From 9fa527479288ec7dd74b06d4081f75a1150cd408 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Sun, 30 Jul 2023 19:43:04 +0200 Subject: [PATCH] Documentation update --- CHANGELOG.md | 7 +++++++ INSTALL-DEV.md | 2 +- THEMES-DEV.md | 12 ++++++------ USERGUIDE-DEV.md | 28 ++++++---------------------- 4 files changed, 20 insertions(+), 29 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 00a8152e6..ff7fee72f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,17 +8,22 @@ ### Detailed list of changes +* Completely removed support for legacy EmulationStation themes +* Removed the "Legacy gamelist view style" and "Legacy theme transitions" settings +* Removed the "Display pillarboxes for gamelist videos" and "Render scanlines for gamelist videos" settings * Added support for pasting text into the application (when a text input field is focused) * Added support for using most characters (including multi-byte Unicode characters) in custom collection names * Added a new Utilities menu to the main menu * Added an entry to the Utilities menu for rescanning the ROM directory * Added a utility for removing orphaned data (game media, gamelist entries and custom collection entries) * Added ares standalone as an alternative emulator for the gamegear, gb, gba, gbc and satellaview systems +* Changed the "no games" dialog to no longer save the ROM directory to es_settings.xml if its value hasn't changed * When editing custom collections with really long names, the "Y" helpsystem text now gets abbreviated * Removed Linux DEB package support from ApplicationUpdater as these packages are no longer provided * Changed ComponentList to fixed row heights which fixed many alignment issues * Improved the layout for the scraper and theme downloader to look more consistent across different display aspect ratios * Made the miximage offline generator GUI sizing more consistent across different display aspect ratios +* Removed the es_log.txt entry when an es_systems.cfg legacy systems configuration file was found on startup * Improved menu system font rendering on GPUs without proper texture filtering support * Added theme support for the "manual" metadata type for the text element * Replaced a number of homecooked functions in FileSystemUtil with those from the C++ standard library @@ -28,6 +33,8 @@ ### Bug fixes +* Directories interpreted as files entries could not be removed from custom collections +* (Windows) If the ROMDirectory setting had a value then all custom collection files contained absolute paths instead of relative paths * (Windows) Wide string conversions were not done correctly which caused issues when filenames contained 4-byte Unicode characters * (Windows) Attempting to capitalize multi-byte Unicode strings crashed the application if built using the MSVC compiler * The camera offset in ComponentList was not correctly calculated when reaching the bottom of a list diff --git a/INSTALL-DEV.md b/INSTALL-DEV.md index c16dbbcc3..87fbf20fd 100644 --- a/INSTALL-DEV.md +++ b/INSTALL-DEV.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) v2.1 (development version) - Building and advanced configuration +# EmulationStation Desktop Edition (ES-DE) v2.2 (development version) - Building and advanced configuration This document is only relevant for the current ES-DE development version, if you would like to see the documentation for the latest stable release, refer to [INSTALL.md](INSTALL.md) instead. diff --git a/THEMES-DEV.md b/THEMES-DEV.md index 9a17b0ba7..308683385 100644 --- a/THEMES-DEV.md +++ b/THEMES-DEV.md @@ -1,4 +1,4 @@ -# EmulationStation Desktop Edition (ES-DE) v2.1 (development version) - Themes +# EmulationStation Desktop Edition (ES-DE) v2.2 (development version) - Themes **Note:** This document is only relevant for the current ES-DE development version, if you would like to see the documentation for the latest stable release, refer to [THEMES.md](THEMES.md) instead. @@ -86,9 +86,9 @@ If a theme set with the same name exists in both locations, the one in the home ## Differences to legacy RetroPie themes -If you are not familiar with theming for RetroPie or similar forks of EmulationStation you can skip this section as it only describes the key differences between the updated ES-DE themes and these _legacy_ theme sets. The term _legacy_ is used throughout this document to refer to this older style of themes which ES-DE still fully supports for backward compatibility reasons. The old theme format is described in [THEMES-LEGACY.md](THEMES-LEGACY.md) although this document is basically a historical artifact by now. +If you are not familiar with theming for RetroPie or similar forks of EmulationStation then you can skip this section as it only describes the key differences between the updated ES-DE themes and these legacy theme sets. The term _legacy_ is used throughout this document to refer to this older style of themes. ES-DE as of 2.2.0 can no longer load legacy themes, so if you need to view them when porting them to ES-DE, either use a legacy EmulationStation fork or ES-DE 2.1.1. -With ES-DE v2.0 a new theme engine was introduced that fundamentally changed some aspects of how theming works. The previous design used specific view styles (basic, detailed, video and grid) and this was dropped completely and replaced with _variants_ that can accomplish the same thing while being much more powerful and flexible. +With ES-DE 2.0.0 a new theme engine was introduced that fundamentally changed some aspects of how theming works. The previous design used specific view styles (basic, detailed, video and grid) and this was dropped completely and replaced with _variants_ that can accomplish the same thing while being much more powerful and flexible. In the past EmulationStation basically had hardcoded view styles with certain elements always being present and only a limited ability to manipulate these via positioning, resizing, coloring etc. As well so-called _extras_ were provided to expand theming support somehow but even this was quite limited. @@ -681,12 +681,12 @@ Finally it's possible to apply theme-defined transition profiles on a per-varian ## capabilities.xml -Variants, variant triggers, color schemes, aspect ratios and transition animation profiles need to be declared before they can be used inside the actual theme set configuration files and that is done in the `capabilities.xml` file. This file needs to exist in the root of the theme directory, for example: +Variants, variant triggers, color schemes, aspect ratios and transition animation profiles need to be declared before they can be used inside the actual theme set configuration files and that is done in the `capabilities.xml` file. This file needs to be placed in the root of the theme directory, for example: ``` ~/.emulationstation/themes/mythemeset-es-de/capabilities.xml ``` -This file type was introduced with the new ES-DE theme engine in v2.0 and is an indicator that the theme set is of the new generation instead of being of the legacy type (i.e. a theme set backward compatible with RetroPie EmulationStation). In other words, if the capabilities.xml file is absent, the theme will get loaded as a legacy set. +The capabilities.xml file is mandatory and if it doesn't exist ES-DE will not attempt to load the theme. The structure of the file is simple, as can be seen in this example: @@ -742,7 +742,7 @@ The structure of the file is simple, as can be seen in this example: ``` The file format is hopefully mostly self-explanatory; this example provides three aspect ratios, two color schemes, one transition animation profile and three variants, one of which is a variant trigger override. The `