mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-22 06:05:38 +00:00
Documentation update.
This commit is contained in:
Leon Styhre
parent
161f57d683
commit
b1dbd28be0
4
FAQ.md
4
FAQ.md
|
|
@ -60,6 +60,10 @@ This is almost always caused by either corrupt ROMs/disc images or by missing em
|
|||
|
||||
This is related to the two questions above, ES-DE does not perform any emulator configuration or general system configuration. So you would either need to configure an exit button combination inside your emulator, or use a third party tool to map for instance Alt + F4 or Command + Q to a certain button combination on your controller. If you use RetroArch then it's easy to setup a button combination to exit back to ES-DE, which will apply to all cores. Refer to the RetroArch documentation or their support channels on how to accomplish this.
|
||||
|
||||
## Why does it take a long time for ES-DE to resume after I've exited a game?
|
||||
|
||||
With a few notable exceptions like the Valve Steam system on all platforms and the MAME standalone emulator on Windows, ES-DE will wait for emulators and games to fully exit before it resumes. Some emulators take quite some time to fully exit (sometimes even after their application windows have been destroyed). This may make it seem as if ES-DE is hanging although it's actually waiting for the launched child process to exit. Another reason for a delayed resume is if a custom event script is executed on game end which itself takes a long time to run. If you have such a custom setup then there is a way to work around this by executing scripts as background processes, which is documented [here](INSTALL.md#custom-event-scripts).
|
||||
|
||||
## I have many games with multiple files, is there a way to show these as single entries?
|
||||
|
||||
Yes this is supported for both single-disc games using a .bin/.cue structure for instance, or for multi-file/multi-disc games where .m3u files are used for emulator disc swapping. See the _Directories interpreted as files_ section of the [User guide](USERGUIDE.md#directories-interpreted-as-files) for details on how to configure this.
|
||||
|
|
|
|||
|
|
@ -1909,7 +1909,7 @@ Just make sure to not place the portable installation on a network share that us
|
|||
|
||||
There are numerous locations throughout ES-DE where custom scripts can be executed if the option to do so has been enabled in the settings. You'll find the option _Enable custom event scripts_ on the Main menu under _Other settings_. By default this setting is deactivated so make sure to enable it to use this feature.
|
||||
|
||||
The approach is quite straightforward, ES-DE will look for any files inside a script directory that corresponds to the event that is triggered and will then execute all these files. If you want to have the scripts executed in a certain order you can name them accordingly as they will be sorted and executed in lexicographic order. The sorting is case-sensitive on Unix/Linux and case-insensitive on macOS and Windows. ES-DE will wait for each script to finish its execution before moving on to the next one, so the application will suspend briefly when whatever the script is doing is executing. If you want to avoid this you can setup a wrapper script that executes another script outside the ES-DE scripts directory as a background process.
|
||||
The approach is quite straightforward, ES-DE will look for any files inside a script directory that corresponds to the event that is triggered and will then execute all these files. If you want to have the scripts executed in a certain order you can name them accordingly as they will be sorted and executed in lexicographic order. The sorting is case-sensitive on Unix/Linux and case-insensitive on macOS and Windows. ES-DE will wait for each script to finish its execution before moving on to the next one, so the application will suspend briefly when whatever the script is doing is executing. If you want to avoid this you can setup a wrapper script that executes another script outside the ES-DE scripts directory as a background process. Refer to your operating system documentation on how to accomplish this.
|
||||
|
||||
There are up to four parameters that will be passed to these scripts, as detailed below:
|
||||
|
||||
|
|
|
|||
|
|
@ -2140,7 +2140,9 @@ Just make sure to not place the portable installation on a network share that us
|
|||
|
||||
There are numerous locations throughout ES-DE where custom scripts can be executed if the option to do so has been enabled in the settings. You'll find the option _Enable custom event scripts_ on the Main menu under _Other settings_. By default this setting is deactivated so make sure to enable it to use this feature.
|
||||
|
||||
The approach is quite straightforward, ES-DE will look for any files inside a script directory that corresponds to the event that is triggered and will then execute all these files. There are up to four parameters that will be passed to these scripts, as detailed below:
|
||||
The approach is quite straightforward, ES-DE will look for any files inside a script directory that corresponds to the event that is triggered and will then execute all these files. It will wait for each script to finish its execution before moving on to the next one, so the application will suspend briefly when whatever the script is doing is executing. If you want to avoid this you can setup a wrapper script that executes another script outside the ES-DE scripts directory as a background process. Refer to your operating system documentation on how to accomplish this.
|
||||
|
||||
There are up to four parameters that will be passed to these scripts, as detailed below:
|
||||
|
||||
| Event | Parameters* | Description |
|
||||
| :----------------------- | :------------------------------------------------- | :-------------------------------------------------------------------------- |
|
||||
|
|
|
|||
|
|
@ -356,6 +356,40 @@ Here are some example uses of the `<variant>` functionality:
|
|||
</view>
|
||||
</theme>
|
||||
```
|
||||
|
||||
## Variant triggers (overrides)
|
||||
|
||||
Variant triggers is an optional feature which can be used to replicate the automatic view style switching functionality of the legacy theme engine. This can be used to automatically override the selected variant based on two triggers, either when there are no game videos found for a system, or if there are no game media files of some specified types found for a system. These two trigger types are named `noVideos` and `noMedia` respectively.
|
||||
|
||||
For the `noMedia` trigger there's an optional `mediaType` tag that can be used to specify precisely which media files should be checked for to determine whether to switch to the override variant. Valid values are `miximage`, `marquee`, `screenshot`, `titlescreen`, `cover`, `backcover`, `3dbox`, `physicalmedia`, `fanart` and `video`. Multiple values can be defined, in which case they are separated by a comma, or by a whitespace character (tab, space or line break). If no value is defined, it will be set to `miximage`.
|
||||
|
||||
The `useVariant` tag specifies which variant to use to override the selected variant.
|
||||
|
||||
You'll probably rarely need to use the `noVideos` trigger as `video` can be defined also when using the `noMedia` trigger. The reason for including both trigger types is that it makes it possible to apply a specific variant only when videos are missing and another variant when no media files at all are present.
|
||||
|
||||
The following example (from the `capabilities.xml` file) defines a `noGameMedia` variant which is used as the override for the `withVideos` variant if no miximages, screenshots, covers and videos are found for any game in a system. For this example the `noGameMedia` variant has been set as non-selectable from the _UI Settings_ menu.
|
||||
|
||||
As can be seen here, the overall variant trigger configuration needs to be enclosed within an `override` tag pair
|
||||
|
||||
```xml
|
||||
<variant name="withVideos">
|
||||
<label>Textlist with videos</label>
|
||||
<selectable>true</selectable>
|
||||
<override>
|
||||
<trigger>noMedia</trigger>
|
||||
<mediaType>miximage, screenshot, cover, video</mediaType>
|
||||
<useVariant>noGameMedia</useVariant>
|
||||
</override>
|
||||
</variant>
|
||||
|
||||
<variant name="noGameMedia">
|
||||
<label>No game media</label>
|
||||
<selectable>false</selectable>
|
||||
</variant>
|
||||
```
|
||||
|
||||
Note that variant triggers will only apply to the gamelist view and not the system view. Also be aware that it will add a potentially noticeable application slowdown as game media files need to be scanned for at various points when using the application, as well as during startup. The impact of the performance penalty depends on multiple factors such as the game collection size, how many games have been scraped and disk I/O and filesystem performance. So only use variant triggers if really necessary for your theme design. As well, specifying many values for the `mediaType` tag will lead to more files potentially being scanned which could introduce further lag and latency.
|
||||
|
||||
## Color schemes
|
||||
|
||||
Color schemes are essentially a collection of variables that can be selected between from the _UI Settings_ menu. This makes it possible to define different values that will be applied to the overall theme configuration based on this menu selection. Only variables can be used for the color schemes, but since variables can be used for almost everything this makes the functionality very flexible. In most cases you'll probably want to apply different color values to `<color>` properties and similar, but it's also possible to apply different images, animations, fonts etc. per color scheme.
|
||||
|
|
@ -493,7 +527,7 @@ Once the aspect ratios have been defined, they are applied to the theme configur
|
|||
|
||||
## capabilities.xml
|
||||
|
||||
Variants, color schemes and aspect ratios 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 and aspect ratios 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:
|
||||
```
|
||||
~/.emulationstation/themes/mythemeset-DE/capabilities.xml
|
||||
```
|
||||
|
|
@ -520,15 +554,30 @@ The structure of the file is simple, it just contains declarations for the varia
|
|||
<variant name="withVideos">
|
||||
<label>Textlist with videos</label>
|
||||
<selectable>true</selectable>
|
||||
<override>
|
||||
<trigger>noMedia</trigger>
|
||||
<mediaType>miximage, screenshot, cover, video</mediaType>
|
||||
<useVariant>noGameMedia</useVariant>
|
||||
</override>
|
||||
</variant>
|
||||
|
||||
<variant name="withoutVideos">
|
||||
<label>Textlist without videos</label>
|
||||
<selectable>true</selectable>
|
||||
<override>
|
||||
<trigger>noMedia</trigger>
|
||||
<mediaType>miximage, screenshot, cover</mediaType>
|
||||
<useVariant>noGameMedia</useVariant>
|
||||
</override>
|
||||
</variant>
|
||||
|
||||
<variant name="noGameMedia">
|
||||
<label>No game media</label>
|
||||
<selectable>false</selectable>
|
||||
</variant>
|
||||
</themeCapabilities>
|
||||
```
|
||||
The file format is hopefully mostly self-explanatory; this example provides three aspect ratios, two color schemes and two variants. The `<label>` tag for the variant is the text that will show up in the _UI Settings_ menu where the variants can be selected, assuming `<selectable>` has been set to true. The same is true for color schemes, although these will always show up in the GUI and can't be disabled.
|
||||
The file format is hopefully mostly self-explanatory; this example provides three aspect ratios, two color schemes and three variants, one of which is a variant trigger override. The `<label>` tag for the variant is the text that will show up in the _UI Settings_ menu where the variants can be selected, assuming `<selectable>` has been set to true. The same is true for color schemes, although these will always show up in the GUI and can't be disabled.
|
||||
|
||||
Both the variant and color scheme names as well as their labels can be set to arbitrary values, but the name has to be unique. If two entries are declared with the same name, a warning will be generated on startup and the duplicate entry will not get loaded. Variants and color schemes will be listed in the _UI Settings_ menu in the order that they are defined in capabilities.xml.
|
||||
|
||||
|
|
@ -550,7 +599,7 @@ It's normally not necessary to define all or even most of these for a theme set,
|
|||
|
||||
The declared aspect ratios will always get displayed in the _UI settings_ menu in the order listed in the table above, so they can be declared in any order in the capabilities.xml file. If an unsupported aspect ratio value is entered, a warning will be generated on startup and the entry will not get loaded.
|
||||
|
||||
The use of variants, color schemes and aspect ratios is optional, i.e. a theme set does not need to provide any of them. There must however be a capabilities.xml file present in the root of the theme set directory. So if you don't wish to provide this functionality, simply create an empty file or perhaps add a short XML comment to clarify that the theme set does not provide this functionality. In this case the theme will still load and work correctly but the menu options for selecting variants, color schemes and aspect ratios will be grayed out.
|
||||
The use of variants, variant triggers, color schemes and aspect ratios is optional, i.e. a theme set does not need to provide any of them. There must however be a capabilities.xml file present in the root of the theme set directory. So if you don't wish to provide this functionality, simply create an empty file or perhaps add a short XML comment to clarify that the theme set does not provide this functionality. In this case the theme will still load and work correctly but the menu options for selecting variants, color schemes and aspect ratios will be grayed out.
|
||||
|
||||
Note that changes to the capabilities.xml file are not reloaded when using the Ctrl+r key combination, instead ES-DE needs to be restarted to reload any changes to this file.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue