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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-12-14 20:26:00 +01:00
parent f4d4abb33b
commit 2e425b62af
3 changed files with 30 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CHANGELOG.md
View file

@ -49,6 +49,7 @@
* Added support for the mugen system on Linux and macOS using the Ikemen GO game engine * Added support for the mugen system on Linux and macOS using the Ikemen GO game engine
* Added CPCemu standalone as an alternative emulator for the amstradcpc system * Added CPCemu standalone as an alternative emulator for the amstradcpc system
* Added MAME standalone as an alternative emulator for the gx4000 system * Added MAME standalone as an alternative emulator for the gx4000 system
* Added the . (dot) file extension to the xbox360 system on Windows to support extensionless XBLA games
* Added the .car and .rom file extensions to the a5200 system * Added the .car and .rom file extensions to the a5200 system
* Added the .car file extension to the atari800 system * Added the .car file extension to the atari800 system
* Added the .bin file extension to the gx4000 system * Added the .bin file extension to the gx4000 system
@ -109,6 +110,7 @@
* Added support for defining the scrollable container speed, start delay and reset delay from the theme configuration * Added support for defining the scrollable container speed, start delay and reset delay from the theme configuration
* Added support for arbitrary aspect ratios for RatingComponent images and also added an overlay property * Added support for arbitrary aspect ratios for RatingComponent images and also added an overlay property
* Added theme support for defining the opacity for most element types * Added theme support for defining the opacity for most element types
* Added theme support for defining relative brightness for images, videos and animations
* Added theme support for defining color saturation for images, videos and animations * Added theme support for defining color saturation for images, videos and animations
* Added theme support for defining the video fade-in time * Added theme support for defining the video fade-in time
* Added theme support for enabling and disabling video pillarboxes and scanline rendering * Added theme support for enabling and disabling video pillarboxes and scanline rendering
@ -188,6 +190,7 @@
* Added a new itemAxisHorizontal property to the carousel to keep wheel items horizontal at all times * Added a new itemAxisHorizontal property to the carousel to keep wheel items horizontal at all times
* Added carousel theme support for setting the opacity for unfocused entries * Added carousel theme support for setting the opacity for unfocused entries
* Added carousel theme support for applying image color shifts * Added carousel theme support for applying image color shifts
* Added carousel theme support for defining image brightness
* Added carousel theme support for defining image saturation * Added carousel theme support for defining image saturation
* Added carousel theme support for setting item transitions to "slide" or "instant" * Added carousel theme support for setting item transitions to "slide" or "instant"
* Added carousel theme support for controlling item stacking for overlapping items * Added carousel theme support for controlling item stacking for overlapping items
@ -220,12 +223,14 @@
### Bug fixes ### Bug fixes
* Multiple levels of symlinking in the ROMs directory tree could crash the application on startup * Multiple levels of symlinking in the ROMs directory tree could crash the application on startup
* Adding a dot (.) to the es_systems.xml extension tag (to setup extensionless entries) lead to a crash if the system contained folders
* For the cps system, MAME standalone was configured with the wrong system directory for the -rompath option, pointing to "arcade" instead of "cps" * For the cps system, MAME standalone was configured with the wrong system directory for the -rompath option, pointing to "arcade" instead of "cps"
* During some menu operations that reloaded the gamelist view, the cached background could miss some components as they were not rendered in time * During some menu operations that reloaded the gamelist view, the cached background could miss some components as they were not rendered in time
* Text wrapping did not work correctly for text that typically does not contain spaces, like Japanese * Text wrapping did not work correctly for text that typically does not contain spaces, like Japanese
* Changing some values using the metadata editor could lead to an incorrect sort order if the changes were done from within a grouped custom collection * Changing some values using the metadata editor could lead to an incorrect sort order if the changes were done from within a grouped custom collection
* Changing the setting "Group unthemed custom collections" could lead to incorrect custom collections sorting under some circumstances * Changing the setting "Group unthemed custom collections" could lead to incorrect custom collections sorting under some circumstances
* For gamelists which mixed files and folders, the folder sorting was sometimes incorrect * For gamelists which mixed files and folders, the folder sorting was sometimes incorrect
* Incorrect folder paths were displayed in the metadata editor if the setting "Only show ROMs from gamelist.xml files" was enabled
* Games located in subdirectories were not added back to custom collections when disabling the "Exclude from game counter" metadata option * Games located in subdirectories were not added back to custom collections when disabling the "Exclude from game counter" metadata option
* Enabling and then disabling the "Exclude from game counter" metadata option would remove a game from all currently disabled custom collections * Enabling and then disabling the "Exclude from game counter" metadata option would remove a game from all currently disabled custom collections
* Navigation sounds for the trigger buttons would play when repeatedly pressed at the start or end of text lists * Navigation sounds for the trigger buttons would play when repeatedly pressed at the start or end of text lists

6
INSTALL-DEV.md
View file

@ -1165,6 +1165,8 @@ Wildcards are supported for emulator binaries, but not for directories:
<command>~/App*/yuzu*.AppImage %ROM%</command> <command>~/App*/yuzu*.AppImage %ROM%</command>
``` ```
There is a special case when it comes to file extensions where it's possible to use extensionless files if required. To accomplish this simply add a dot (.) to the list of extensions in the `<extension>` tag. Obviously this makes it impossible to use the _directories interpreted as files_ functionality as there is no file extension, but apart from that everything should work the same as for regular files.
Keep in mind that you have to set up your emulators separately from ES-DE as the es_systems.xml file assumes that your emulator environment is properly configured. Keep in mind that you have to set up your emulators separately from ES-DE as the es_systems.xml file assumes that your emulator environment is properly configured.
Below is an overview of the file layout with various examples. For the command tag, the newer es_find_rules.xml logic described later in this document removes the need for most of the legacy options, but they are still supported for special configurations and for backward compatibility with old configuration files. Below is an overview of the file layout with various examples. For the command tag, the newer es_find_rules.xml logic described later in this document removes the need for most of the legacy options, but they are still supported for special configurations and for backward compatibility with old configuration files.
@ -1195,8 +1197,8 @@ Below is an overview of the file layout with various examples. For the command t
All subdirectories (and non-recursive links) will be included. --> All subdirectories (and non-recursive links) will be included. -->
<path>%ROMPATH%/snes</path> <path>%ROMPATH%/snes</path>
<!-- A list of extensions to search for, delimited by any of the whitespace characters (", \r\n\t"). <!-- A list of extensions to search for, delimited by any of the whitespace characters (", \r\n\t"). Extensions are
The extensions are case sensitive and they must begin with a dot. --> case sensitive and they must begin with a dot. It's also possible to add just a dot to include extensionless files. -->
<extension>.smc .SMC .sfc .SFC .swc .SWC .fig .FIG .bs .BS .bin .BIN .mgd .MGD .7z .7Z .zip .ZIP</extension> <extension>.smc .SMC .sfc .SFC .swc .SWC .fig .FIG .bs .BS .bin .BIN .mgd .MGD .7z .7Z .zip .ZIP</extension>
<!-- The command executed when a game is launched. Various variables are replaced if found for a command tag as explained below. <!-- The command executed when a game is launched. Various variables are replaced if found for a command tag as explained below.

22
THEMES-DEV.md
View file

@ -1091,6 +1091,10 @@ Properties:
- The direction to apply the color gradient if both `imageColor` and `imageColorEnd` have been defined. - The direction to apply the color gradient if both `imageColor` and `imageColorEnd` have been defined.
- Valid values are `horizontal` or `vertical` - Valid values are `horizontal` or `vertical`
- Default is `horizontal` - Default is `horizontal`
* `imageBrightness` - type: FLOAT
- Controls the relative level of brightness. This is intended primarily for fine adjustments, for example if a color shift has been applied which may have lowered the overall brightness of the image.
- Minimum value is `-2` and maximum value is `2`
- Default is `0` (no brightness adjustments applied)
* `imageSaturation` - type: FLOAT * `imageSaturation` - type: FLOAT
- Controls the level of color saturation. - Controls the level of color saturation.
- Minimum value is `0` (grayscale) and maximum value is `1` (original file saturation). - Minimum value is `0` (grayscale) and maximum value is `1` (original file saturation).
@ -1262,6 +1266,10 @@ Properties:
- The direction to apply the color gradient if both `imageColor` and `imageColorEnd` have been defined. - The direction to apply the color gradient if both `imageColor` and `imageColorEnd` have been defined.
- Valid values are `horizontal` or `vertical` - Valid values are `horizontal` or `vertical`
- Default is `horizontal` - Default is `horizontal`
* `imageBrightness` - type: FLOAT
- Controls the relative level of brightness. This is intended primarily for fine adjustments, for example if a color shift has been applied which may have lowered the overall brightness of the image.
- Minimum value is `-2` and maximum value is `2`
- Default is `0` (no brightness adjustments applied)
* `imageSaturation` - type: FLOAT * `imageSaturation` - type: FLOAT
- Controls the level of color saturation. - Controls the level of color saturation.
- Minimum value is `0` (grayscale) and maximum value is `1` (original file saturation). - Minimum value is `0` (grayscale) and maximum value is `1` (original file saturation).
@ -1514,6 +1522,10 @@ Properties:
* `scrollFadeIn` - type: BOOLEAN * `scrollFadeIn` - type: BOOLEAN
- If enabled, a short fade-in animation will be applied when scrolling through games in the gamelist view. This usually looks best if used for the main game image. - If enabled, a short fade-in animation will be applied when scrolling through games in the gamelist view. This usually looks best if used for the main game image.
- Default is `false` - Default is `false`
* `brightness` - type: FLOAT
- Controls the relative level of brightness. This is intended primarily for fine adjustments, for example if a color shift has been applied which may have lowered the overall brightness of the image.
- Minimum value is `-2` and maximum value is `2`
- Default is `0` (no brightness adjustments applied)
* `opacity` - type: FLOAT * `opacity` - type: FLOAT
- Controls the level of transparency. If set to `0` the element will be disabled. - Controls the level of transparency. If set to `0` the element will be disabled.
- Minimum value is `0` and maximum value is `1` - Minimum value is `0` and maximum value is `1`
@ -1614,8 +1626,12 @@ Properties:
* `scrollFadeIn` - type: BOOLEAN * `scrollFadeIn` - type: BOOLEAN
- If enabled, a short fade-in animation will be applied when scrolling through games in the gamelist view. This animation is only applied to images and not to actual videos, so if no image metadata has been defined then this property has no effect. For this to work correctly the `delay` property also needs to be set. - If enabled, a short fade-in animation will be applied when scrolling through games in the gamelist view. This animation is only applied to images and not to actual videos, so if no image metadata has been defined then this property has no effect. For this to work correctly the `delay` property also needs to be set.
- Default is `false` - Default is `false`
* `brightness` - type: FLOAT
- Controls the relative level of brightness. This affects both the static image and the video stream. This is intended primarily for fine adjustments, for example if a color shift has been applied which may have lowered the overall brightness of the image.
- Minimum value is `-2` and maximum value is `2`
- Default is `0` (no brightness adjustments applied)
* `opacity` - type: FLOAT * `opacity` - type: FLOAT
- Controls the level of transparency. If set to `0` the element will be disabled. - Controls the level of transparency. This affects both the static image and the video stream. If set to `0` the element will be disabled.
- Minimum value is `0` and maximum value is `1` - Minimum value is `0` and maximum value is `1`
- Default is `1` - Default is `1`
* `saturation` - type: FLOAT * `saturation` - type: FLOAT
@ -1674,6 +1690,10 @@ Properties:
- 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 GIF animations. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. This property has no effect on Lottie animations.
- Valid values are `nearest` or `linear` - Valid values are `nearest` or `linear`
- Default is `nearest` - Default is `nearest`
* `brightness` - type: FLOAT
- Controls the relative level of brightness. This is intended primarily for fine adjustments.
- Minimum value is `-2` and maximum value is `2`
- Default is `0` (no brightness adjustments applied)
* `opacity` - type: FLOAT * `opacity` - type: FLOAT
- Controls the level of transparency. If set to `0` the element will be disabled. - Controls the level of transparency. If set to `0` the element will be disabled.
- Minimum value is `0` and maximum value is `1` - Minimum value is `0` and maximum value is `1`