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 2021-10-28 21:04:37 +02:00
parent d5fa6bc82c
commit 2c34a33ece
2 changed files with 39 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md
View file

@ -15,12 +15,15 @@
* Added a virtual keyboard, partly based on code from batocera-emulationstation * 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 badges that indicate favorite/completed/broken games as well as games suitable for children and those with a selected alternative emulator
* Added game-specific controllers 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 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 the ability to make complementary game system customizations without having to replace the entire bundled es_systems.xml file * 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 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 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) * 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) * Improved the layout of the scraper GUIs (single-game scraper and multi-scraper)
* Added horizontal scrolling of long game names to the scraper GUIs * Added horizontal scrolling of long game names to the scraper GUIs
* Removed the "Scrape" text prefix from the scraper content settings
* 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 * 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 * 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 the ability to filter on blank/unknown values for Genre, Player, Developer, Publisher and Alternative emulator.

50
USERGUIDE-DEV.md
View file

@ -636,14 +636,21 @@ Here's an overview of what's supported when using these scrapers:
| Other game metadata | Yes | Yes | | Other game metadata | Yes | Yes |
| Videos | Yes | No | | Videos | Yes | No |
| Screenshots | Yes | Yes | | Screenshots | Yes | Yes |
| Box covers (2D) | Yes | Yes | | Title screens | Yes | Yes |
| Box covers | Yes | Yes |
| Box back covers | Yes | No |
| Marquees/wheels | Yes | Yes | | Marquees/wheels | Yes | Yes |
| 3D boxes | Yes | No | | 3D boxes | Yes | No |
| Physical media | Yes | No |
The category **Other game metadata** includes Description, Release date, Developer, Publisher, Genre and Players. The category **Other game metadata** includes Description, Release date, Developer, Publisher, Genre and Players.
The **Multi-language** support includes translated game genres and game descriptions for a number of languages. The **Multi-language** support includes translated game genres and game descriptions for a number of languages.
**Controllers** is metadata indicating the controller type (it's not images of controllers).
**Physical media** means images of cartridges, diskettes, tapes, CD-ROMs etc. that were used to distribute the games.
There are two approaches to scraping, either for a single game from the metadata editor, or for many games and systems using the multi-scraper. There are two approaches to scraping, either for a single game from the metadata editor, or for many games and systems using the multi-scraper.
![alt text](images/es-de_scraper_running.png "ES-DE Scraper Running") ![alt text](images/es-de_scraper_running.png "ES-DE Scraper Running")
@ -695,10 +702,13 @@ C:\Users\Myusername\.emulationstation\downloaded_media\c64\screenshots\
The media directories per game system are: The media directories per game system are:
* 3dboxes * 3dboxes
* backcovers
* covers * covers
* marquees * marquees
* miximages * miximages
* physicalmedia
* screenshots * screenshots
* titlescreens
* videos * videos
The miximages are generated by ES-DE. Normally that takes place automatically when scraping, but in this example of manually copying existing media files, the miximage offline generator should be used instead. This tool can generate the miximages for the complete game collection in one go. How that works is explained elsewhere in this guide. The miximages are generated by ES-DE. Normally that takes place automatically when scraping, but in this example of manually copying existing media files, the miximage offline generator should be used instead. This tool can generate the miximages for the complete game collection in one go. How that works is explained elsewhere in this guide.
@ -771,41 +781,53 @@ The password as registered on screenscraper.fr. This is masked using asterisks o
Describes the content types to include in the scraping. Describes the content types to include in the scraping.
**Scrape game names** **Game names**
Whether to scrape the names of the games. This does not affect the actual files on the filesystem and the game name is primarily used for appearance and sorting purposes. The downloaded media files are matched against the physical game files on the filesystem, and not against this metadata. See the comments under _Overwrite files and data_ below to understand some additional implications regarding game names. Whether to scrape the names of the games. This does not affect the actual files on the filesystem and the game name is primarily used for appearance and sorting purposes. The downloaded media files are matched against the physical game files on the filesystem, and not against this metadata. See the comments under _Overwrite files and data_ below to understand some additional implications regarding game names.
**Scrape ratings** _(ScreenScraper only)_ **Ratings** _(ScreenScraper only)_
Downloads game ratings. Downloads game ratings.
**Scrape controllers (arcade systems only)** _(ScreenScraper only)_ **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_. 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** **Other metadata**
This includes the game description, release date, developer, publisher, genre and the number of players. This includes the game description, release date, developer, publisher, genre and the number of players.
**Scrape videos** _(ScreenScraper only)_ **Videos** _(ScreenScraper only)_
Videos of actual gameplay. Videos of actual gameplay.
**Scrape screenshot images** **Screenshot images**
Screenshot images of actual gameplay. Screenshot images of actual gameplay.
**Scrape box cover images** **Title screen images**
Cover art. Screenshot images of the title screen.
**Scrape marquee (wheel) images** **Box cover images**
Cover art, front of box/case.
**Box back cover images** _(ScreenScraper only)_
Back of box/case.
**Marquee (wheel) images**
Logotype for the game. Logotype for the game.
**Scrape 3D box images** _(ScreenScraper only)_ **3D box images** _(ScreenScraper only)_
These are primarily used for generating miximages. These are only used for generating miximages.
**Physical media images** _(ScreenScraper only)_
Images of cartridges, diskettes, tapes, CD-ROMs etc. that were used to distribute the games. These are only used for generating miximages.
#### Miximage settings #### Miximage settings
@ -1027,9 +1049,9 @@ Whether to use a shader to render scanlines for the videos. Be aware that this i
Whether to use a shader to render a slight horizontal blur which somewhat simulates a well-used CRT monitor. Be aware that this is quite demanding for the GPU. Whether to use a shader to render a slight horizontal blur which somewhat simulates a well-used CRT monitor. Be aware that this is quite demanding for the GPU.
**Render scanlines for screenshots** _(OpenGL renderer only)_ **Render scanlines for screenshots and titles** _(OpenGL renderer only)_
Whether to use a shader to render scanlines for the screenshot images. Whether to use a shader to render scanlines for the screenshot and title screen images.
#### Screensaver settings #### Screensaver settings