mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-25 07:35:38 +00:00
Documentation update.
This commit is contained in:
Leon Styhre
parent
b389e0824a
commit
302d9b7b85
|
|
@ -161,6 +161,8 @@ v1.2 maintenance release.
|
||||||
* Added the Gearcoleco RetroArch core for the colecovision system and set it as the default emulator
|
* 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 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 AetherSX2 standalone as an alternative emulator for the ps2 system on macOS
|
||||||
|
* Added the Flycast RetroArch core and Flycast Standalone as alternative emulators for the arcade and mame systems
|
||||||
|
* Added Atari800 standalone as an alternative emulator for the atarixe system
|
||||||
* Added the file extensions .ciso, .dump, .gz, .m3u, .mdf, .img and .nrg to the ps2 system
|
* 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)
|
* 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
|
* Changed the steam platform to use the ScreenScraper "PC Windows" platform ID
|
||||||
|
|
@ -188,6 +190,9 @@ v1.2 maintenance release.
|
||||||
* The "Jump to.." quick selector didn't work correctly with multi-byte Unicode characters
|
* 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
|
* 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 %BASENAME% variable didn't work correctly with the "Directories interpreted as files" functionality
|
||||||
|
* Under very rare circumstances, games and folders could get mixed up during gamelist.xml parsing
|
||||||
|
* The scroll indicators would sometimes not work correctly in the Alternative Emulators screen
|
||||||
|
* Fixed a minor rounding issue which sometimes led to the menu scroll indicators not being positioned correctly
|
||||||
* The game-end event was triggered immediately on game launch if running in the background
|
* 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
|
* 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
|
* (Linux) Flatpak directories were missing for user installations of the standalone emulators BlastEm, Play! and Snes9x
|
||||||
|
|
|
||||||
8
FAQ.md
8
FAQ.md
|
|
@ -24,14 +24,14 @@ ES-DE and EmuDeck are completely separate projects, but we collaborate to give t
|
||||||
|
|
||||||
See the _Supported game systems_ section at the bottom of the [User guide](USERGUIDE.md#supported-game-systems) where there's a table listing all supported systems/platforms and emulators.
|
See the _Supported game systems_ section at the bottom of the [User guide](USERGUIDE.md#supported-game-systems) where there's a table listing all supported systems/platforms and emulators.
|
||||||
|
|
||||||
|
## Why can't I press the up button in menus to jump to the bottom row and vice versa?
|
||||||
|
|
||||||
|
Menus in ES-DE are not lists but grids, sometimes there is only a list but sometimes there are buttons beneath the list. Enabling the up and down buttons to wrap around would therefore not work consistently as it would sometimes jump to the last row of the list and sometimes to a button, depending on the menu layout. This type of contextual navigation feels very weird in practice. The solution is instead to use the shoulder buttons (which will jump six rows), or the trigger buttons (which will jump to the first and last row). These buttons work consistently throughout the application and avoid the strange side effects just mentioned. If you observe this more closely you will also realize that "wrap around" is very rare in GUI design, you don't jump to the top of a web page when you scroll to the bottom and likewise the settings menus of your mobile phone will not wrap around.
|
||||||
|
|
||||||
## I don't like the default emulator for a certain system, how can I choose an alternative?
|
## I don't like the default emulator for a certain system, how can I choose an alternative?
|
||||||
|
|
||||||
ES-DE comes preconfigured with support for many alternative emulators, see the [What's new in ES-DE v1.2](https://www.youtube.com/watch?v=rpnMJqceSNk) video on the ES-DE YouTube channel for a brief overview of how this works. More emulators are continuously being added with each release.
|
ES-DE comes preconfigured with support for many alternative emulators, see the [What's new in ES-DE v1.2](https://www.youtube.com/watch?v=rpnMJqceSNk) video on the ES-DE YouTube channel for a brief overview of how this works. More emulators are continuously being added with each release.
|
||||||
|
|
||||||
## Why can't I press the up button in menus to jump to the bottom row and vice versa?
|
|
||||||
|
|
||||||
Menus in ES-DE are not lists but grids, sometimes there is only a list but sometimes there are buttons beneath the list. Enabling the up and down buttons to wrap around would therefore not work consistently as it would sometimes jump to the last row of the list and sometimes to a button, depending on the menu layout. This type of contextual navigation feels very weird and inconsistent in practice. The solution is instead to use the shoulder buttons (which will jump six rows), or the trigger buttons (which will jump to the first and last row). These buttons work consistently throughout the application and avoid the strange side effects just mentioned. If you observe this more closely you will also realize that "wrap around" is very rare in GUI design, you don't jump to the top of a web page when you scroll to the bottom and likewise the settings menus of your mobile phone will not wrap around.
|
|
||||||
|
|
||||||
## I'm on Windows and ES-DE can't find my emulators, what is wrong?
|
## I'm on Windows and ES-DE can't find my emulators, what is wrong?
|
||||||
|
|
||||||
On Windows ES-DE is shipped as a portable installation and as a regular installer. If you're using the portable installation you need to drop your emulators inside the Emulators directory. Make sure to read the README.txt file directly in the EmulationStation-DE folder for more details. For the regular installer many emulators do not provide a method to inform ES-DE where they are installed, so you will need to add their installation directories to the Path environment variable in Windows. It's strongly recommended to read the _Specific notes for Windows_ section of the [User guide](USERGUIDE.md#specific-notes-for-windows) before attempting to setup and use ES-DE on Windows.
|
On Windows ES-DE is shipped as a portable installation and as a regular installer. If you're using the portable installation you need to drop your emulators inside the Emulators directory. Make sure to read the README.txt file directly in the EmulationStation-DE folder for more details. For the regular installer many emulators do not provide a method to inform ES-DE where they are installed, so you will need to add their installation directories to the Path environment variable in Windows. It's strongly recommended to read the _Specific notes for Windows_ section of the [User guide](USERGUIDE.md#specific-notes-for-windows) before attempting to setup and use ES-DE on Windows.
|
||||||
|
|
|
||||||
|
|
@ -2478,7 +2478,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
||||||
| android | Google Android | _Placeholder_ | | | |
|
| android | Google Android | _Placeholder_ | | | |
|
||||||
| apple2 | Apple II | _Placeholder_ | | | |
|
| apple2 | Apple II | _Placeholder_ | | | |
|
||||||
| apple2gs | Apple IIGS | _Placeholder_ | | | |
|
| apple2gs | Apple IIGS | _Placeholder_ | | | |
|
||||||
| arcade | Arcade | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FB Alpha 2012 | Depends | Single archive file following MAME name standard in root folder |
|
| arcade | Arcade | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FB Alpha 2012,<br>Flycast,<br>Flycast **(Standalone)** [UMW*] | Depends | Single archive file following MAME name standard in root folder |
|
||||||
| astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** [UMW*] | | Single archive in root folder |
|
| astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** [UMW*] | | Single archive in root folder |
|
||||||
| atari2600 | Atari 2600 | Stella | Stella 2014 | No | Single archive or ROM file in root folder |
|
| atari2600 | Atari 2600 | Stella | Stella 2014 | No | Single archive or ROM file in root folder |
|
||||||
| atari5200 | Atari 5200 | a5200 | Atari800 | | |
|
| atari5200 | Atari 5200 | a5200 | Atari800 | | |
|
||||||
|
|
@ -2488,7 +2488,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
||||||
| atarijaguarcd | Atari Jaguar CD | Virtual Jaguar | | | |
|
| atarijaguarcd | Atari Jaguar CD | Virtual Jaguar | | | |
|
||||||
| atarilynx | Atari Lynx | Handy | Beetle Lynx | | |
|
| atarilynx | Atari Lynx | Handy | Beetle Lynx | | |
|
||||||
| atarist | Atari ST [also STE and Falcon] | Hatari | | | |
|
| atarist | Atari ST [also STE and Falcon] | Hatari | | | |
|
||||||
| atarixe | Atari XE | Atari800 | | | |
|
| atarixe | Atari XE | Atari800 | Atari800 **(Standalone)** [UMW*] | No | |
|
||||||
| atomiswave | Atomiswave | Flycast | Flycast **(Standalone)** [UMW*] | | |
|
| atomiswave | Atomiswave | Flycast | Flycast **(Standalone)** [UMW*] | | |
|
||||||
| bbcmicro | BBC Micro | _Placeholder_ | | | |
|
| bbcmicro | BBC Micro | _Placeholder_ | | | |
|
||||||
| c64 | Commodore 64 | VICE x64sc Accurate | VICE x64 Fast,<br>VICE x64 SuperCPU,<br>VICE x128,<br>Frodo | No | Single disk, tape or cartridge image in root folder and/or multi-disc images in separate folder |
|
| c64 | Commodore 64 | VICE x64sc Accurate | VICE x64 Fast,<br>VICE x64 SuperCPU,<br>VICE x128,<br>Frodo | No | Single disk, tape or cartridge image in root folder and/or multi-disc images in separate folder |
|
||||||
|
|
@ -2524,7 +2524,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
||||||
| lutris | Lutris Open Gaming Platform | Lutris application **(Standalone)** [U] | | No | Shell script in root folder |
|
| lutris | Lutris Open Gaming Platform | Lutris application **(Standalone)** [U] | | No | Shell script in root folder |
|
||||||
| lutro | Lutro Game Engine | Lutro | | | |
|
| lutro | Lutro Game Engine | Lutro | | | |
|
||||||
| macintosh | Apple Macintosh | _Placeholder_ | | | |
|
| macintosh | Apple Macintosh | _Placeholder_ | | | |
|
||||||
| mame | Multiple Arcade Machine Emulator | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FB Alpha 2012 | Depends | Single archive file following MAME name standard in root folder |
|
| mame | Multiple Arcade Machine Emulator | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FB Alpha 2012,<br>Flycast,<br>Flycast **(Standalone)** [UMW*] | Depends | Single archive file following MAME name standard in root folder |
|
||||||
| mame-advmame | AdvanceMAME | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder |
|
| mame-advmame | AdvanceMAME | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder |
|
||||||
| mame-mame4all | MAME4ALL | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder |
|
| mame-mame4all | MAME4ALL | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder |
|
||||||
| mastersystem | Sega Master System | Genesis Plus GX | Genesis Plus GX Wide,<br>SMS Plus GX,<br>Gearsystem,<br>PicoDrive | No | Single archive or ROM file in root folder |
|
| mastersystem | Sega Master System | Genesis Plus GX | Genesis Plus GX Wide,<br>SMS Plus GX,<br>Gearsystem,<br>PicoDrive | No | Single archive or ROM file in root folder |
|
||||||
|
|
@ -2570,8 +2570,8 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
||||||
| psx | Sony PlayStation | Beetle PSX | Beetle PSX HW,<br>PCSX ReARMed,<br>SwanStation,<br>DuckStation **(Standalone)** [UMW*] | Yes | .chd file in root folder for single-disc games, .m3u playlist in root folder for multi-disc games |
|
| psx | Sony PlayStation | Beetle PSX | Beetle PSX HW,<br>PCSX ReARMed,<br>SwanStation,<br>DuckStation **(Standalone)** [UMW*] | Yes | .chd file in root folder for single-disc games, .m3u playlist in root folder for multi-disc games |
|
||||||
| samcoupe | SAM Coupé | SimCoupe | | | |
|
| samcoupe | SAM Coupé | SimCoupe | | | |
|
||||||
| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>Mesen-S | | |
|
| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>Mesen-S | | |
|
||||||
| saturn | Sega Saturn | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause | | |
|
| saturn | Sega Saturn | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game |
|
||||||
| saturnjp | Sega Saturn [Japan] | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause | | |
|
| saturnjp | Sega Saturn [Japan] | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game |
|
||||||
| scummvm | ScummVM Game Engine | ScummVM | | No | In separate folder (one folder per game with complete file structure retained) and with a .scummvm file for launching the game |
|
| scummvm | ScummVM Game Engine | ScummVM | | No | In separate folder (one folder per game with complete file structure retained) and with a .scummvm file for launching the game |
|
||||||
| sega32x | Sega Mega Drive 32X | PicoDrive | | No | Single archive or ROM file in root folder |
|
| sega32x | Sega Mega Drive 32X | PicoDrive | | No | Single archive or ROM file in root folder |
|
||||||
| sega32xjp | Sega Super 32X [Japan] | PicoDrive | | No | Single archive or ROM file in root folder |
|
| sega32xjp | Sega Super 32X [Japan] | PicoDrive | | No | Single archive or ROM file in root folder |
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue