mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-21 21:55:38 +00:00
Documentation update.
This commit is contained in:
Leon Styhre
parent
23e9f7c138
commit
b68a78b793
|
|
@ -44,6 +44,7 @@ Overall application speed and performance has been greatly improved with faster
|
||||||
* Changed the help system description for the "A" button in the gamelist view from "Launch" to "Select"
|
* Changed the help system description for the "A" button in the gamelist view from "Launch" to "Select"
|
||||||
* Changed the menu header for the gamelist options menu from "Options" to "Gamelist options"
|
* Changed the menu header for the gamelist options menu from "Options" to "Gamelist options"
|
||||||
* Added support for the Arduboy Miniature Game System (arduboy)
|
* Added support for the Arduboy Miniature Game System (arduboy)
|
||||||
|
* Added support for the Capcom Play System I, II and III (cps1, cps2 and cps3) game systems
|
||||||
* Added support for the Sega Mega Drive (megadrivejp) game system (Japanese region)
|
* Added support for the Sega Mega Drive (megadrivejp) game system (Japanese region)
|
||||||
* Added support for the Microsoft Windows (windows) game system
|
* Added support for the Microsoft Windows (windows) game system
|
||||||
* Added support for the Nintendo Wii U (wiiu) game system on Linux and macOS by adding the Cemu standalone emulator
|
* Added support for the Nintendo Wii U (wiiu) game system on Linux and macOS by adding the Cemu standalone emulator
|
||||||
|
|
|
||||||
|
|
@ -402,6 +402,8 @@ As can be seen here, the overall variant trigger configuration needs to be enclo
|
||||||
|
|
||||||
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, as well as 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.
|
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, as well as 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.
|
||||||
|
|
||||||
|
As a final note, variant triggers can also be globally disabled by the user via the _Enable theme variant triggers_ option in the _UI Settings menu_. Not everyone may want the variant auto-switching to take place, and if all systems contain scraped media then disabling the functionality will eliminate the performance penalty described above.
|
||||||
|
|
||||||
## Color schemes
|
## 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.
|
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.
|
||||||
|
|
@ -1632,6 +1634,12 @@ Properties:
|
||||||
* `selectedSecondaryColor` - type: COLOR
|
* `selectedSecondaryColor` - type: COLOR
|
||||||
- Color of the highlighted entry of the secondary entry type.
|
- Color of the highlighted entry of the secondary entry type.
|
||||||
- Default is the same value as `selectedColor`
|
- Default is the same value as `selectedColor`
|
||||||
|
* `selectedBackgroundColor` - type: COLOR
|
||||||
|
- Background color of the highlighted entry of the primary entry type.
|
||||||
|
- Default is `00000000`
|
||||||
|
* `selectedSecondaryBackgroundColor` - type: COLOR
|
||||||
|
- Background color of the highlighted entry of the secondary entry type.
|
||||||
|
- Default is the same value as `selectedBackgroundColor`
|
||||||
* `fontPath` - type: PATH
|
* `fontPath` - type: PATH
|
||||||
* `fontSize` - type: FLOAT
|
* `fontSize` - type: FLOAT
|
||||||
- Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). This calculation is based on the reference 'S' character so other glyphs may not fill this area, or they may exceed this area.
|
- Size of the font as a percentage of screen height (e.g. for a value of `0.1`, the text's height would be 10% of the screen height). This calculation is based on the reference 'S' character so other glyphs may not fill this area, or they may exceed this area.
|
||||||
|
|
@ -2243,7 +2251,9 @@ Properties:
|
||||||
- Valid values are `top`, `center` or `bottom`
|
- Valid values are `top`, `center` or `bottom`
|
||||||
- Default is `center`
|
- Default is `center`
|
||||||
* `color` - type: COLOR
|
* `color` - type: COLOR
|
||||||
|
- Default is `000000FF`
|
||||||
* `backgroundColor` - type: COLOR
|
* `backgroundColor` - type: COLOR
|
||||||
|
- Default is `00000000`
|
||||||
* `letterCase` - type: STRING
|
* `letterCase` - type: STRING
|
||||||
- Valid values are `none`, `uppercase`, `lowercase` or `capitalize`
|
- Valid values are `none`, `uppercase`, `lowercase` or `capitalize`
|
||||||
- Default is `none` (original letter case is retained)
|
- Default is `none` (original letter case is retained)
|
||||||
|
|
|
||||||
|
|
@ -2282,7 +2282,7 @@ Non-legacy theme sets could optionally be optimized for different screen aspect
|
||||||
|
|
||||||
**Theme transitions**
|
**Theme transitions**
|
||||||
|
|
||||||
Transition animations to play when navigating between gamelists, between systems in the System view and between the system and gamelist views. It's normally recommended to keep this setting at its default _Automatic_ value as that allows per-variant transitions, assuming the theme author has included support for that in the theme set. All other values than _Automatic_ are optional as decided by the theme author. For example there could be multiple theme-defined transition entries to choose from, or there could be the possibility to make a selection between the built-in _Instant_, _Slide_ and _Fade_ transitions (although these options could have been disabled from the theme configuration).
|
Transition animations to play when navigating between gamelists, between systems in the System view and between the system and gamelist views. It's normally recommended to keep this setting at its default _Automatic_ value as that allows per-variant transitions, assuming the theme author has included support for that in their theme set. For example there could be multiple theme-defined transition entries to choose from, or there could be the possibility to make a selection between the built-in _Instant_, _Slide_ and _Fade_ transitions (although these options could have been disabled from the theme configuration). If there are no user-selectable transitions avaialable the setting will be grayed out.
|
||||||
|
|
||||||
**Legacy gamelist view style**
|
**Legacy gamelist view style**
|
||||||
|
|
||||||
|
|
@ -3095,6 +3095,9 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
||||||
| coco | Tandy Color Computer | XRoar CoCo 2 NTSC **(Standalone)** [UMW*] | XRoar CoCo 2 PAL **(Standalone)** [UMW*] | Yes | See the specific _Tandy Color Computer_ section elsewhere in this guide |
|
| coco | Tandy Color Computer | XRoar CoCo 2 NTSC **(Standalone)** [UMW*] | XRoar CoCo 2 PAL **(Standalone)** [UMW*] | Yes | See the specific _Tandy Color Computer_ section elsewhere in this guide |
|
||||||
| colecovision | Coleco ColecoVision | blueMSX | Gearcoleco,<br>openMSX **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*] | Yes | Single archive or ROM file |
|
| colecovision | Coleco ColecoVision | blueMSX | Gearcoleco,<br>openMSX **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*] | Yes | Single archive or ROM file |
|
||||||
| cps | Capcom Play System | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [UW*],<br>FB Alpha 2012,<br>FB Alpha 2012 CPS-1,<br>FB Alpha 2012 CPS-2,<br>FB Alpha 2012 CPS-3 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
|
| cps | Capcom Play System | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [UW*],<br>FB Alpha 2012,<br>FB Alpha 2012 CPS-1,<br>FB Alpha 2012 CPS-2,<br>FB Alpha 2012 CPS-3 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
|
||||||
|
| cps1 | Capcom Play System I | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [UW*],<br>FB Alpha 2012,<br>FB Alpha 2012 CPS-1 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
|
||||||
|
| cps2 | Capcom Play System II | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [UW*],<br>FB Alpha 2012,<br>FB Alpha 2012 CPS-2 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
|
||||||
|
| cps3 | Capcom Play System III | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [UW*],<br>FB Alpha 2012,<br>FB Alpha 2012 CPS-3 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
|
||||||
| daphne | Daphne Arcade LaserDisc Emulator | Hypseus [Daphne] **(Standalone)** [UW*] | Hypseus [Singe] **(Standalone)** [UW*] | Yes for Daphne games | See the specific _Hypseus Singe (Daphne)_ section elsewhere in this guide |
|
| daphne | Daphne Arcade LaserDisc Emulator | Hypseus [Daphne] **(Standalone)** [UW*] | Hypseus [Singe] **(Standalone)** [UW*] | Yes for Daphne games | See the specific _Hypseus Singe (Daphne)_ section elsewhere in this guide |
|
||||||
| desktop | Desktop Applications | _Suspend ES-DE_ | _Keep ES-DE running_ | | See the specific _Ports and desktop applications_ section elsewhere in this guide |
|
| desktop | Desktop Applications | _Suspend ES-DE_ | _Keep ES-DE running_ | | See the specific _Ports and desktop applications_ section elsewhere in this guide |
|
||||||
| doom | Doom | PrBoom | Boom 3 [UW],<br>Boom 3 xp [UW],<br>_Shortcut or script_ | No | |
|
| doom | Doom | PrBoom | Boom 3 [UW],<br>Boom 3 xp [UW],<br>_Shortcut or script_ | No | |
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue