mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-21 13:45:38 +00:00
Documentation update.
This commit is contained in:
Leon Styhre
parent
e8e7465935
commit
b19527633f
|
|
@ -160,16 +160,20 @@ v1.2 maintenance release.
|
|||
* Added the Gearcoleco RetroArch core for the colecovision system and set it as the default emulator
|
||||
* Added DOSBox-X standalone as an alternative emulator for the dos and pc systems
|
||||
* Added AetherSX2 standalone as an alternative emulator for the ps2 system on macOS
|
||||
* Added the file extensions .ciso, .dump, .gz, .m3u, .mdf, .img and .nrg to the ps2 system
|
||||
* Added the "citra" binary for Citra standalone on Linux (makes it possible to use the repository or AUR release)
|
||||
* Changed the steam platform to use the ScreenScraper "PC Windows" platform ID
|
||||
* Added a new pcwindows platform for scraping PC (Windows) games
|
||||
* Changed the platform to pcwindows for the epic system
|
||||
* Added scraper support for the platforms arcadia (Emerson Arcadia 2001) and crvision (VTech CreatiVision)
|
||||
* Enabled screensaver controls when running in Kid UI mode
|
||||
* Added custom event script triggers on application startup, screensaver start and screensaver end
|
||||
* Added a --create-systemdirs command line option to generate the game system directories
|
||||
* Added a --create-system-dirs command line option to generate the game system directories
|
||||
* Added an Xbox Kinect controller badge icon
|
||||
* (macOS) Categorized the application as a game so it shows up in the Launchpad games section
|
||||
* Replaced the explicit shell commands in es_systems.xml with %EMULATOR_OS-SHELL% find rules
|
||||
* Added a new %GAMEDIR% variable to be used in conjunction with the %STARTDIR% variable (required by OpenBOR)
|
||||
* Added a %GAMEDIR% variable that expands to the game directory (required by Hypseus Singe)
|
||||
* Made the %GAMEDIR% variable usable with the %STARTDIR% variable (required by OpenBOR)
|
||||
* (Windows) Set %RUNINBACKGROUND% when launching MAME standalone as this emulator may otherwise hang on exit
|
||||
* (Windows) Added an %ESCAPESPECIALS% variable that escapes the special characters &()^=;,
|
||||
* (Windows) Added %ESCAPESPECIALS% to the desktop, epic, kodi, ports and steam systems
|
||||
|
|
@ -181,6 +185,7 @@ v1.2 maintenance release.
|
|||
* Chinese characters would sometimes not render correctly
|
||||
* The "Jump to.." quick selector didn't work correctly with multi-byte Unicode characters
|
||||
* All games were included in the video and slideshow screeensavers when in Kid UI mode
|
||||
* The %BASENAME% variable didn't work correctly with the "Directories interpreted as files" functionality
|
||||
* The game-end event was triggered immediately on game launch if running in the background
|
||||
* The "quit" custom event script trigger was not executed when quitting the application using the quit key combo
|
||||
* (Linux) Flatpak directories were missing for user installations of the standalone emulators BlastEm, Play! and Snes9x
|
||||
|
|
|
|||
|
|
@ -111,8 +111,6 @@ https://wiki.mozilla.org/CA
|
|||
|
||||
# slate-DE theme set
|
||||
|
||||
Original vector graphics by Matthew Stapleton
|
||||
|
||||
Recalbox Multi (slate-DE is based on this theme, using assets from before their change to a more restrictive license in 2018) \
|
||||
https://gitlab.com/recalbox/recalbox-themes
|
||||
|
||||
|
|
|
|||
8
FAQ.md
8
FAQ.md
|
|
@ -18,7 +18,7 @@ ES-DE runs on Windows, macOS and BSD Unix as well as on multiple Linux distribut
|
|||
|
||||
## What is the relationship between ES-DE and EmuDeck?
|
||||
|
||||
ES-DE and EmuDeck are completely different projects, but we are friends and we collaborate to give the best possible user experience. EmuDeck is an installation script that downloads emulators and applies configuration to these, and it can also download and install ES-DE. EmuDeck is not needed to run ES-DE, but on the Steam Deck it provides a fast and convenient way of setting up an emulator environment, so its use is recommended.
|
||||
ES-DE and EmuDeck are completely separate projects, but we collaborate to give the best possible user experience. EmuDeck is an installation script that downloads emulators and applies configuration to these, and it can also download and install ES-DE. EmuDeck is not needed to run ES-DE, but on the Steam Deck it provides a convenient way of setting up an emulator environment.
|
||||
|
||||
## What systems/platforms and emulators are supported by ES-DE?
|
||||
|
||||
|
|
@ -38,7 +38,7 @@ You're probably missing the OpenGL drivers required to run ES-DE. Try to downloa
|
|||
|
||||
## The emulators don't seem to be properly configured?
|
||||
|
||||
ES-DE acts strictly as a frontend, it does not interfere with the emulator configuration. The only instance when ES-DE passes specific options to an emulator is when there is no choice, like when fullscreen mode can't be enabled except via a command line option, or when a flag is needed to place the emulator in batch mode to work properly with a frontend. So you need to configure your emulators separately. This includes your controllers as well since the controller configuration inside ES-DE will have no effect on the emulators. You could of course also use an automated tool to setup your emulator environment, such as using EmuDeck on the Steam Deck.
|
||||
ES-DE acts strictly as a frontend, it does not interfere with the emulator configuration. The only instance when ES-DE passes specific options to an emulator is when there is no choice, like when fullscreen mode can't be enabled except via a command line option, or when a flag is needed to place the emulator in batch mode to work properly with a frontend. So you need to configure your emulators separately. This includes your controllers as well since the controller configuration inside ES-DE will have no effect on the emulators.
|
||||
|
||||
## On game launch the screen just flashes black and the game won't start, how do I solve this?
|
||||
|
||||
|
|
@ -56,10 +56,6 @@ Yes, as from version 1.2.3 there is support to display such games as single entr
|
|||
|
||||
See the question above for a possible solution. Another approach would be to hide the game files you don't want to see using the metadata editor. Yet another solution which is actually recommended is to convert your games to the .chd format. This combines the .bin/.cue files into a single file that is also compressed, leading to space savings. A custom systems configuration entry could also be created, but that is not really recommended or required due to the solutions just mentioned. The reason why .bin files are included in the first place is that some emulators can launch these files directly, and some users have game collections comprised of such files. If the .bin files were filtered out in the bundled configuration, then all these users would have their games removed from within ES-DE next time they upgrade the application.
|
||||
|
||||
## Can I "flatten" directories to not show them as folders inside ES-DE?
|
||||
|
||||
No.
|
||||
|
||||
## When I hide a game using the metadata editor it's not really getting hidden, is this a bug?
|
||||
|
||||
No, by default games are not removed from the gamelists when they are hidden and are instead only marked with a much lower text opacity. You need to disable the setting _Show hidden games (requires restart)_ from the _Other settings_ menu to make them disappear entirely. The reason this option is not disabled by default is that new users could very easily make a mistake by hiding some files accidentally without realizing it, only to have the entries being immediately removed from the gamelist view. It's also good practice to hide all your games with this option enabled and verify that it's all correct before going ahead and disabling it.
|
||||
|
|
|
|||
|
|
@ -1059,7 +1059,7 @@ You can use **--help** or **-h** to view the list of command line options, as sh
|
|||
--force-kiosk Force the UI mode to Kiosk
|
||||
--force-kid Force the UI mode to Kid
|
||||
--force-input-config Force configuration of input device
|
||||
--create-systemdirs Create game system directories
|
||||
--create-system-dirs Create game system directories
|
||||
--home [path] Directory to use as home path
|
||||
--debug Print debug information
|
||||
--version, -v Display version information
|
||||
|
|
@ -1070,7 +1070,7 @@ As you can see above, you can override the home directory path using the `--home
|
|||
|
||||
Setting the resolution to a lower or higher value than the display resolution will add a border to the application window.
|
||||
|
||||
Running with the --create-systemdirs option will generate all the game system directories in the ROMs folder. This is equivalent to starting ES-DE with no game ROMs present and pressing the _Create directories_ button. Detailed output for the directory creation will be available in es_log.txt and the application will quit immediately after the directories have been created.
|
||||
Running with the --create-system-dirs option will generate all the game system directories in the ROMs folder. This is equivalent to starting ES-DE with no game ROMs present and pressing the _Create directories_ button. Detailed output for the directory creation will be available in es_log.txt and the application will quit immediately after the directories have been created.
|
||||
|
||||
For the following options, the es_settings.xml file is immediately updated/saved when passing the parameter:
|
||||
```
|
||||
|
|
@ -1236,6 +1236,8 @@ The following variables are expanded for the `command` tag:
|
|||
|
||||
`%EMUDIR%` - Replaced with the path to the emulator binary. This is a general purpose variable as opposed to %EMUPATH% which is intended specifically for core locations.
|
||||
|
||||
`%GAMEDIR%` - Replaced with the path to the game.
|
||||
|
||||
`%ESPATH%` - Replaced with the path to the ES-DE binary. Mostly useful for portable emulator installations, for example on a USB memory stick.
|
||||
|
||||
`%EMULATOR_` - This utilizes the emulator find rules as defined in `es_find_rules.xml`. This is the recommended way to configure the launch command. The find rules are explained in more detail below.
|
||||
|
|
@ -1819,7 +1821,7 @@ Just make sure to not place the portable installation on a network share that us
|
|||
|
||||
## Custom event scripts
|
||||
|
||||
There are numerous locations throughout ES-DE where custom scripts will be executed if the option to do so has been enabled in the settings. You'll find the option on the Main menu under _Other settings_. By default this setting is deactivated so make sure to enable it to use this feature.
|
||||
There are numerous locations throughout ES-DE where custom scripts can be executed if the option to do so has been enabled in the settings. You'll find the option _Enable custom event scripts_ on the Main menu under _Other settings_. By default this setting is deactivated so make sure to enable it to use this feature.
|
||||
|
||||
The approach is quite straightforward, ES-DE will look for any files inside a script directory that corresponds to the event that is triggered and will then execute all these files. There are up to four parameters that will be passed to these scripts, as detailed below:
|
||||
|
||||
|
|
|
|||
|
|
@ -1355,7 +1355,7 @@ You can use **--help** or **-h** to view the list of command line options, as sh
|
|||
--force-kiosk Force the UI mode to Kiosk
|
||||
--force-kid Force the UI mode to Kid
|
||||
--force-input-config Force configuration of input device
|
||||
--create-systemdirs Create game system directories
|
||||
--create-system-dirs Create game system directories
|
||||
--home [path] Directory to use as home path
|
||||
--debug Print debug information
|
||||
--version, -v Display version information
|
||||
|
|
@ -1366,7 +1366,7 @@ As you can see above, you can override the home directory path using the `--home
|
|||
|
||||
Setting the resolution to a lower or higher value than the display resolution will add a border to the application window.
|
||||
|
||||
Running with the --create-systemdirs option will generate all the game system directories in the ROMs folder. This is equivalent to starting ES-DE with no game ROMs present and pressing the _Create directories_ button. Detailed output for the directory creation will be available in es_log.txt and the application will quit immediately after the directories have been created.
|
||||
Running with the --create-system-dirs option will generate all the game system directories in the ROMs folder. This is equivalent to starting ES-DE with no game ROMs present and pressing the _Create directories_ button. Detailed output for the directory creation will be available in es_log.txt and the application will quit immediately after the directories have been created.
|
||||
|
||||
For the following options, the es_settings.xml file is immediately updated/saved when passing the parameter:
|
||||
```
|
||||
|
|
|
|||
|
|
@ -713,7 +713,7 @@ This setup is of course entirely optional, you can also leave the directories as
|
|||
|
||||
### Directories interpreted as files
|
||||
|
||||
There are two scenarios where it's useful to interpret directories as files inside ES-DE. The first one is to hide the directory structure for multi-disc games and similar while still being able to directly launch files inside these folders, and the second is that some emulators support passing a directory rather than an individual file as the game ROM argument.
|
||||
There are two scenarios where it's useful to interpret directories as files inside ES-DE. The first one is to hide the directory structure for multi-file/multi-disc games while still being able to directly launch files inside these folders, and the second is that some emulators support passing a directory rather than an individual file as the game ROM argument.
|
||||
|
||||
In both cases, renaming a directory to one of the supported file extensions will automatically make ES-DE interpret it as a file. This means that the directory can be part of the automatic collections and any custom collections.
|
||||
|
||||
|
|
@ -759,20 +759,20 @@ Also in this case the directory will be displayed as a regular game file inside
|
|||
|
||||
### Folder flattening
|
||||
|
||||
**This functionality is unsupported and experimental and may cause all sorts of issues including corrupting your gamelist.xml files, so make sure to have backups of your data prior to attempting to use this.**
|
||||
**This functionality is experimental and may cause all sorts of issues including corrupting your gamelist.xml files, so make sure to have backups of your data prior to attempting to use this.**
|
||||
|
||||
ES-DE works according to the filesystem paradigm used on most operating systems, meaning the file and directory structure of your ROMs directory is reflected inside the application. So if you create a directory on the filesystem and place some games in there, it will be reflected inside ES-DE as a folder that you can enter and launch games from.
|
||||
|
||||
A slight exception to this is the _Directories interpreted as files_ functionality where you can display a folder as a single entry. But even then, the basic directory structure is retained.
|
||||
|
||||
However, some users have a setup where they have separated games inside their systems into folders but would still want to see these as a flat structure in ES-DE. While this is possible to accomplish, it's strongly discouraged as it will cause multiple issues:
|
||||
However, some users have a setup where they have separated games inside their systems into folders but would still want to see these as a flat structure in ES-DE. While this is possible to accomplish, it's discouraged as it will cause multiple issues:
|
||||
* It completely disables folder support for the system
|
||||
* Any identically named files will be added only once in a semi-random fashion, meaning you could miss a lot of games
|
||||
* Any identically named files will be added only once in a semi-random fashion, meaning you could miss some games
|
||||
* If there is metadata available for multiple games with the same filename (which could happen if scraping was done prior to flattening the folders) then the behavior is undefined and metadata from the wrong game may get used
|
||||
* Some systems like MS-DOS and ScummVM may be completely broken
|
||||
* The setup may cause confusion when reorganizing your collection and similar as what you'll see inside ES-DE will not reflect what you see if navigating the ROM directory in your operating system's file manager
|
||||
|
||||
Again, it's not recommended to flatten the folder structure, only enable this functionality if you know exactly what you're doing and understand the adverse side effects mentioned above. If you have any name collisions in your directory structure then make sure to rename each file to have a unique name. Also delete your gamelist.xml file and rescrape the entire system after fixing any collisions as it's otherwise random which metadata will be used for those games.
|
||||
Only enable this functionality if you know exactly what you're doing and understand the adverse side effects mentioned above. If you have any name collisions in your directory structure then make sure to rename each file to have a unique name. Also delete your gamelist.xml file and rescrape the entire system after fixing any collisions as it's otherwise random which metadata will be used for those games.
|
||||
|
||||
If you still want to go ahead and enable folder flattening, then place an empty file named `flatten.txt` in the root of each system where you would like to have this applied.
|
||||
|
||||
|
|
@ -1336,6 +1336,20 @@ For this example, the filename structure needs to look like the following:
|
|||
~/.emulationstation/downloaded_media/c64/videos/Multidisk/Last Ninja 2/Last Ninja 2.mp4
|
||||
```
|
||||
|
||||
Note that there is seemingly an exception to this logic if the _Directories interpreted as files_ functionality has been used, in which case the "file extension" added to the directory is also included in the game media filenames. Take for example the following ScummVM game:
|
||||
```
|
||||
~/ROMs/scummvm/dig.scummvm/dig.scummvm
|
||||
```
|
||||
|
||||
The media files for this directory which is interpreted as a file will be:
|
||||
|
||||
```
|
||||
~/.emulationstation/downloaded_media/scummvm/screenshots/dig.scummvm.png
|
||||
~/.emulationstation/downloaded_media/scummvm/videos/dig.scummvm.mp4
|
||||
```
|
||||
|
||||
This is not a bug as these are not really file extensions after all, it's just a directory with a dot in the filename that happens to look like a file extension because that's how the _Directories interpreted as files_ logic works.
|
||||
|
||||
For images .jpg and .png file extensions are supported and for videos .avi, .mkv, .mov, .mp4 and .wmv are supported.
|
||||
|
||||
Remember that on Unix filenames are case sensitive, and as well the file extensions must be in lower case, such as .png instead of .PNG or .Png or the file won't be found.
|
||||
|
|
|
|||
16
USERGUIDE.md
16
USERGUIDE.md
|
|
@ -729,7 +729,7 @@ This setup is of course entirely optional, you can also leave the directories as
|
|||
|
||||
### Directories interpreted as files
|
||||
|
||||
There are two scenarios where it's useful to interpret directories as files inside ES-DE. The first one is to hide the directory structure for multi-disc games and similar while still being able to directly launch files inside these folders, and the second is that some emulators support passing a directory rather than an individual file as the game ROM argument.
|
||||
There are two scenarios where it's useful to interpret directories as files inside ES-DE. The first one is to hide the directory structure for multi-file/multi-disc games while still being able to directly launch files inside these folders, and the second is that some emulators support passing a directory rather than an individual file as the game ROM argument.
|
||||
|
||||
In both cases, renaming a directory to one of the supported file extensions will automatically make ES-DE interpret it as a file. This means that the directory can be part of the automatic collections and any custom collections.
|
||||
|
||||
|
|
@ -1216,6 +1216,20 @@ For this example, the filename structure needs to look like the following:
|
|||
~/.emulationstation/downloaded_media/c64/videos/Multidisk/Last Ninja 2/Last Ninja 2.mp4
|
||||
```
|
||||
|
||||
Note that there is seemingly an exception to this logic if the _Directories interpreted as files_ functionality has been used, in which case the "file extension" added to the directory is also included in the game media filenames. Take for example the following ScummVM game:
|
||||
```
|
||||
~/ROMs/scummvm/dig.scummvm/dig.scummvm
|
||||
```
|
||||
|
||||
The media files for this directory which is interpreted as a file will be:
|
||||
|
||||
```
|
||||
~/.emulationstation/downloaded_media/scummvm/screenshots/dig.scummvm.png
|
||||
~/.emulationstation/downloaded_media/scummvm/videos/dig.scummvm.mp4
|
||||
```
|
||||
|
||||
This is not a bug as these are not really file extensions after all, it's just a directory with a dot in the filename that happens to look like a file extension because that's how the _Directories interpreted as files_ logic works.
|
||||
|
||||
For images .jpg and .png file extensions are supported and for videos .avi, .mkv, .mov, .mp4 and .wmv are supported.
|
||||
|
||||
Remember that on Unix filenames are case sensitive, and as well the file extensions must be in lower case, such as .png instead of .PNG or .Png or the file won't be found.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ Some graphics was also taken from the carbon theme by Rookervik.
|
|||
|
||||
## Original vector graphics for slate-DE
|
||||
|
||||
- Matthew Stapleton
|
||||
- Leon Styhre
|
||||
|
||||
## recalbox-multi
|
||||
|
|
|
|||
Loading…
Reference in a new issue