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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2021-10-30 19:11:25 +02:00
parent 7606e9cad6
commit 1e5efc251a
2 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG.md
View file

@ -17,6 +17,9 @@
* Added game-specific controllers that are selectable via the metadata editor and displayed as a controller badge
* Added scraping of title screens, box back covers and physical media images
* Updated the media viewer to display title screens and box back cover images
* Added physical media images to the generated miximages
* Added an option to rotate horizontally oriented game boxes when generating miximages
* Added size options (small/medium/large) for the boxes/covers and physical media images when generating miximages
* Added the ability to make complementary game system customizations without having to replace the entire bundled es_systems.xml file
* Added support for an optional \<systemsortname\> tag for es_systems.xml that can be used to override the default \<fullname\> systems sorting
* Added menu scroll indicators showing if there are additional entries available below or above what's currently shown on screen
@ -110,6 +113,7 @@
* Disabling a collection while its gamelist was displayed would lead to a slide transition from a black screen if a gamelist on startup had been set
* When marking a game to not be counted in the metadata editor and the game was part of a custom collection, no collection disabling notification was displayed
* When running really low on texture memory, the menu texture would not get rendered correctly
* There was a tiny and randomly occuring gap between the system carousel and systemInfo bar during slide transitions between the System and Gamelist views
* SliderComponent had very inconsistent widths at different screen aspect ratios
* SliderComponent did not properly align the knob and bar vertically
* Resizing in SwitchComponent did not reposition the image properly leading to a non-centered image

16
USERGUIDE-DEV.md
View file

@ -841,6 +841,14 @@ It's possible to select betweeen the 1280x960, 1920x1440 and 640x480 resolutions
The _sharp_ scaling method uses nearest-neighbor interpolation which retains sharp pixels and looks better for most low-resolution retro games. The _smooth_ scaling method uses the Lanczos algorithm and produces smoother pixels. This may look better on some more modern games at higher resolutions. If unsure, use the _sharp_ method.
**Box size**
The size of the 3D game box, or the cover image if there is no 3D box and the _Use cover image if 3D box is missing_ setting has been enabled. The available options are _medium, small_ and _large_.
**Physical media size**
The size of the physical media image. The available options are _medium, small_ and _large_.
**Generate miximages when scraping**
Enables or disables the miximage generator when scraping. Applies to both the single-game scraper and the multi-scraper.
@ -857,6 +865,10 @@ With this option enabled, any horizontal pure black areas at the top and bottom
With this option enabled, any vertical pure black areas at the left and right sides of the screenshots are automatically cropped.
**Rotate horizontally oriented boxes**
Some consoles such as Super Nintendo have game boxes with the cover printed horizontally rather than using the more common vertical format. If enabling this setting, those images will be rotated 90 degrees so they stand up like the box images for most other systems.
**Incude marquee image**
Whether to include the marquee (wheel) image in the composite miximage.
@ -869,6 +881,10 @@ Whether to include the box image in the composite miximage. If a 3D box exists f
Whether to use the 2D box cover as fallback if the 3D box image is missing for the game.
**Include physical media image**
Whether to include the image of the physical media used to distribute the game, for example a cartridge, diskette, tape, CD-ROM etc.
**Offline generator**
This is not a setting, but instead a GUI to generate miximages offline without going via the scraper. This tool uses the same game system selections as the scraper, so you need to select at least one system on the scraper menu before attempting to run it. All the miximage settings are applied in the same way as when generating images via the scraper. The prerequisite is that at least a screenshot exists for each game. If there is no screenshot, or if the screenshot is unreadable for some reason, the generation for that specific game will fail. There is statistics shown in the tool displaying the number of generated, overwritten, skipped and failed images. Any error message is also shown on screen as well as being saved to the es_log.txt file.