mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-21 13:45:38 +00:00
Changed the location of the screenshots.
This commit is contained in:
Leon Styhre
parent
3fb96c3115
commit
dc8ba915f6
|
|
@ -10,7 +10,7 @@
|
|||
|
||||
### Detailed list of changes
|
||||
|
||||
* Added alternative emulator support where additional emulators can be defined in es_systems.xml and be selected system-wide or per game via the user interface
|
||||
* Added alternative emulators support where additional emulators can be defined in es_systems.xml and be selected system-wide or per game via the user interface
|
||||
* Added a menu option to change the application exit key combination
|
||||
* Removed the "Choose" entry from the help prompts in the gamelist view
|
||||
* Changed the "Toggle screensaver" help entry in the system view to simply "Screensaver"
|
||||
|
|
|
|||
20
README.md
20
README.md
|
|
@ -80,32 +80,32 @@ If you would like to contribute to the development of ES-DE, then that's great!
|
|||
|
||||
Here are some highlights of what EmulationStation Desktop Edition provides, displayed using the default theme set rbsimple-DE. There are of course many more features available, as covered in the [User guide](USERGUIDE.md).
|
||||
|
||||
|
||||
|
||||
_The **System view**, which is the default starting point for the application, it's here that you browse through your game systems._
|
||||
|
||||
|
||||
|
||||
_The **Gamelist view**, it's here that you browse the games for a specific system. Note the support for mixing files and folders, and as well that favorite games are marked with stars. There is a game counter to the upper right, displaying the total number of games and the number of favorite games for this system._
|
||||
|
||||
|
||||
|
||||
_Another example of the gamelist view, displaying advanced folder support. You can scrape folders for game info and game media, sort folders as you would files, mark them as favorites etc. In this example ES-DE has been configured to sort favorite games above non-favorites._
|
||||
|
||||
|
||||
|
||||
_Games can be grouped into your own custom collections, in this example they're defined as game genres but you can name them anything you like. All gamelist views including the custom collections support both game images or game videos. By default the rbsimple-DE theme will display the game image for a short moment before starting to play the video._
|
||||
|
||||
|
||||
|
||||
_This is a view of the built-in scraper which downloads game info and game media from either [screenscraper.fr](https://screenscraper.fr) or [thegamesdb.net](https://thegamesdb.net). It's possible to scrape a single game, or to run the multi-scraper which can scrape a complete game system or even your entire collection._
|
||||
|
||||
|
||||
|
||||
_There are many settings for the scraper including options to define which type of info and media to download. The above screenshot shows only a portion of these settings._
|
||||
|
||||
|
||||
|
||||
_In addition to the scraper there is a fully-featured metadata editor that can be used to modify information on a per-game basis. Here you can also toggle some additional flags which the scraper does not set, such as if the game is a favorite or if you have completed it. Some of these flags can then be filtered in the gamelist view, letting you for instance only display games that you have not played through._
|
||||
|
||||
|
||||
|
||||
_There are four types of built-in screensavers available, including a slideshow and the video screensaver shown in action above. These screensavers start after a configurable number of minutes of inactivity, and randomly display game media that you have previously scraped. If the corresponding option has been enabled, you can jump to the game from the screensaver, or even start it directly. There is shader support in ES-DE to render scanlines and screen blur on top of the videos (for the slideshow screensaver, scanline rendering is provided)._
|
||||
|
||||
|
||||
|
||||
_ES-DE is fully themeable, so if you prefer another look than what the default theme rbsimple-DE gives you, it's possible to apply another theme set. In the example above a modified version of the [Fundamental](https://github.com/G-rila/es-theme-fundamental) theme is used. Be aware though that although ES-DE is backwards compatible with older EmulationStation themes, some newer features which are specific to ES-DE will not work, at least not until the theme authors update their themes._
|
||||
|
||||
|
||||
|
||||
_A lot of effort has been spent on making ES-DE easy to setup and use. The above screenshot shows the dialog if starting the application without any game files present in the default ROM directory. ES-DE also ships with a comprehensive game systems configuration file, so unless you really want to customize your setup, you should not need to tinker with the configuration._
|
||||
|
|
@ -122,7 +122,7 @@ Note that neither the systeminfo.txt files or the systems.txt file are needed to
|
|||
|
||||
There will be a lot of directories created if using the es_systems.xml file bundled with the installation, so it may be a good idea to remove the ones you don't need. It's recommended to move them to another location to be able to use them later if more systems should be added. For example a directory named _DISABLED could be created inside the ROMs folder (i.e. ~/ROMs/_DISABLED) and all game system directories you don't need could be moved there. Doing this reduces the application startup time as ES-DE would otherwise need to scan for game files for all these systems.
|
||||
|
||||
|
||||
|
||||
_This is the dialog shown if no game files were found. It lets you configure the ROM directory if you don't want to use the default one, and you can also generate the game systems directory structure. Note that the directory is the physical path, and that your operating system may present this as a localized path if you are using a language other than English._
|
||||
|
||||
|
||||
|
|
@ -175,7 +175,7 @@ Depending on the theme, the system navigation carousel can be either horizontal
|
|||
|
||||
The game systems are sorted by their full names, as defined in the es_systems.xml file.
|
||||
|
||||
|
||||
|
||||
_The **System view** is the default starting point for the application, it's here that you browse through your game systems._
|
||||
|
||||
|
||||
|
|
@ -193,10 +193,10 @@ In addition to the styles just described, there is a **Grid** view style as well
|
|||
|
||||
If the theme supports it, there's a gamelist information field displayed in the gamelist view, showing the number of games for the system (total and favorites) as well as a folder icon if a folder has been entered. When applying any filters to the gamelist, the game counter is replaced with the amount of games filtered, as in 'filtered / total games', e.g. '19 / 77'. If there are game entries in the filter result that are marked not to be counted as games, the number of such files will be indicated as 'filtered + filtered non-games / total games', for example '23 + 4 / 77' indicating 23 normal games, 4 non-games out of a total of 77. Due to this approach it's theoretically possible that the combined filtered game amount exceeds the number of counted games in the collection, for instance '69 + 11 / 77'. This is not considered a bug and is so by design. This gamelist information field functionality is specific to EmulationStation Desktop Edition so older themes will not support this.
|
||||
|
||||
|
||||
|
||||
_The **Gamelist view** is where you browse the games for a specific system._
|
||||
|
||||
|
||||
|
||||
_Here's an example of what the Basic view style looks like. Needless to say, ES-DE is not intended to be used like this. After scraping some game media for the system, the view style will automatically change to Detailed or Video (assuming the Automatic view style option has been selected)._
|
||||
|
||||
|
||||
|
|
@ -219,7 +219,7 @@ The application can also be forced into any of the three modes via the command l
|
|||
|
||||
There is a help system available throughout the application that provides an overview of the possible actions and buttons that can be used. But some general actions are never shown, such as the ability to quick jump in gamelists, menus and text input fields using the shoulder and trigger buttons. It's also possible to disable the help system using a menu option for a somewhat cleaner look.
|
||||
|
||||
|
||||
|
||||
_The help system is displayed at the bottom of the screen, showing the various actions currently available._
|
||||
|
||||
|
||||
|
|
@ -621,7 +621,7 @@ The **Multi-language** support includes translated game genres and game descript
|
|||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
_Here's an example of the multi-scraper running in interactive mode, asking the user to make a selection from the multiple matching games returned by the scraper service._
|
||||
|
||||
### Single-game scraper
|
||||
|
|
@ -702,7 +702,7 @@ It's possible to change the game media directory location from within ES-DE, for
|
|||
|
||||
This menu can be accessed from both the system view and gamelist view. It contains the scraper, application settings and various tools such as the input configurator and the miximage generator. Settings are saved when navigating back from any menu screen, assuming at least one setting was changed. Pressing the application exit key (F4 by default) will also save any pending changes.
|
||||
|
||||
|
||||
|
||||
_The ES-DE main menu._
|
||||
|
||||
Following is a breakdown of the main menu entries.
|
||||
|
|
@ -711,7 +711,7 @@ Following is a breakdown of the main menu entries.
|
|||
|
||||
Contains the various options for the scraper, which is used to download metadata, images and videos for your games.
|
||||
|
||||
|
||||
|
||||
_Some of the scraper settings._
|
||||
|
||||
**Scrape from**
|
||||
|
|
@ -1169,7 +1169,7 @@ These are mostly technical settings.
|
|||
|
||||
Using this interface it's possible to select alternative emulators to use per game system, which requires that these alternatives have been defined in the es_systems.xml file. Note that only systems that you have currently populated will be listed. To change to an alternative emulator, you simply select a system from the list and choose which alternative to use from the presented options. If you select an alternative emulator and later remove its corresponding entry from the es_systems.xml file, an error message will be shown on application startup telling you to review your invalid emulator selection. Games will still launch, but the default emulator will be used in this case. How to clear an invalid entry should be self-explanatory once you access the interface. It's also possible to set alternative emulators per game using the metadata editor. If this is done, it will take precedence and override the system-wide emulator selection for the specific game.
|
||||
|
||||
|
||||
|
||||
_The alternative emulators interface._
|
||||
|
||||
**Game media directory**
|
||||
|
|
@ -1281,7 +1281,7 @@ This menu is opened from the gamelist view, and can't be accessed from the syste
|
|||
|
||||
You open the menu using the **Back** button, and by pressing **B** or selecting the **Apply** button any settings such as letter jumping using the quick selector or sorting changes are applied. If you instead press the Back button again or select the **Cancel** button, the menu is closed without applying any changes.
|
||||
|
||||
|
||||
|
||||
_The game options menu as laid out when opening it from within a custom collection, which adds the menu entry to add or remove games from the collection._
|
||||
|
||||
Here's a summary of the menu entries:
|
||||
|
|
@ -1313,7 +1313,7 @@ The secondary sorting is always in ascending filename order.
|
|||
|
||||
Choosing this entry opens a separate screen where it's possible to apply a filter to the gamelist. The filter is persistent throughout the program session, or until it's manually reset. The option to reset all filters is shown on the same screen.
|
||||
|
||||
|
||||
|
||||
_The gamelist filter screen, accessed from the game options menu._
|
||||
|
||||
The following filters can be applied:
|
||||
|
|
@ -1361,7 +1361,7 @@ This opens the metadata editor for the currently selected game file or folder.
|
|||
|
||||
In the metadata editor, you can modify the metadata, scrape for game info and media files, clear the entry which will delete all metadata and game media files, or delete the entire game which also removes its file on the filesystem. When manually modifying a value, it will change color from gray to blue, and if the scraper has changed a value, it will change to red. When leaving the metadata editor you will be asked whether you want to save any settings done manually or by the scraper.
|
||||
|
||||
|
||||
|
||||
_The metadata editor._
|
||||
|
||||
### Metadata entries
|
||||
|
|
@ -1492,7 +1492,7 @@ For the video and slideshow screensavers, an overlay can be enabled via the scre
|
|||
|
||||
If the Video screensaver has been selected and there are no videos available, a fallback to the Dim screensaver will take place. The same is true for the Slideshow screensaver if no game images are available.
|
||||
|
||||
|
||||
|
||||
_An example of what the video screensaver looks like._
|
||||
|
||||
## Game collections
|
||||
|
|
@ -1533,10 +1533,10 @@ When you are done adding games, you can either open the main menu and go to **Ga
|
|||
|
||||
You can later add additional games to the collection by navigating to it, bringing up the game options menu and choosing **Add/remove games to this game collection**.
|
||||
|
||||
|
||||
|
||||
_Example of custom collections, here configured as genres._
|
||||
|
||||
|
||||
|
||||
_When editing a custom collection, a tick symbol will be displayed for any game that is already part of the collection._
|
||||
|
||||
|
||||
|
|
@ -1596,7 +1596,7 @@ https://gitlab.com/recalbox/recalbox-themes
|
|||
|
||||
https://wiki.batocera.org/themes
|
||||
|
||||
|
||||
|
||||
_An example of a modified version of the [Fundamental](https://github.com/G-rila/es-theme-fundamental) theme applied to ES-DE._
|
||||
|
||||
|
||||
|
|
|
|||
30
USERGUIDE.md
30
USERGUIDE.md
|
|
@ -120,7 +120,7 @@ Note that neither the systeminfo.txt files or the systems.txt file are needed to
|
|||
|
||||
There will be a lot of directories created if using the es_systems.xml file bundled with the installation, so it may be a good idea to remove the ones you don't need. It's recommended to move them to another location to be able to use them later if more systems should be added. For example a directory named _DISABLED could be created inside the ROMs folder (i.e. ~/ROMs/_DISABLED) and all game system directories you don't need could be moved there. Doing this reduces the application startup time as ES-DE would otherwise need to scan for game files for all these systems.
|
||||
|
||||
|
||||
|
||||
_This is the dialog shown if no game files were found. It lets you configure the ROM directory if you don't want to use the default one, and you can also generate the game systems directory structure. Note that the directory is the physical path, and that your operating system may present this as a localized path if you are using a language other than English._
|
||||
|
||||
|
||||
|
|
@ -173,7 +173,7 @@ Depending on the theme, the system navigation carousel can be either horizontal
|
|||
|
||||
The game systems are sorted by their full names, as defined in the es_systems.xml file.
|
||||
|
||||
|
||||
|
||||
_The **System view** is the default starting point for the application, it's here that you browse through your game systems._
|
||||
|
||||
|
||||
|
|
@ -191,10 +191,10 @@ In addition to the styles just described, there is a **Grid** view style as well
|
|||
|
||||
If the theme supports it, there's a gamelist information field displayed in the gamelist view, showing the number of games for the system (total and favorites) as well as a folder icon if a folder has been entered. When applying any filters to the gamelist, the game counter is replaced with the amount of games filtered, as in 'filtered / total games', e.g. '19 / 77'. If there are game entries in the filter result that are marked not to be counted as games, the number of such files will be indicated as 'filtered + filtered non-games / total games', for example '23 + 4 / 77' indicating 23 normal games, 4 non-games out of a total of 77. Due to this approach it's theoretically possible that the combined filtered game amount exceeds the number of counted games in the collection, for instance '69 + 11 / 77'. This is not considered a bug and is so by design. This gamelist information field functionality is specific to EmulationStation Desktop Edition so older themes will not support this.
|
||||
|
||||
|
||||
|
||||
_The **Gamelist view** is where you browse the games for a specific system._
|
||||
|
||||
|
||||
|
||||
_Here's an example of what the Basic view style looks like. Needless to say, ES-DE is not intended to be used like this. After scraping some game media for the system, the view style will automatically change to Detailed or Video (assuming the Automatic view style option has been selected)._
|
||||
|
||||
|
||||
|
|
@ -217,7 +217,7 @@ The application can also be forced into any of the three modes via the command l
|
|||
|
||||
There is a help system available throughout the application that provides an overview of the possible actions and buttons that can be used. But some general actions are never shown, such as the ability to quick jump in gamelists, menus and text input fields using the shoulder and trigger buttons. It's also possible to disable the help system using a menu option for a somewhat cleaner look.
|
||||
|
||||
|
||||
|
||||
_The help system is displayed at the bottom of the screen, showing the various actions currently available._
|
||||
|
||||
|
||||
|
|
@ -616,7 +616,7 @@ The **Multi-language** support includes translated game genres and game descript
|
|||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
_Here's an example of the multi-scraper running in interactive mode, asking the user to make a selection from the multiple matching games returned by the scraper service._
|
||||
|
||||
### Single-game scraper
|
||||
|
|
@ -697,7 +697,7 @@ It's possible to change the game media directory location from within ES-DE, for
|
|||
|
||||
This menu can be accessed from both the system view and gamelist view. It contains the scraper, application settings and various tools such as the input configurator and the miximage generator. Settings are saved when navigating back from any menu screen, assuming at least one setting was changed. Pressing the application exit key (F4) will also save any pending changes.
|
||||
|
||||
|
||||
|
||||
_The ES-DE main menu._
|
||||
|
||||
Following is a breakdown of the main menu entries.
|
||||
|
|
@ -706,7 +706,7 @@ Following is a breakdown of the main menu entries.
|
|||
|
||||
Contains the various options for the scraper, which is used to download metadata, images and videos for your games.
|
||||
|
||||
|
||||
|
||||
_Some of the scraper settings._
|
||||
|
||||
**Scrape from**
|
||||
|
|
@ -1257,7 +1257,7 @@ This menu is opened from the gamelist view, and can't be accessed from the syste
|
|||
|
||||
You open the menu using the **Back** button, and by pressing **B** or selecting the **Apply** button any settings such as letter jumping using the quick selector or sorting changes are applied. If you instead press the Back button again or select the **Cancel** button, the menu is closed without applying any changes.
|
||||
|
||||
|
||||
|
||||
_The game options menu as laid out when opening it from within a custom collection, which adds the menu entry to add or remove games from the collection._
|
||||
|
||||
Here's a summary of the menu entries:
|
||||
|
|
@ -1289,7 +1289,7 @@ The secondary sorting is always in ascending filename order.
|
|||
|
||||
Choosing this entry opens a separate screen where it's possible to apply a filter to the gamelist. The filter is persistent throughout the program session, or until it's manually reset. The option to reset all filters is shown on the same screen.
|
||||
|
||||
|
||||
|
||||
_The gamelist filter screen, accessed from the game options menu._
|
||||
|
||||
The following filters can be applied:
|
||||
|
|
@ -1337,7 +1337,7 @@ This opens the metadata editor for the currently selected game file or folder.
|
|||
|
||||
In the metadata editor, you can modify the metadata, scrape for game info and media files, clear the entry which will delete all metadata and game media files, or delete the entire game which also removes its file on the filesystem. When manually modifying a value, it will change color from gray to blue, and if the scraper has changed a value, it will change to red. When leaving the metadata editor you will be asked whether you want to save any settings done manually or by the scraper.
|
||||
|
||||
|
||||
|
||||
_The metadata editor._
|
||||
|
||||
### Metadata entries
|
||||
|
|
@ -1468,7 +1468,7 @@ For the video and slideshow screensavers, an overlay can be enabled via the scre
|
|||
|
||||
If the Video screensaver has been selected and there are no videos available, a fallback to the Dim screensaver will take place. The same is true for the Slideshow screensaver if no game images are available.
|
||||
|
||||
|
||||
|
||||
_An example of what the video screensaver looks like._
|
||||
|
||||
## Game collections
|
||||
|
|
@ -1509,10 +1509,10 @@ When you are done adding games, you can either open the main menu and go to **Ga
|
|||
|
||||
You can later add additional games to the collection by navigating to it, bringing up the game options menu and choosing **Add/remove games to this game collection**.
|
||||
|
||||
|
||||
|
||||
_Example of custom collections, here configured as genres._
|
||||
|
||||
|
||||
|
||||
_When editing a custom collection, a tick symbol will be displayed for any game that is already part of the collection._
|
||||
|
||||
|
||||
|
|
@ -1572,7 +1572,7 @@ https://gitlab.com/recalbox/recalbox-themes
|
|||
|
||||
https://wiki.batocera.org/themes
|
||||
|
||||
|
||||
|
||||
_An example of a modified version of the [Fundamental](https://github.com/G-rila/es-theme-fundamental) theme applied to ES-DE._
|
||||
|
||||
|
||||
|
|
|
|||
|
Before Width: | Height: | Size: 133 KiB After Width: | Height: | Size: 133 KiB |
|
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 82 KiB |
|
Before Width: | Height: | Size: 204 KiB After Width: | Height: | Size: 204 KiB |
|
Before Width: | Height: | Size: 237 KiB After Width: | Height: | Size: 237 KiB |
|
Before Width: | Height: | Size: 328 KiB After Width: | Height: | Size: 328 KiB |
|
Before Width: | Height: | Size: 178 KiB After Width: | Height: | Size: 178 KiB |
|
Before Width: | Height: | Size: 164 KiB After Width: | Height: | Size: 164 KiB |
|
Before Width: | Height: | Size: 212 KiB After Width: | Height: | Size: 212 KiB |
|
Before Width: | Height: | Size: 127 KiB After Width: | Height: | Size: 127 KiB |
|
Before Width: | Height: | Size: 154 KiB After Width: | Height: | Size: 154 KiB |
|
Before Width: | Height: | Size: 156 KiB After Width: | Height: | Size: 156 KiB |
|
Before Width: | Height: | Size: 168 KiB After Width: | Height: | Size: 168 KiB |
|
Before Width: | Height: | Size: 864 KiB After Width: | Height: | Size: 864 KiB |
|
Before Width: | Height: | Size: 95 KiB After Width: | Height: | Size: 95 KiB |
|
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 82 KiB |
|
Before Width: | Height: | Size: 714 KiB After Width: | Height: | Size: 714 KiB |
Loading…
Reference in a new issue