mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-25 07:35:38 +00:00
Documentation update.
This commit is contained in:
Leon Styhre
parent
75a9552a82
commit
52f4d45369
|
|
@ -25,8 +25,8 @@ Overall application speed and performance has been greatly improved with faster
|
|||
* Added a new grid component that is usable in both the system and gamelist views
|
||||
* Made gamelist theming much more flexible by allowing any number of elements of any types to be defined
|
||||
* Deprecated multiple older theming concepts like features, extras and hardcoded metadata attributes
|
||||
* Renamed the default theme set from rbsimple-DE to slate-DE
|
||||
* Ported modern-DE to the new theme engine
|
||||
* Renamed the default theme set from rbsimple-DE to slate-es-de
|
||||
* Ported modern-DE to the new theme engine and renamed it to modern-es-de
|
||||
* Added variant trigger (override) support to replicate the legacy theme engine automatic view style switching
|
||||
* Replaced the NanoSVG library with LunaSVG for greatly improved SVG rendering capabilities
|
||||
* Added support for caching of SVG images
|
||||
|
|
|
|||
|
|
@ -111,9 +111,9 @@ https://www.mamedev.org
|
|||
CA certificates (for TLS/SSL support on Windows) \
|
||||
https://wiki.mozilla.org/CA
|
||||
|
||||
# slate-DE theme set
|
||||
# Slate theme set
|
||||
|
||||
Recalbox Multi (slate-DE is based on this theme, using assets from before their change to a more restrictive license in 2018) \
|
||||
Recalbox Multi (Slate is based on this theme, using assets from before their change to a more restrictive license in 2018) \
|
||||
https://gitlab.com/recalbox/recalbox-themes
|
||||
|
||||
Carbon (some graphics taken from this theme) \
|
||||
|
|
@ -121,7 +121,7 @@ https://github.com/RetroPie/es-theme-carbon
|
|||
|
||||
# Sounds
|
||||
|
||||
Used by the default slate-DE theme as well as for fallback sounds (for themes that lack navigation sounds).
|
||||
Used by the default Slate theme as well as for fallback sounds (for themes that lack navigation sounds).
|
||||
|
||||
https://freesound.org/people/adcbicycle/sounds/14066
|
||||
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ The software comes preconfigured for use with [RetroArch](https://www.retroarch.
|
|||
|
||||
You can find the complete list of supported systems and emulators [here](USERGUIDE.md#supported-game-systems).
|
||||
|
||||
Two comprehensive theme sets, **slate-DE** (rbsimple-DE in the 1.x releases) and **modern-DE** are bundled with the application.
|
||||
Two comprehensive theme sets, **Slate** (Rbsimple in the 1.x releases) and **Modern** are bundled with the application.
|
||||
|
||||
See the [official list](https://gitlab.com/es-de/themes/themes-list) of recommended theme sets if you would like to install additional themes.
|
||||
|
||||
|
|
@ -108,7 +108,7 @@ Prebuilt packages for the Raspberry Pi will be dropped as of ES-DE 2.0.0 but thi
|
|||
|
||||
# Some feature highlights
|
||||
|
||||
Here are some highlights of what ES-DE provides, displayed using the default theme set slate-DE. There are of course many more features available, as covered in the [User guide](USERGUIDE.md).
|
||||
Here are some highlights of what ES-DE provides, displayed using the default theme set Slate. There are of course many more features available, as covered in the [User guide](USERGUIDE.md).
|
||||
|
||||
|
||||
_The **System view**, which is the default starting point for the application, it's here that you browse through your game systems._
|
||||
|
|
@ -120,7 +120,7 @@ _The **Gamelist view**, it's here that you browse the actual games per system. N
|
|||
_Another example of the gamelist view, displaying advanced folder support. You can scrape folders for game info and game media, sort folders as you would files, mark them as favorites etc. In this example ES-DE has been configured to sort favorite games above non-favorites._
|
||||
|
||||
|
||||
_Games can be grouped into your own custom collections, in this example they're defined as game genres but you can name them anything you like. All gamelist views including the custom collections support both game images or game videos. By default the slate-DE theme will display the game image for a short moment before starting to play the video._
|
||||
_Games can be grouped into your own custom collections, in this example they're defined as game genres but you can name them anything you like. All gamelist views including the custom collections support both game images or game videos. By default the Slate theme will display the game image for a short moment before starting to play the video._
|
||||
|
||||
|
||||
_This is a view of the built-in scraper which downloads game info and game media from either [screenscraper.fr](https://screenscraper.fr) or [thegamesdb.net](https://thegamesdb.net). It's possible to scrape a single game, or to run the multi-scraper which can scrape a complete game system or even your entire collection._
|
||||
|
|
@ -135,7 +135,7 @@ _In addition to the scraper there is a fully-featured metadata editor that can b
|
|||
_There are four types of built-in screensavers available, including a slideshow and the video screensaver shown in action above. These screensavers start after a configurable number of minutes of inactivity, and randomly display game media that you have previously scraped. If the corresponding option has been enabled, you can jump to the game from the screensaver, or even launch it directly. There is shader support in ES-DE to render scanlines and screen blur on top of the videos (for the slideshow screensaver, scanline rendering is provided)._
|
||||
|
||||
|
||||
_ES-DE is fully themeable, so if you prefer another look than what the default theme slate-DE offers, it's possible to apply another theme set. The image above is of the modern-DE theme that is also bundled with the application. Note that although ES-DE is backward compatible with older RetroPie EmulationStation themes, some newer features which are specific to ES-DE will not work, at least not until the theme authors update their themes._
|
||||
_ES-DE is fully themeable, so if you prefer another look than what the default theme Slate offers, it's possible to apply another theme set. The image above is of the Modern theme that is also bundled with the application. Note that although ES-DE is backward compatible with older RetroPie EmulationStation themes, some newer features which are specific to ES-DE will not work, at least not until the theme authors update their themes._
|
||||
|
||||
|
||||
_A lot of effort has been spent on making ES-DE easy to setup and use. The above screenshot shows the dialog if starting the application without any game files present in the default ROM directory. ES-DE also ships with a comprehensive game systems configuration file, so unless you really want to customize your setup, you should not need to tinker with the configuration._
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
**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.
|
||||
|
||||
If creating theme sets specifically for ES-DE, please add `-DE` to the theme name, as in `slate-DE`. Because ES-DE theme functionality has deviated greatly from the RetroPie EmulationStation fork on which it was originally based, any newer themes will not work on such older forks. It would be confusing and annoying for users that attempt to use ES-DE theme sets in older EmulationStation forks as they would get unthemed systems, 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 `-es-de` to the theme name, as in `slate-es-de`. Because ES-DE theme functionality has deviated greatly from the RetroPie EmulationStation fork on which it was originally based, any newer themes will not work on such older forks. It would be confusing and annoying for users that attempt to use ES-DE theme sets in older EmulationStation forks as they would get unthemed systems, crashes, error messages or corrupted graphics. At least the -es-de extension is a visual indicator that it's an ES-DE specific theme set.
|
||||
|
||||
It's recommended to use a proper code editor for theme development, such as [VSCode](https://code.visualstudio.com) with the [Red Hat XML extension](https://github.com/redhat-developer/vscode-xml).
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ There are two places that ES-DE can load theme sets from:
|
|||
* `[INSTALLATION PATH]/themes/[THEME_SET]/`
|
||||
|
||||
An example installation path would be: \
|
||||
`/usr/share/emulationstation/themes/slate-DE/`
|
||||
`/usr/share/emulationstation/themes/slate-es-de/`
|
||||
|
||||
If a theme set with the same name exists in both locations, the one in the home directory will be loaded and the other one will be skipped.
|
||||
|
||||
|
|
@ -1910,7 +1910,8 @@ Properties:
|
|||
- Valid values are `normal` (forwards), `reverse` (backwards), `alternate` (bouncing forwards/backwards) and `alternateReverse` (bouncing backwards/forwards, i.e. starting with playing backwards).
|
||||
- Default is `normal`
|
||||
* `interpolation` - type: STRING
|
||||
- Interpolation method to use when scaling GIF animations. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. This property has no effect on Lottie animations.
|
||||
- Interpolation method to use when scaling. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother.
|
||||
- This property can only be used for GIF animations.
|
||||
- Valid values are `nearest` or `linear`
|
||||
- Default is `nearest`
|
||||
* `brightness` - type: FLOAT
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ There are two places that ES-DE can load theme sets from:
|
|||
* `[INSTALLATION PATH]/themes/[THEME_SET]/`
|
||||
|
||||
An example installation path would be: \
|
||||
`/usr/share/emulationstation/themes/slate-DE/`
|
||||
`/usr/share/emulationstation/themes/slate-es-de/`
|
||||
|
||||
If a theme set with the same name exists in both locations, the one in the home directory will be loaded and the other one will be skipped.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# EmulationStation Desktop Edition (ES-DE) v1.2 - Themes
|
||||
|
||||
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 `-es-de` to the theme name, as in `slate-es-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 -es-de extension is a visual indicator that it's an ES-DE specific theme set.
|
||||
|
||||
It's recommended to use a proper code editor for theme development, such as [VSCode](https://code.visualstudio.com) with the [Red Hat XML extension](https://github.com/redhat-developer/vscode-xml).
|
||||
|
||||
|
|
@ -52,7 +52,7 @@ There are two places that ES-DE can load theme sets from:
|
|||
* `[INSTALLATION PATH]/themes/[THEME_SET]/`
|
||||
|
||||
An example installation path would be: \
|
||||
`/usr/share/emulationstation/themes/slate-DE/`
|
||||
`/usr/share/emulationstation/themes/slate-es-de/`
|
||||
|
||||
If a theme set with the same name exists in both locations, the one in the home directory will be loaded and the other one will be skipped.
|
||||
|
||||
|
|
|
|||
|
|
@ -445,7 +445,7 @@ If you have issues with your input configuration, as a last resort you can reset
|
|||
|
||||
When starting ES-DE with the default settings, you will see the System view first. From here you can navigate your game systems and enter their respective gamelists.
|
||||
|
||||
Depending on the theme, the system navigation carousel can be horizontal, vertical or displayed as a wheel. The default theme slate-DE provides horizontal navigation, i.e. you browse your systems by scrolling left or right.
|
||||
Depending on the theme, the system navigation carousel can be horizontal, vertical or displayed as a wheel. The default theme Slate provides horizontal navigation, i.e. you browse your systems by scrolling left or right.
|
||||
|
||||
The game systems are sorted by their full names by default, as defined in the es_systems.xml file. It's however possible to set a custom sortname per system, as explained in the [INSTALL-DEV.md](INSTALL-DEV.md#es_systemsxml) document.
|
||||
|
||||
|
|
@ -458,7 +458,7 @@ The gamelist view is where you browse and start your games, and it's where you w
|
|||
|
||||
Upon startup with the default settings, ES-DE is set to the gamelist view style **Automatic**. In this mode the application will look for any game media files (videos and images) and set the view style accordingly. If at least one image is found for any game, the view style **Detailed** will be shown, and if at least one video file is found, the view style **Video** will be selected (superceding the Detailed style). If no game media files are found for a system, the simple **Basic** view style will be selected. This automatic selection is applied per game system.
|
||||
|
||||
Note that the Video view style requires that the theme supports it. If not, the Detailed style will be selected instead. The default theme slate-DE supports both of these view styles.
|
||||
Note that the Video view style requires that the theme supports it. If not, the Detailed style will be selected instead. The default theme Slate supports both of these view styles.
|
||||
|
||||
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 if the theme does not support the selected view style.
|
||||
|
||||
|
|
@ -2266,7 +2266,7 @@ Various settings that affect the user interface.
|
|||
|
||||
**Theme set**
|
||||
|
||||
The theme set to use. Defaults to slate-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.
|
||||
The theme set to use. Defaults to Slate 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**
|
||||
|
||||
|
|
@ -2330,7 +2330,7 @@ This option will blur the background behind the menu slightly. Normally this can
|
|||
|
||||
**Display pillarboxes for gamelist videos** _Only for legacy theme sets_
|
||||
|
||||
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 slate-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. This option is only available for legacy theme sets as it's otherwise managed by the theme author.
|
||||
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 Slate, 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. This option is only available for legacy theme sets as it's otherwise managed by the theme author.
|
||||
|
||||
**Render scanlines for gamelist videos** _Only for legacy theme sets_
|
||||
|
||||
|
|
@ -2538,7 +2538,7 @@ This lets you enable or disable your own custom game collections. If there are n
|
|||
|
||||
**Create new custom collection from theme** _(Entry only visible if the ability is provided by the theme set)_
|
||||
|
||||
If the theme set in use provides themes for custom collections, then this entry can be selected. For example, there could be themes for _Fighting_ or _Racing_ etc. The default slate-DE and modern-DE theme sets do not provide such themes for custom collections and in general it's not recommended to use this approach, as is explained [elsewhere](USERGUIDE-DEV.md#custom-collections) in this guide.
|
||||
If the theme set in use provides themes for custom collections, then this entry can be selected. For example, there could be themes for _Fighting_ or _Racing_ etc. The bundled Slate and Modern theme sets do not provide such themes for custom collections and in general it's not recommended to use this approach, as is explained [elsewhere](USERGUIDE-DEV.md#custom-collections) in this guide.
|
||||
|
||||
**Create new custom collection**
|
||||
|
||||
|
|
@ -2923,7 +2923,7 @@ These automatic collections can be individually enabled or disabled by going to
|
|||
|
||||
These are collections that you create yourself. Examples could be grouping in genres like _Shoot em up_, _Fighting games_ etc. or perhaps a time period like _1980s_, _1990s_ and so on.
|
||||
|
||||
If the theme set supports it, you can create a custom collection directly from a theme. However, slate-DE and modern-DE do not provide such themes as it's believed that grouping them together in a dedicated _Collections_ system is a more elegant solution. Especially since the theme set would need to ship with an almost endless amount of collection themes for whatever categories the users would like to use for their game collections.
|
||||
If the theme set supports it, you can create a custom collection directly from a theme. However, Slate and Modern do not provide such themes as it's believed that grouping them together in a dedicated _Collections_ system is a more elegant solution. Especially since the theme set would need to ship with an almost endless amount of collection themes for whatever categories the users would like to use for their game collections.
|
||||
|
||||
So if you have set the option _Group custom collections_ to _If unthemed_ or _Always_, then any collections you add will show up in the special _Collections_ system. Here you can access them just as you would access folders inside a regular gamelist. The amount of games per collection is shown in the description, and a random game is displayed each time you browse through the list. You can also quick jump to this random game by pressing the _Y_ button.
|
||||
|
||||
|
|
@ -2976,7 +2976,7 @@ If you're migrating from a previous version of EmulationStation that has absolut
|
|||
|
||||
## Themes
|
||||
|
||||
ES-DE is fully themeable, and although the application ships with the comprehensive slate-DE and modern-DE theme sets, you can use most RetroPie-compatible EmulationStation themes as well as any themes made specifically for the ES-DE 2.0 theme engine. Note that most Batocera and Recalbox themes are not compatible as these forks use a different theme engine than ES-DE.
|
||||
ES-DE is fully themeable, and although the application ships with the comprehensive Slate and Modern theme sets, you can use most RetroPie-compatible EmulationStation themes as well as any themes made specifically for the ES-DE 2.0 theme engine. Note that most Batocera and Recalbox themes are not compatible as these forks use a different theme engine than ES-DE.
|
||||
|
||||
As a side comment, the terms _theme_ and _theme set_ are both used when talking about theming. The technically correct term for what you apply to the application to achieve a different look is a _theme set_ as it's a collection of a number of themes for a number of game systems. But in practice it doesn't matter as both terms refer to the same thing and the terms are used interchangeably in the ES-DE documentation.
|
||||
|
||||
|
|
@ -2992,20 +2992,20 @@ For this example, we've downloaded the [alekfull-nx-es-de](https://github.com/an
|
|||
~/.emulationstation/themes/es-theme-carbon
|
||||
```
|
||||
|
||||
We now have four entries in the _Theme set_ selector in the UI settings menu, i.e. _alekfull-nx-es-de, es-theme-carbon, modern-DE_ and _slate-DE_.
|
||||
We now have four entries in the _Theme set_ selector in the UI settings menu, i.e. _alekfull-nx-es-de_, _es-theme-carbon, _modern-es-de_ and _slate-es-de_.
|
||||
|
||||
Although you should place additional themes in your ES-DE home directory, the default slate-DE and modern-DE themes are located in the installation folder as they come bundled with the application. For example this could be `/usr/share/emulationstation/themes/` or `/usr/local/share/emulationstation/themes/` on Unix, `/Applications/EmulationStation Desktop Edition.app/Contents/Resources/themes/` on macOS or `C:\Program Files\EmulationStation-DE\themes\` on Windows. If using the portable ES-DE release on Windows, the themes folder will be located in the root of the EmulationStation-DE directory.
|
||||
Although you should place additional themes in your ES-DE home directory, the default Slate and Modern themes are located in the installation folder as they come bundled with the application. For example this could be `/usr/share/emulationstation/themes/` or `/usr/local/share/emulationstation/themes/` on Unix, `/Applications/EmulationStation Desktop Edition.app/Contents/Resources/themes/` on macOS or `C:\Program Files\EmulationStation-DE\themes\` on Windows. If using the portable ES-DE release on Windows, the themes folder will be located in the root of the EmulationStation-DE directory.
|
||||
|
||||
Note that if using the AppImage release on Linux, then there is no installation folder as all files are contained inside the AppImage file.
|
||||
|
||||
If you would like to customize the slate-DE or modern-DE theme sets, simply make a copy of their directories to `~/.emulationstation/themes/` and then those copies will take precedence over the ones in the application installation directory.
|
||||
If you would like to customize the Slate or Modern theme sets, simply make a copy of their directories to `~/.emulationstation/themes/` and then those copies will take precedence over the ones in the application installation directory.
|
||||
|
||||
Refer to the official list of recommended theme sets for a selection of high-quality themes:
|
||||
|
||||
https://gitlab.com/es-de/themes/themes-list
|
||||
|
||||
|
||||
_This is a screenshot of the modern-DE theme that is bundled with ES-DE (in addition to the default slate-DE theme)._
|
||||
_This is a screenshot of the Modern theme that is bundled with ES-DE (in addition to the default Slate theme)._
|
||||
|
||||
## Custom event scripts
|
||||
|
||||
|
|
@ -3019,7 +3019,7 @@ See the [INSTALL-DEV.md](INSTALL-DEV.md#command-line-options) document for a lis
|
|||
|
||||
## Supported game systems
|
||||
|
||||
**Note:** The following list is what the default es_systems.xml files and the slate-DE and modern-DE themes support. These theme sets are very comprehensive, so if you're using another theme, it may be that some or many of these systems are not supported. ES-DE will still work but the game system will unthemed which looks very ugly.
|
||||
**Note:** The following list is what the default es_systems.xml files and the Slate and Modern themes support. These theme sets are very comprehensive, so if you're using another theme, it may be that some or many of these systems are not supported. ES-DE will still work but the game system will unthemed which looks very ugly.
|
||||
|
||||
Note as well that the list and corresponding es_systems.xml templates may not reflect what is readily available for all supported operating system. This is especially true on Unix/Linux if installing RetroArch via the OS repository instead of using the Snap or Flatpak distributions (or compiling from source code) as the repository versions are normally quite crippled.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue