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:
parent
88df22cb61
commit
be3cde3d7f
|
@ -16,6 +16,7 @@ Catch-up release which implements some things that didn't make it into 2.0.0. Mo
|
||||||
* Added a setting to set the user theme directory to an arbitrary location (not configurable via the GUI)
|
* Added a setting to set the user theme directory to an arbitrary location (not configurable via the GUI)
|
||||||
* Added scrollable text container support to the system view
|
* Added scrollable text container support to the system view
|
||||||
* Added six new theme properties for sizing and placement of the helpsystem when a menu is open
|
* Added six new theme properties for sizing and placement of the helpsystem when a menu is open
|
||||||
|
* Added a scaleInwards property to the grid element to contain scaling within the element boundaries
|
||||||
* Added a new gameOverridePath property to the image element to enable per-game static image overrides
|
* Added a new gameOverridePath property to the image element to enable per-game static image overrides
|
||||||
* Added support for the Sinclair ZX Spectrum Next (zxnext) game system
|
* Added support for the Sinclair ZX Spectrum Next (zxnext) game system
|
||||||
* Added support for the Sinclair Spectrum ZX emulator ZEsarUX
|
* Added support for the Sinclair Spectrum ZX emulator ZEsarUX
|
||||||
|
@ -29,6 +30,7 @@ Catch-up release which implements some things that didn't make it into 2.0.0. Mo
|
||||||
* (macOS) Added the .app and .sh file extensions to the arcade and mame systems
|
* (macOS) Added the .app and .sh file extensions to the arcade and mame systems
|
||||||
* (Windows) Added the .bat and .lnk file extensions to the arcade and mame systems
|
* (Windows) Added the .bat and .lnk file extensions to the arcade and mame systems
|
||||||
* Added the .app file extensions to the nds system
|
* Added the .app file extensions to the nds system
|
||||||
|
* Added the .7z and .zip file extensions to the 3do system
|
||||||
* Changed the platform from pc to pcwindows for the desktop and kodi systems
|
* Changed the platform from pc to pcwindows for the desktop and kodi systems
|
||||||
* (Linux) Dropped support for prebuilt RPM packages
|
* (Linux) Dropped support for prebuilt RPM packages
|
||||||
* Changed the color scheme names for the bundled Slate and Modern themes from "Dark mode" and "Light mode" to "Dark" and "Light"
|
* Changed the color scheme names for the bundled Slate and Modern themes from "Dark mode" and "Light mode" to "Dark" and "Light"
|
||||||
|
@ -42,6 +44,7 @@ Catch-up release which implements some things that didn't make it into 2.0.0. Mo
|
||||||
|
|
||||||
* (Windows) Fixed a regression that made .bat and .lnk files with some special characters in the filename impossible to launch
|
* (Windows) Fixed a regression that made .bat and .lnk files with some special characters in the filename impossible to launch
|
||||||
* Clearing or deleting a game could hang the application if the media files could not be deleted due to insufficient permissions
|
* Clearing or deleting a game could hang the application if the media files could not be deleted due to insufficient permissions
|
||||||
|
* Using the cropSize property could lead to a crash under very rare circumstances
|
||||||
* Multi-row text with blank lines that was not displayed in a scrollable container was sometimes not wrapped correctly
|
* Multi-row text with blank lines that was not displayed in a scrollable container was sometimes not wrapped correctly
|
||||||
* The default image element property could be used even if no imageType entries were defined
|
* The default image element property could be used even if no imageType entries were defined
|
||||||
* Fixed several potential container overflows in GuiTextEditKeyboardPopup that could lead to rare crashes when running on an ARM processor
|
* Fixed several potential container overflows in GuiTextEditKeyboardPopup that could lead to rare crashes when running on an ARM processor
|
||||||
|
|
|
@ -413,9 +413,9 @@ The process to create a Linux AppImage is completely automated. You simply run t
|
||||||
tools/create_AppImage.sh
|
tools/create_AppImage.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
This script has only been tested on Ubuntu (20.04 LTS and 22.04 LTS) and it's recommended to go for an older operating system when building the AppImage to achieve compatibility with a large number of distributions. This does come with some sacrifices though, such as the use of an older SDL version which may not support the latest game controllers.
|
This script has only been tested on Ubuntu 20.04 LTS and 22.04 LTS. It's generally recommended to go for an older operating system when building the AppImage to achieve compatibility with a larger number of distributions. To build it you need the PipeWire development package installed. The name differs between releases, but for 22.04 LTS it's named _libpipewire-0.3-dev_.
|
||||||
|
|
||||||
The script will delete CMakeCache.txt and run cmake with the BUNDLED_CERTS option, as otherwise scraping wouldn't work on Fedora (and probably not on openSUSE and a few other distributions as well).
|
The script will delete CMakeCache.txt and run cmake with the BUNDLED_CERTS option, as otherwise scraping wouldn't work on some distributions.
|
||||||
|
|
||||||
After creating the AppImage it's recommended to delete CMakeCache.txt manually so the BUNDLED_CERTS option is not accidentally enabled when building the other packages.
|
After creating the AppImage it's recommended to delete CMakeCache.txt manually so the BUNDLED_CERTS option is not accidentally enabled when building the other packages.
|
||||||
|
|
||||||
|
|
|
@ -411,9 +411,9 @@ The process to create a Linux AppImage is completely automated. You simply run t
|
||||||
tools/create_AppImage.sh
|
tools/create_AppImage.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
This script has only been tested on Ubuntu (20.04 LTS and 22.04 LTS) and it's recommended to go for an older operating system when building the AppImage to achieve compatibility with a large number of distributions. This does come with some sacrifices though, such as the use of an older SDL version which may not support the latest game controllers.
|
This script has only been tested on Ubuntu 20.04 LTS and 22.04 LTS. It's generally recommended to go for an older operating system when building the AppImage to achieve compatibility with a larger number of distributions. To build it you need the PipeWire development package installed. The name differs between releases, but for 22.04 LTS it's named _libpipewire-0.3-dev_.
|
||||||
|
|
||||||
The script will delete CMakeCache.txt and run cmake with the BUNDLED_CERTS option, as otherwise scraping wouldn't work on Fedora (and probably not on openSUSE and a few other distributions as well).
|
The script will delete CMakeCache.txt and run cmake with the BUNDLED_CERTS option, as otherwise scraping wouldn't work on some distributions.
|
||||||
|
|
||||||
After creating the AppImage it's recommended to delete CMakeCache.txt manually so the BUNDLED_CERTS option is not accidentally enabled when building the other packages.
|
After creating the AppImage it's recommended to delete CMakeCache.txt manually so the BUNDLED_CERTS option is not accidentally enabled when building the other packages.
|
||||||
|
|
||||||
|
|
|
@ -1493,6 +1493,10 @@ Properties:
|
||||||
* `itemSpacing` - type: NORMALIZED_PAIR
|
* `itemSpacing` - type: NORMALIZED_PAIR
|
||||||
- The horizontal and vertical space between items. This value is added to the unscaled item size, i.e. `itemSize` before it's been multiplied by `itemScale`. This means that if an axis is set to `0` then unscaled items will be perfectly adjacent to each other on that axis but if `itemScale` has been set to higher than `1` then the currently selected item will overlap adjacent items. If this property is omitted then spacing will be automatically calculated so that no overlaps occur during scaling. However you'd normally want to define and adjust this property for an optimal layout. If one of the axis is defined as `-1` then it will be set to the same pixel value as the other axis. Note that all spacing calculations are based on the value defined by `itemSize` which may or may not be the same as the actual image sizes, depending on their aspect ratios and if the `imageFit` property is used.
|
- The horizontal and vertical space between items. This value is added to the unscaled item size, i.e. `itemSize` before it's been multiplied by `itemScale`. This means that if an axis is set to `0` then unscaled items will be perfectly adjacent to each other on that axis but if `itemScale` has been set to higher than `1` then the currently selected item will overlap adjacent items. If this property is omitted then spacing will be automatically calculated so that no overlaps occur during scaling. However you'd normally want to define and adjust this property for an optimal layout. If one of the axis is defined as `-1` then it will be set to the same pixel value as the other axis. Note that all spacing calculations are based on the value defined by `itemSize` which may or may not be the same as the actual image sizes, depending on their aspect ratios and if the `imageFit` property is used.
|
||||||
- Minimum value per axis is `0` and maximum value per axis is `0.1`
|
- Minimum value per axis is `0` and maximum value per axis is `0.1`
|
||||||
|
* `scaleInwards` - type: BOOLEAN
|
||||||
|
- Enabling this property will scale items along the outer grid boundaries towards the center of the grid. This means that it's possible to fill the entire screen width or height while still allowing scaling to take place.
|
||||||
|
- Default is `false`
|
||||||
|
- This property can only be used if `itemScale` is higher than `1`
|
||||||
* `fractionalRows` - type: BOOLEAN
|
* `fractionalRows` - type: BOOLEAN
|
||||||
- Whether to allow rendering of fractional rows of items. If set to false then the effective area of the overall element size will be snapped to the item height multiplied by `itemScale`. Note that if setting `itemScale` too high relative to the `itemSpacing` Y axis value then fractional rows may still be rendered even if the `fractionalRows` property is set to false.
|
- Whether to allow rendering of fractional rows of items. If set to false then the effective area of the overall element size will be snapped to the item height multiplied by `itemScale`. Note that if setting `itemScale` too high relative to the `itemSpacing` Y axis value then fractional rows may still be rendered even if the `fractionalRows` property is set to false.
|
||||||
- Default is `false`
|
- Default is `false`
|
||||||
|
|
Loading…
Reference in a new issue