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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2021-10-27 20:05:48 +02:00
parent 56362af7f8
commit d21688ebda
3 changed files with 26 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CHANGELOG.md
View file

@ -14,16 +14,17 @@
* Populated the bundled es_systems.xml files with alternative emulator entries for most RetroArch cores
* Added a virtual keyboard, partly based on code from batocera-emulationstation
* Added badges that indicate favorite/completed/broken games as well as games suitable for children and those with a selected alternative emulator
* Added game-specific controller images that are selectable via the metadata editor and displayed as a controller badge
* Added game-specific controllers that are selectable via the metadata editor and displayed as a controller badge
* 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
* Added scraping of controller metadata (only for ScreenScraper and only for arcade systems)
* Improved the layout of the scraper GUIs (single-game scraper and multi-scraper)
* Added horizontal scrolling of long game names to the scraper GUIs
* Improved the gamelist filter screen to not allow filtering of values where there is no actual data to filter, e.g. Favorites for a system with no favorite games
* Grayed out all fields in the gamelist filter screen where there is no data to filter, previously some fields were removed entirely and some could still be used
* Added the ability to filter on blank/unknown values for Genre, Player, Developer, Publisher and Alternative emulator.
* Added filters for "Alternative emulator" and "Controller badges" and sorted the filters in the same order as the metadata editor fields
* Added filters for "Controller" and "Alternative emulator" and sorted the filters in the same order as the metadata editor fields
* Added a menu option to change the application exit key combination
* Added an option to preload the gamelists on startup which leads to smoother navigation when first entering each gamelist
* Lowered the minimum supported screen resolution from 640x480 to 224x224 to support arcade cabinet displays such as those running at 384x224 and 224x384
@ -81,6 +82,7 @@
* When scraping in interactive mode, the game counter was not decreased when skipping games, making it impossible to skip the final games in the queue
* When scraping in interactive mode, "No games found" results could be accepted using the "A" button
* When scraping in interactive mode, any refining done using the "Y" button shortcut would not be shown when doing another refine using the "Refine search" button
* The multi-scraper did not update the filter index
* Fixed multiple minor rendering issues where graphics would be slightly cut off or incorrectly resized
* Under some circumstances ScrollableContainer (used for the game descriptions) would contain a partially rendered bottom line
* If the TextListComponent height was not evenly dividable by the font height + line spacing, a partial bottom row would get rendered
@ -104,6 +106,7 @@
* Really long theme set names would not get abbreviated in the UI settings menu, leading to a garbled "Theme set" setting row
* 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
* 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

4
THEMES-DEV.md
View file

@ -947,7 +947,7 @@ It's strongly recommended to use the same image dimensions for all badges as var
- A badge icon override. Specify the badge type in the attribute `badge`. The available badges are the ones listed above.
* `customControllerIcon` - type: PATH.
- A controller icon override. Specify the controller type in the attribute `controller`. These are the available types:
- `gamepad_generic`, `gamepad_xbox`, `gamepad_playstation`, `gamepad_nintendo_nes`, `gamepad_nintendo_snes`, `gamepad_nintendo_64`, `joystick_generic`, `joystick_arcade_2_buttons`, `joystick_arcade_3_buttons`, `joystick_arcade_4_buttons`, `joystick_arcade_6_buttons`, `trackball_generic`, `lightgun_generic`, `lightgun_nintendo`, `keyboard_generic`, `mouse_generic`, `mouse_amiga`, `keyboard_mouse_generic`, `steering_wheel_generic`, `wii_remote_nintendo`, `wii_remote_nunchuck_nintendo`, `joycon_left_or_right_nintendo`, `joycon_pair_nintendo`, `unknown`.
- `gamepad_generic`, `gamepad_xbox`, `gamepad_playstation`, `gamepad_nintendo_nes`, `gamepad_nintendo_snes`, `gamepad_nintendo_64`, `joystick_generic`, `joystick_arcade_no_buttons`, `joystick_arcade_1_button`, `joystick_arcade_2_buttons`, `joystick_arcade_3_buttons`, `joystick_arcade_4_buttons`, `joystick_arcade_5_buttons`, `joystick_arcade_6_buttons`, `flight_stick_generic`, `spinner_generic`, `trackball_generic`, `lightgun_generic`, `lightgun_nintendo`, `keyboard_generic`, `mouse_generic`, `mouse_amiga`, `keyboard_and_mouse_generic`, `steering_wheel_generic`, `wii_remote_nintendo`, `wii_remote_and_nunchuk_nintendo`, `joycon_left_or_right_nintendo`, `joycon_pair_nintendo`, `unknown`.
* `visible` - type: BOOLEAN.
- If true, component will be rendered, otherwise rendering will be skipped. Can be used to hide elements from a particular view.
* `zIndex` - type: FLOAT.
@ -988,7 +988,7 @@ It's strongly recommended to use the same image dimensions for all badges as var
* `zIndex` - type: FLOAT.
- z-index value for component. Components will be rendered in order of z-index value from low to high.
* `legacyZIndexMode` - type: BOOLEAN
- If true, the carousel will ignore zIndex and always render on top of other components.
- If true, the carousel will ignore zIndex and always render on top of other components. Default is `true`.
The help system is a special element that displays a context-sensitive list of actions the user can take at any time. You should try and keep the position constant throughout every screen. Keep in mind the "default" settings (including position) are used whenever the user opens a menu.

33
USERGUIDE-DEV.md
View file

@ -626,18 +626,19 @@ ES-DE supports the two scrapers [ScreenScraper.fr](https://www.screenscraper.fr)
Here's an overview of what's supported when using these scrapers:
| Media type or option | ScreenScraper | TheGamesDB |
| :----------------------- | :-----------: | :--------: |
| Region (EU/JP/US/WOR) | Yes | No |
| Multi-language | Yes | No |
| Game names | Yes | Yes |
| Ratings | Yes | No |
| Other game metadata | Yes | Yes |
| Videos | Yes | No |
| Screenshots | Yes | Yes |
| Box covers (2D) | Yes | Yes |
| Marquees/wheels | Yes | Yes |
| 3D boxes | Yes | No |
| Media type or option | ScreenScraper | TheGamesDB |
| :-------------------------------- | :-----------: | :--------: |
| Region (EU/JP/US/WOR) | Yes | No |
| Multi-language | Yes | No |
| Game names | Yes | Yes |
| Ratings | Yes | No |
| Controllers (arcade systems only) | Yes | No |
| Other game metadata | Yes | Yes |
| Videos | Yes | No |
| Screenshots | Yes | Yes |
| Box covers (2D) | Yes | Yes |
| Marquees/wheels | Yes | Yes |
| 3D boxes | Yes | No |
The category **Other game metadata** includes Description, Release date, Developer, Publisher, Genre and Players.
@ -778,6 +779,10 @@ Whether to scrape the names of the games. This does not affect the actual files
Downloads game ratings.
**Scrape controllers (arcade systems only)** _(ScreenScraper only)_
Scrapes controller metadata which is used to set the correct controller badge. This is only available for MAME arcade games, for systems such as _arcade_, _mame_, _neogeo_, _fba_ etc. This is so because ScreenScraper does not seem to provide controller information for other platforms. The type of controllers that are scraped are _joystick_ (separated into entries from no buttons up to 6 buttons), _steering wheel_, _flight stick_, _spinner_, _trackball_ and _lightgun_.
**Scrape other metadata**
This includes the game description, release date, developer, publisher, genre and the number of players.
@ -1376,7 +1381,7 @@ The following filters can be applied:
**Broken**
**Controller badge**
**Controller**
**Alternative emulator**
@ -1482,7 +1487,7 @@ This option will hide most metadata fields as well as any badges. The intention
A statistics counter that tracks how many times you have played the game. You normally don't need to touch this, but if you want to, the possibility is there.
**Controller badge**
**Controller**
This entry provides a selection of controller icons that are built into ES-DE (although the theme set can override the actual graphics files). The selected icon will be displayed as a badge if the current theme set support badges. This functionality is only cosmetic and will not affect the actual emulators.