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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-02-20 20:01:49 +01:00
parent b9f5b03005
commit 3ce62550c8
6 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -2,7 +2,7 @@
[[_TOC_]] [[_TOC_]]
## Version 1.3.0 (in development) ## Version 2.0.0 (in development)
**Release date:** TBD **Release date:** TBD

14
CONTRIBUTING.md
View file

@ -60,14 +60,13 @@ The roadmap is under constant review so expect it to change from time to time. S
* _Add GLM library dependency for matrix and vector operations, decommission the built-in functions_ * _Add GLM library dependency for matrix and vector operations, decommission the built-in functions_
* _AppImage and AUR releases on Linux_ * _AppImage and AUR releases on Linux_
#### v1.3 (in progress) #### v2.0 (in progress)
* New theme engine with generalized views (only System and Gamelist) and theme variants support * New theme engine with generalized views (only System and Gamelist) and theme variants support
* Multiple new gamelist components (wheels, wall/grid etc.) * Multiple new gamelist components (wheels, wall/grid etc.)
* Lottie animation (vector graphics) support * Lottie animation (vector graphics) and GIF animation support
* Checksum support for the scraper for exact searches and for determining when to overwrite files
#### v1.4 #### v2.1
* Animated menu elements like switches, tick boxes, smooth scrolling etc. * Animated menu elements like switches, tick boxes, smooth scrolling etc.
* Add scraping of game manuals and maps and create a viewer for these (with PDF, GIF, JPG and PNG support) * Add scraping of game manuals and maps and create a viewer for these (with PDF, GIF, JPG and PNG support)
@ -77,16 +76,17 @@ The roadmap is under constant review so expect it to change from time to time. S
* RetroAchievements.org integration * RetroAchievements.org integration
* Add "time played" counter per game, similar to how it works in Steam * Add "time played" counter per game, similar to how it works in Steam
#### v1.5 #### v2.2
* Reorganize the menus, possibly adding basic/advanced modes * Reorganize the menus, possibly adding basic/advanced modes
* Localization/multi-language support * Localization/multi-language support
* Simple file browsing component * Simple file browsing component
* Checksum support for the scraper for exact searches and for determining when to overwrite files
* New texture/cache manager with support for SVG images and Lottie animations * New texture/cache manager with support for SVG images and Lottie animations
* Support for portrait orientation, e.g. for Tate Mode arcade cabinets * Support for portrait orientation, e.g. for Tate Mode arcade cabinets
* Improved text and font functions, e.g. faster and cleaner line wrapping and more exact sizing * Improved text and font functions, e.g. faster and cleaner line wrapping and more exact sizing
#### v1.6 #### v2.3
* Vulkan renderer for all supported operating systems * Vulkan renderer for all supported operating systems
* Dependency on MoltenVK to get Metal support on macOS * Dependency on MoltenVK to get Metal support on macOS
@ -96,7 +96,7 @@ The roadmap is under constant review so expect it to change from time to time. S
* Bulk metadata editor * Bulk metadata editor
* Improve multi-threading * Improve multi-threading
#### v1.7 #### v2.4
* Migration tools for importing game metadata and media from other frontend applications * Migration tools for importing game metadata and media from other frontend applications
* Audit tools to clean up orphaned gamelist entries, media files etc. * Audit tools to clean up orphaned gamelist entries, media files etc.

2
INSTALL-DEV.md
View file

@ -1,4 +1,4 @@
# EmulationStation Desktop Edition (ES-DE) v1.3 (development version) - Building and advanced configuration # EmulationStation Desktop Edition (ES-DE) v2.0 (development version) - Building and advanced configuration
**Note:** This is a quite technical document intended for those that are interested in compiling ES-DE from source code, or would like to customize the configuration. If you just want to start using the software, check out [USERGUIDE-DEV.md](USERGUIDE-DEV.md) instead. **Note:** This is a quite technical document intended for those that are interested in compiling ES-DE from source code, or would like to customize the configuration. If you just want to start using the software, check out [USERGUIDE-DEV.md](USERGUIDE-DEV.md) instead.

6
THEMES-DEV.md
View file

@ -1,4 +1,4 @@
# EmulationStation Desktop Edition (ES-DE) v1.3 (development version) - Themes # EmulationStation Desktop Edition (ES-DE) v2.0 (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. **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.
@ -58,7 +58,7 @@ If a theme set with the same name exists in both locations, the one in the home
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 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.
With ES-DE v1.3 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 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.
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. 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.
@ -369,7 +369,7 @@ Variant and aspect ratio values need to be declared before they can be used insi
~/.emulationstation/themes/mythemeset-DE/capabilities.xml ~/.emulationstation/themes/mythemeset-DE/capabilities.xml
``` ```
This file type was introduced with the new ES-DE theme engine in v1.3 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. 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 structure of the file is simple, it just contains the declarations for the variants and aspect ratios, such as in this example: The structure of the file is simple, it just contains the declarations for the variants and aspect ratios, such as in this example:

2
THEMES-LEGACY.md
View file

@ -1,6 +1,6 @@
# EmulationStation Desktop Edition (ES-DE) - Legacy Themes # EmulationStation Desktop Edition (ES-DE) - Legacy Themes
**This document covers the creation of legacy themes only, which is a theme structure that is backward compatible with RetroPie EmulationStation. As ES-DE v1.3 and later has a new theme engine with much improved theming capabilities, this document is mostly intended for historical reference. For creating or porting themes to ES-DE the documentation in [THEMES.md](THEMES.md) should be used instead.** **This document covers the creation of legacy themes only, which is a theme structure that is backward compatible with RetroPie EmulationStation. As ES-DE v2.0 and later has a new theme engine with much improved theming capabilities, this document is mostly intended for historical reference. For creating or porting themes to ES-DE the documentation in [THEMES.md](THEMES.md) should be used instead.**
If creating theme sets specifically for ES-DE, please add `-DE` to the theme name, as in `rbsimple-DE`. Because the ES-DE theme support has already deviated somehow from the RetroPie EmulationStation fork and will continue to deviate further in the future, the theme set will likely not be backwards compatible. It would be confusing and annoying for a user that downloads and attempts to use an ES-DE theme set in another EmulationStation fork only to get crashes, error messages or corrupted graphics. At least the -DE extension is a visual indicator that it's an ES-DE specific theme set. If creating theme sets specifically for ES-DE, please add `-DE` to the theme name, as in `rbsimple-DE`. Because the ES-DE theme support has already deviated somehow from the RetroPie EmulationStation fork and will continue to deviate further in the future, the theme set will likely not be backwards compatible. It would be confusing and annoying for a user that downloads and attempts to use an ES-DE theme set in another EmulationStation fork only to get crashes, error messages or corrupted graphics. At least the -DE extension is a visual indicator that it's an ES-DE specific theme set.

4
USERGUIDE-DEV.md
View file

@ -1,4 +1,4 @@
# EmulationStation Desktop Edition (ES-DE) v1.3 (development version) - User guide # EmulationStation Desktop Edition (ES-DE) v2.0 (development version) - User guide
This document is intended as a quick start guide and as a reference for the application settings and general functionality. For details on how to build ES-DE from source code and to perform more advanced configuration, please refer to [INSTALL-DEV.md](INSTALL-DEV.md). This document is intended as a quick start guide and as a reference for the application settings and general functionality. For details on how to build ES-DE from source code and to perform more advanced configuration, please refer to [INSTALL-DEV.md](INSTALL-DEV.md).
@ -1220,7 +1220,7 @@ Various settings that affect the user interface.
**Theme set** **Theme set**
The theme set to use. Defaults to rbsimple-DE which is shipped with the application. There are two types of theme sets; the new type which was introduced with ES-DE v1.3 and legacy themes that are supported for backward compatibility with RetroPie EmulationStation. The use of legacy themes is however discouraged as their functionality is very limited. As well the backward compabitility will likely be removed at some point in the future. The theme set to use. Defaults to rbsimple-DE which is shipped with the application. There are two types of theme sets; the new type which was introduced with ES-DE v2.0 and legacy themes that are supported for backward compatibility with RetroPie EmulationStation. The use of legacy themes is however discouraged as their functionality is very limited. As well the backward compabitility will likely be removed at some point in the future.
**Theme variant** **Theme variant**