mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-21 21:55:38 +00:00
Documentation update.
This commit is contained in:
Leon Styhre
parent
1917bfba74
commit
ba07a0b24c
12
CHANGELOG.md
12
CHANGELOG.md
|
|
@ -11,8 +11,14 @@
|
|||
### Detailed list of changes
|
||||
|
||||
* 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
|
||||
* Populated the bundled es_systems.xml files with alternative emulator entries for must RetroArch cores
|
||||
* Added a virtual keyboard partly based on code from batocera-emulationstation
|
||||
* 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
|
||||
* 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 a filter for "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
|
||||
* Expanded the themeable options for "helpsystem" to support custom button graphics, dimmed text and icon colors, upper/lower/camel case and custom spacing
|
||||
* Added support for using the left and right trigger buttons in the help prompts
|
||||
|
|
@ -24,6 +30,8 @@
|
|||
* Moved the game media directory setting to the top of the Other Settings menu, following the new Alternative Emulators entry
|
||||
* Added a blinking cursor to TextEditComponent
|
||||
* Changed the filter description "Text filter (game name)" to "Game name"
|
||||
* Added support for multi-select total count and exclusive multi-select to OptionListComponent
|
||||
* Achieved a massive speed improvement for OptionListComponent by not resizing each added MenuComponent row (most notable in the filter GUI)
|
||||
* Added support for a new type of "flat style" button to ButtonComponent
|
||||
* Added support for correctly navigating arbitrarily sized ComponentGrid entries, i.e. those spanning multiple cells
|
||||
* Bundled the bold font version of Fontfabric Akrobat
|
||||
|
|
@ -32,6 +40,7 @@
|
|||
* Replaced some additional math functions and moved the remaining built-in functions to a math utility namespace
|
||||
* Added a function to generate MD5 hashes
|
||||
* Moved the "complex" mode functionality from GuiComplexTextEditPopup into GuiTextEditPopup and removed the source files for the former
|
||||
* Replaced the String::Utils::trim function with better code and removed some inline text trimming throughout the application
|
||||
* Increased the warning level for Clang/LLVM and GCC by adding -Wall, -Wpedantic and some additional flags
|
||||
* Fixed a lot of compiler warnings introduced by the -Wall and -Wpedantic flags
|
||||
* Changed the language standard from C++14 to C++17
|
||||
|
|
@ -44,6 +53,7 @@
|
|||
* When multi-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 multi-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
|
||||
* Removing games from custom collections did not remove their filter index entries
|
||||
* Input consisting of only whitespace characters would get accepted by TextEditComponent which led to various strange behaviors
|
||||
* Leading and trailing whitespace characters would not get trimmed from the collection name when creating a new custom collection
|
||||
* Leading and trailing whitespace characters would get included in scraper search refines and TheGamesDB searches
|
||||
|
|
@ -334,6 +344,4 @@ Many bugs have been fixed, and numerous features that were only partially implem
|
|||
|
||||
* There is an issue with launching games on Windows when using AMD and Intel GPUs. This causes the emulator to just output a blank screen. There is a workaround available for this which is enabled by default and that can be disabled via the menu option "AMD and Intel GPU game launch workaround". The drawback of this workaround is that a white instead of a black screen will be displayed when launching games. If using an Nvidia GPU, it should be safe to disable this option for a slightly better user experience. An alternative workaround is to enable the option "Run in background (while game is launched)".
|
||||
|
||||
* On macOS Big Sur (and possibly other OS versions) when connecting a DualShock 4 controller either via Bluetooth or using a USB cable, two separate controller devices are registered in parallel. This is a bug in either macOS or the DualShock driver and it makes it seem as if ES-DE is registering double button presses when actually two separate controller devices are generating identical input. A workaround if using Bluetooth mode is to plug in the USB cable just after connecting the controller, wait a second or two and then remove the cable again. This will remove the cabled device, leaving only the Bluetooth device active. Another workaround is to enable the setting "Only accept input from first controller" in the ES-DE input device settings. The reason why this bug may not be visible in some other games and applications is that ES-DE enables and auto-configures all connected controllers.
|
||||
|
||||
* On Windows when using high DPI displays, if not running ES-DE on the primary monitor and the display where it runs does not have the same scaling percentage as the primary monitor, then the ES-DE resolution will not be properly set. The application will still work and if running in fullscreen mode it may not even be noticeable. This issue is caused by a bug in SDL where the primary display scaling is always used for calculating the display bounds and as such it needs to be fixed in that library. If using the same scaling percentage across all monitors, or if not using high DPI monitors at all, then this issue will not occur.
|
||||
|
|
|
|||
|
|
@ -1409,7 +1409,7 @@ This custom file functionality is designed to be complementary to the bundled es
|
|||
|
||||
The bundled es_systems.xml file is located in the resources directory that is part of the application installation. For example this could be `/usr/share/emulationstation/resources/systems/unix/es_systems.xml` on Unix, `/Applications/EmulationStation Desktop Edition.app/Contents/Resources/resources/systems/macos/es_systems.xml` on macOS or `C:\Program Files\EmulationStation-DE\resources\systems\windows\es_systems.xml` on Windows. The actual location may differ from these examples of course, depending on where ES-DE has been installed.
|
||||
|
||||
It doesn't matter in which order you define the systems as they will be sorted by the full system name inside the application, but it's still probably a good idea to add them in alphabetical order to make the file easier to maintain.
|
||||
It doesn't matter in which order you define the systems as they will be sorted by the `<fullname>` tag or by the optional `<systemsortname>` tag when displayed inside the application. But it's still a good idea to add the systems in alphabetical order to make the configuration file easier to maintain.
|
||||
|
||||
Keep in mind that you have to set up your emulators separately from ES-DE as the es_systems.xml file assumes that your emulator environment is properly configured.
|
||||
|
||||
|
|
@ -1430,6 +1430,12 @@ Below is an overview of the file layout with various examples. For the command t
|
|||
<!-- The full system name, used for sorting the systems, for selecting the systems to multi-scrape etc. -->
|
||||
<fullname>Nintendo SNES (Super Nintendo)</fullname>
|
||||
|
||||
<!-- By default the systems are sorted by their full names, but this can be overridden by setting the optional
|
||||
<systemsortname> tag to an arbitrary value. As far as sorting is concerned, the effect will be identical to
|
||||
changing the <fullname> tag. Apart for system sorting, this tag has no effect and its actual value will not
|
||||
be displayed anywhere within the appliction. -->
|
||||
<systemsortname>Super Nintendo</systemsortname>
|
||||
|
||||
<!-- The path to look for ROMs in. '~' will be expanded to $HOME or %HOMEPATH%, depending on the operating system.
|
||||
The optional %ROMPATH% variable will expand to the path defined in the setting ROMDirectory in es_settings.xml.
|
||||
All subdirectories (and non-recursive links) will be included. -->
|
||||
|
|
@ -1444,13 +1450,15 @@ Below is an overview of the file layout with various examples. For the command t
|
|||
file. This is the recommended way to configure the launch command. -->
|
||||
<command>%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/snes9x_libretro.so %ROM%</command>
|
||||
|
||||
<!-- It's possible to define alternative emulators by adding additional command tags for a system. When doing this,
|
||||
the "label" attribute is mandatory for all tags. It's these labels that will be shown in the user interface when
|
||||
selecting the alternative emulators either system-wide or per game. The first row will be the default emulator. -->
|
||||
<command label="Nestopia UE">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/nestopia_libretro.so %ROM%</command>
|
||||
<command label="FCEUmm">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/fceumm_libretro.so %ROM%</command>
|
||||
<command label="Mesen">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/mesen_libretro.so %ROM%</command>
|
||||
<command label="QuickNES">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/quicknes_libretro.so %ROM%</command>
|
||||
<!-- It's possible to define alternative emulators by adding additional command tags for a system. When doing this, the
|
||||
"label" attribute is mandatory for all tags. It's these labels that will be shown in the user interface when selecting the
|
||||
alternative emulator either system-wide or per game. The first row will be the default emulator. -->
|
||||
<command label="Snes9x - Current">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/snes9x_libretro.so %ROM%</command>
|
||||
<command label="Snes9x 2010">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/snes9x2010_libretro.so %ROM%</command>
|
||||
<command label="bsnes">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/bsnes_libretro.so %ROM%</command>
|
||||
<command label="bsnes-mercury Accuracy">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/bsnes_mercury_accuracy_libretro.so %ROM%</command>
|
||||
<command label="Beetle Supafaust">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/mednafen_supafaust_libretro.so %ROM%</command>
|
||||
<command label="Mesen-S">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/mesen-s_libretro.so %ROM%</command>
|
||||
|
||||
<!-- This example for Unix will search for RetroArch in the PATH environment variable and it also has an absolute path to
|
||||
the snes9x_libretro core, If there are spaces in the path or file name, you must enclose them in quotation marks, such as
|
||||
|
|
@ -1604,6 +1612,36 @@ If adding the `<loadExclusive/>` tag to the file, the bundled es_systems.xml fil
|
|||
</systemList>
|
||||
```
|
||||
|
||||
Here is yet another example with the addition of the `snes` system where some file extensions and alternative emulator entries have been removed, and the full name and sorting have been modified.
|
||||
|
||||
```xml
|
||||
<?xml version="1.0"?>
|
||||
<!-- This is a custom ES-DE game systems configuration file for Unix -->
|
||||
<systemList>
|
||||
<system>
|
||||
<name>nes</name>
|
||||
<fullname>Nintendo Entertainment System</fullname>
|
||||
<path>%ROMPATH%/nes</path>
|
||||
<extension>.nes .NES .zip .ZIP</extension>
|
||||
<command>/usr/games/fceux %ROM%</command>
|
||||
<platform>nes</platform>
|
||||
<theme>nes</theme>
|
||||
</system>
|
||||
<system>
|
||||
<name>snes</name>
|
||||
<fullname>Super Nintendo</fullname>
|
||||
<systemsortname>Nintendo SNES (Super Nintendo)</systemsortname>
|
||||
<path>%ROMPATH%/snes</path>
|
||||
<extension>.smc .SMC .sfc .SFC .swc .SWC .bin .BIN .mgd .MGD .7z .7Z .zip .ZIP</extension>
|
||||
<command label="Snes9x - Current">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/snes9x_libretro.so %ROM%</command>
|
||||
<command label="Snes9x 2010">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/snes9x2010_libretro.so %ROM%</command>
|
||||
<command label="bsnes">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/bsnes_libretro.so %ROM%</command>
|
||||
<platform>snes</platform>
|
||||
<theme>snes</theme>
|
||||
</system>
|
||||
</systemList>
|
||||
```
|
||||
|
||||
## es_find_rules.xml
|
||||
|
||||
This file makes it possible to define rules for where to search for the emulator binaries and emulator cores.
|
||||
|
|
|
|||
101
USERGUIDE-DEV.md
101
USERGUIDE-DEV.md
|
|
@ -128,6 +128,18 @@ There will be a lot of directories created if using the es_systems.xml file bund
|
|||
_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._
|
||||
|
||||
|
||||
## Specific notes for macOS
|
||||
|
||||
On macOS, the first time you launch a game from within ES-DE, the operating system will present you with a security option with the following description:
|
||||
|
||||
`"EmulationStation Desktop Edition" would like to access files in your Documents folder.`
|
||||
|
||||
If you don't allow this, you will not be able to place system BIOS ROMs in the RetroArch default system directory `~/Documents/RetroArch/system` even if you've already given RetroArch access to this folder. This is so because RetroArch runs as a subprocess to ES-DE and therefore inherits the security settings from the parent application. Attempting to launch a game without enabling the access will simply display an error message in the emulator that the BIOS files are missing. This of course only applies to emulators that require BIOS ROMs, all other games should work fine regardless of this security setting.
|
||||
|
||||
If you accidentally refused ES-DE the folder access, you can fix this by opening _System Preferences_, selecting _Security & Privacy_ and within the GUI choose _Files and Folders_. The option you need to enable is _Documents Folder_ under _EmulationStation Desktop Edition_.
|
||||
|
||||
Another issue on macOS 11 Big Sur (and possibly other OS versions) is that when connecting a DualShock 4 controller either via Bluetooth or using a USB cable, two separate controller devices are registered in parallel. This is a bug in either macOS or the DualShock driver and it makes it seem as if ES-DE is registering double button presses when actually two separate controller devices are generating identical input. A workaround if using Bluetooth mode is to plug in the USB cable just after connecting the controller, wait a second or two and then remove the cable again. This will remove the cabled device, leaving only the Bluetooth device active. Another workaround is to enable the setting _Only accept input from first controller_ in the ES-DE input device settings. The reason why this bug may not be visible in some other games and applications is that ES-DE enables and auto-configures all connected controllers.
|
||||
|
||||
## Game system customizations
|
||||
|
||||
The game systems configuration file `es_systems.xml` is located in the ES-DE resources directory which is part of the application installation. As such this file is not intended to be modified directly. If system customizations are required, a separate es_systems.xml file should instead be placed in the `custom_systems` folder in the ES-DE home directory, i.e. `~/.emulationstation/custom_systems/es_systems.xml`.
|
||||
|
|
@ -136,7 +148,7 @@ Although it's possible to make a copy of the bundled configuration file, to modi
|
|||
|
||||
For example you may want to replace the emulator launch command, modify the full name or change the supported file extensions for a single system. In this case it wouldn't make sense to copy the complete bundled file and just apply these minor modifications, instead an es_systems.xml file only containing the configuration for that single system should be placed in the custom_systems directory.
|
||||
|
||||
The instructions for how to customize the es_systems.xml file can be found in [INSTALL-DEV.md](INSTALL-DEV.md#es_systemsxml). There you can also find an example of a custom file that you can copy into ~/.emulationstation/custom_systems/ and modify as required.
|
||||
The instructions for how to customize the es_systems.xml file can be found in [INSTALL-DEV.md](INSTALL-DEV.md#es_systemsxml). There you can also find some examples of custom files that you can copy into ~/.emulationstation/custom_systems/ and modify as required.
|
||||
|
||||
|
||||
## Migrating from other EmulationStation forks
|
||||
|
|
@ -179,9 +191,9 @@ If you experience double button presses with your DualShock 4 controller on macO
|
|||
|
||||
When starting ES-DE with the default settings, you will see the System view first. From here you can navigate your game systems and enter their respective gamelists.
|
||||
|
||||
Depending on the theme, the system navigation carousel can be either horizontal or vertical. The default theme rbsimple-DE provides horizontal navigation, i.e. you browse your systems by scrolling left or right.
|
||||
Depending on the theme, the system navigation carousel can be horizontal, vertical or displayed as a wheel. The default theme rbsimple-DE provides horizontal navigation, i.e. you browse your systems by scrolling left or right.
|
||||
|
||||
The game systems are sorted by their full names, as defined in the es_systems.xml file.
|
||||
The game systems are sorted by their full names by default, as defined in the es_systems.xml file. It's however possible to set a custom sortname per system, as explained in the [INSTALL-DEV.md](INSTALL-DEV.md#es_systemsxml) document.
|
||||
|
||||
|
||||
_The **System view** is the default starting point for the application, it's here that you browse through your game systems._
|
||||
|
|
@ -1332,25 +1344,29 @@ The following filters can be applied:
|
|||
|
||||
**Game name**
|
||||
|
||||
**Favorites**
|
||||
**Rating**
|
||||
|
||||
**Developer**
|
||||
|
||||
**Publisher**
|
||||
|
||||
**Genre**
|
||||
|
||||
**Players**
|
||||
|
||||
**Publisher / Developer**
|
||||
|
||||
**Rating**
|
||||
|
||||
**Kidgame**
|
||||
**Favorite**
|
||||
|
||||
**Completed**
|
||||
|
||||
**Kidgame**
|
||||
|
||||
**Hidden** _If the "Show hidden games" option is enabled_
|
||||
|
||||
**Broken**
|
||||
|
||||
**Hidden**
|
||||
**Alternative emulator**
|
||||
|
||||
With the exception of the game name text filter, all available filter values are assembled from metadata from the actual gamelist, so if there for instance are no games marked as completed, the Completed filter will only have the selectable option False, i.e. True will be missing.
|
||||
With the exception of the game name text filter, all available filter values are assembled from metadata from the actual gamelist, so if there is no data to filter for the specific field, the text _Nothing to filter_ will be displayed. This for example happens for the _Completed_ filter if there are no games marked as having been completed in the current gamelist.
|
||||
|
||||
Be aware that although folders can have most of the metadata values set, the filters are only applied to files (this is also true for the game name text filter). So if you for example set a filter to only display your favorite games, any folder that contains a favorite game will be displayed, and other folders which are themselves marked as favorites but that do not contain any favorite games will be hidden.
|
||||
|
||||
|
|
@ -1672,13 +1688,13 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
|
|||
| System name | Full name | Default emulator | Alternative emulators | Needs BIOS | Recommended game setup |
|
||||
| :-------------------- | :--------------------------------------------- | :-------------------------------- | :-------------------------------- | :----------- | :----------------------------------- |
|
||||
| 3do | 3DO | 4DO | | | |
|
||||
| 64dd | Nintendo 64DD | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | ParaLLEl N64 [UW] | | |
|
||||
| 64dd | Nintendo 64DD | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | ParaLLEl N64 [UW] | | |
|
||||
| ags | Adventure Game Studio game engine | | | | |
|
||||
| amiga | Commodore Amiga | PUAE | | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc |
|
||||
| amiga600 | Commodore Amiga 600 | PUAE | | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc |
|
||||
| amiga1200 | Commodore Amiga 1200 | PUAE | | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc |
|
||||
| amigacd32 | Commodore Amiga CD32 | PUAE | | | |
|
||||
| amstradcpc | Amstrad CPC | Caprice32 | | | |
|
||||
| amstradcpc | Amstrad CPC | Caprice32 | CrocoDS | | |
|
||||
| apple2 | Apple II | | | | |
|
||||
| apple2gs | Apple IIGS | | | | |
|
||||
| arcade | Arcade | MAME - Current | MAME 2000,<br>MAME 2003-Plus,<br>MAME 2010,<br>FinalBurn Neo,<br>FB Alpha 2012 | Depends | Single archive file following MAME name standard in root folder |
|
||||
|
|
@ -1689,12 +1705,12 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
|
|||
| atari800 | Atari 800 | Atari800 | | | |
|
||||
| atarijaguar | Atari Jaguar | Virtual Jaguar | | | |
|
||||
| atarijaguarcd | Atari Jaguar CD | Virtual Jaguar | | | |
|
||||
| atarilynx | Atari Lynx | Beetle Lynx | | | |
|
||||
| atarilynx | Atari Lynx | Handy | Beetle Lynx | | |
|
||||
| atarist | Atari ST [also STE and Falcon] | Hatari | | | |
|
||||
| atarixe | Atari XE | Atari800 | | | |
|
||||
| atomiswave | Atomiswave | Flycast | | | |
|
||||
| bbcmicro | BBC Micro | | | | |
|
||||
| c64 | Commodore 64 | VICE x64sc Accurate | VICE x64 Fast,<br>VICE x64 SuperCPU,<br>VICE x128,<br>Frodo | No | Single disk, tape r 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 |
|
||||
| cavestory | Cave Story (NXEngine) | NXEngine | | | |
|
||||
| cdtv | Commodore CDTV | | | | |
|
||||
| chailove | ChaiLove game engine | ChaiLove | | | |
|
||||
|
|
@ -1712,51 +1728,51 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
|
|||
| fbneo | FinalBurn Neo | FinalBurn Neo | | Yes | Single archive file following MAME name standard in root folder |
|
||||
| fds | Nintendo Famicom Disk System | Nestopia UE | | Yes | Single archive or ROM file in root folder |
|
||||
| gameandwatch | Nintendo Game and Watch | GW | | | |
|
||||
| gamegear | Sega Game Gear | Genesis Plus GX | | | |
|
||||
| gb | Nintendo Game Boy | bsnes | | | |
|
||||
| gba | Nintendo Game Boy Advance | Beetle GBA | | | |
|
||||
| gbc | Nintendo Game Boy Color | bsnes | | | |
|
||||
| gamegear | Sega Game Gear | Gearsystem | SMS Plus GX,<br>Genesis Plus GX,<br>Genesis Plus GX Wide | | |
|
||||
| gb | Nintendo Game Boy | SameBoy | Gambatte,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes | | |
|
||||
| gba | Nintendo Game Boy Advance | mGBA | VBA-M,<br>VBA Next,<br>gpSP | | |
|
||||
| gbc | Nintendo Game Boy Color | SameBoy | Gambatte,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes | | |
|
||||
| gc | Nintendo GameCube | Dolphin | | | |
|
||||
| genesis | Sega Genesis | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive,<br>BlastEm | No | Single archive or ROM file in root folder |
|
||||
| gx4000 | Amstrad GX4000 | | | | |
|
||||
| intellivision | Mattel Electronics Intellivision | FreeIntv | | | |
|
||||
| kodi | Kodi home theatre software | N/A | | No | |
|
||||
| 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 | | | |
|
||||
| macintosh | Apple Macintosh | | | | |
|
||||
| mame | Multiple Arcade Machine Emulator | MAME 2003-Plus | MAME 2000,<br>MAME 2010,<br>MAME - Current,<br>FinalBurn Neo,<br>FB Alpha 2012 | Depends | Single archive file following MAME name standard in root folder |
|
||||
| mame-advmame | AdvanceMAME | | | Depends | Single archive file following MAME name standard in root folder |
|
||||
| mame-mame4all | MAME4ALL | | | 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 |
|
||||
| megacd | Sega Mega-CD | Genesis Plus GX | | | |
|
||||
| megacdjp | Sega Mega-CD [Japan] | Genesis Plus GX | | | |
|
||||
| megacd | Sega Mega-CD | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive | | |
|
||||
| megacdjp | Sega Mega-CD [Japan] | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive | | |
|
||||
| megadrive | Sega Mega Drive | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive,<br>BlastEm | No | Single archive or ROM file in root folder |
|
||||
| mess | Multi Emulator Super System | MESS 2015 | | | |
|
||||
| moonlight | Moonlight game streaming | | | | |
|
||||
| moto | Thomson MO/TO series | Theodore | | | |
|
||||
| msx | MSX | blueMSX | | | |
|
||||
| msx1 | MSX1 | blueMSX | | | |
|
||||
| msx2 | MSX2 | blueMSX | | | |
|
||||
| msx | MSX | blueMSX | fMSX | | |
|
||||
| msx1 | MSX1 | blueMSX | fMSX | | |
|
||||
| msx2 | MSX2 | blueMSX | fMSX | | |
|
||||
| msxturbor | MSX Turbo R | blueMSX | | | |
|
||||
| multivision | Othello Multivision | Gearsystem | | | |
|
||||
| naomi | Sega NAOMI | Flycast | | | |
|
||||
| naomigd | Sega NAOMI GD-ROM | Flycast | | | |
|
||||
| n3ds | Nintendo 3DS | Citra | | | |
|
||||
| n64 | Nintendo 64 | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | ParaLLEl N64 [UW] | No | Single archive or ROM file in root folder |
|
||||
| nds | Nintendo DS | melonDS | | | |
|
||||
| n3ds | Nintendo 3DS | Citra [UW] | Citra 2018 [UW] | | |
|
||||
| n64 | Nintendo 64 | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | ParaLLEl N64 [UW] | No | Single archive or ROM file in root folder |
|
||||
| nds | Nintendo DS | DeSmuME | DeSmuME 2015,<br>melonDS | | |
|
||||
| neogeo | SNK Neo Geo | FinalBurn Neo | | Yes | Single archive file following MAME name standard in root folder |
|
||||
| neogeocd | SNK Neo Geo CD | NeoCD | | Yes | Single archive in root folder (which includes the CD image and ripped audio) |
|
||||
| neogeocdjp | SNK Neo Geo CD [Japan] | NeoCD | | Yes | Single archive in root folder (which includes the CD image and ripped audio) |
|
||||
| nes | Nintendo Entertainment System | Nestopia UE | FCEUmm,<br>Mesen,<br>QuickNES | No | Single archive or ROM file in root folder |
|
||||
| ngp | SNK Neo Geo Pocket | Beetle NeoPop | | | |
|
||||
| ngpc | SNK Neo Geo Pocket Color | Beetle NeoPop | | | |
|
||||
| nes | Nintendo Entertainment System | Nestopia UE | FCEUmm,<br>Mesen,<br>QuickNES | No | Single archive or ROM file in root folder |
|
||||
| ngp | SNK Neo Geo Pocket | Beetle NeoPop | RACE | | |
|
||||
| ngpc | SNK Neo Geo Pocket Color | Beetle NeoPop | RACE | | |
|
||||
| odyssey2 | Magnavox Odyssey2 | O2EM | | | |
|
||||
| openbor | OpenBOR game engine | | | | |
|
||||
| oric | Tangerine Computer Systems Oric | | | | |
|
||||
| palm | Palm OS | Mu | | | |
|
||||
| pc | IBM PC | DOSBox-Core | DOSBox-Pure,<br>DOSBox-SVN | No | In separate folder (one folder per game, with complete file structure retained) |
|
||||
| pc | IBM PC | DOSBox-Core | DOSBox-Pure,<br>DOSBox-SVN | No | In separate folder (one folder per game, with complete file structure retained) |
|
||||
| pc88 | NEC PC-8800 series | QUASI88 | | | |
|
||||
| pc98 | NEC PC-9800 series | Neko Project II Kai | | | |
|
||||
| pc98 | NEC PC-9800 series | Neko Project II Kai | Neko Project II | | |
|
||||
| pcengine | NEC PC Engine | Beetle PCE | Beetle PCE FAST | No | Single archive or ROM file in root folder |
|
||||
| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST | Yes | |
|
||||
| pcfx | NEC PC-FX | Beetle PC-FX | | | |
|
||||
|
|
@ -1770,22 +1786,22 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
|
|||
| psx | Sony PlayStation | Beetle PSX | Beetle PSX HW,<br>PCSX ReARMed,<br>DuckStation | Yes | .chd file in root folder for single-disc games, .m3u playlist in root folder for multi-disc games |
|
||||
| residualvm | ResidualVM game engine | | | | |
|
||||
| samcoupe | SAM Coupé | SimCoupe | | | |
|
||||
| satellaview | Nintendo Satellaview | Snes9x - Current | | | |
|
||||
| saturn | Sega Saturn | Beetle Saturn | | | |
|
||||
| saturnjp | Sega Saturn [Japan] | Beetle Saturn | | | |
|
||||
| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-mercury Accuracy,<br>Mesen-S | | |
|
||||
| saturn | Sega Saturn | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause | | |
|
||||
| saturnjp | Sega Saturn [Japan] | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause | | |
|
||||
| scummvm | ScummVM game engine | ScummVM | | No | In separate folder (one folder per game, with complete file structure retained) |
|
||||
| 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 |
|
||||
| sega32xna | Sega Genesis 32X [North America] | PicoDrive | | No | Single archive or ROM file in root folder |
|
||||
| segacd | Sega CD | Genesis Plus GX | | | |
|
||||
| sg-1000 | Sega SG-1000 | Genesis Plus GX | | | |
|
||||
| segacd | Sega CD | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive | | |
|
||||
| sg-1000 | Sega SG-1000 | Gearsystem | Genesis Plus GX,<br>Genesis Plus GX Wide,<br>blueMSX | | |
|
||||
| snes | Nintendo SNES (Super Nintendo) | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-mercury Accuracy,<br>Beetle Supafaust [UW],<br>Mesen-S | No | Single archive or ROM file in root folder |
|
||||
| snesna | Nintendo SNES (Super Nintendo) [North America] | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-mercury Accuracy,<br>Beetle Supafaust [UW],<br>Mesen-S | No | Single archive or ROM file in root folder |
|
||||
| solarus | Solarus game engine | | | | |
|
||||
| spectravideo | Spectravideo | blueMSX | | | |
|
||||
| steam | Valve Steam | Steam application **(Standalone)** | | No | Shell script/batch file in root folder |
|
||||
| steam | Valve Steam | Steam application **(Standalone)** | | No | Shell script/batch file in root folder |
|
||||
| stratagus | Stratagus game engine | | | | |
|
||||
| sufami | Bandai SuFami Turbo | Snes9x - Current | | | |
|
||||
| sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-mercury Accuracy | | |
|
||||
| supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE | | |
|
||||
| switch | Nintendo Switch | Yuzu **(Standalone)** [UW] | | Yes | |
|
||||
| tanodragon | Tano Dragon | | | | |
|
||||
|
|
@ -1797,7 +1813,7 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
|
|||
| trs-80 | Tandy TRS-80 | | | | |
|
||||
| uzebox | Uzebox | Uzem | | | |
|
||||
| vectrex | Vectrex | vecx | | | |
|
||||
| videopac | Philips Videopac G7000 (Magnavox Odyssey2) | O2EM | | | |
|
||||
| videopac | Philips Videopac G7000 | O2EM | | | |
|
||||
| virtualboy | Nintendo Virtual Boy | Beetle VB | | | |
|
||||
| wii | Nintendo Wii | Dolphin | | | |
|
||||
| wiiu | Nintendo Wii U | | | | |
|
||||
|
|
@ -1809,5 +1825,4 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
|
|||
| xbox360 | Microsoft Xbox 360 | | | | |
|
||||
| zmachine | Infocom Z-machine | | | | |
|
||||
| zx81 | Sinclair ZX81 | EightyOne | | | |
|
||||
| zxspectrum | Sinclair ZX Spectrum | Fuse | | | | | Amstrad GX4000 | | | | |
|
||||
|
||||
| zxspectrum | Sinclair ZX Spectrum | Fuse | | | |
|
||||
|
|
|
|||
13
USERGUIDE.md
13
USERGUIDE.md
|
|
@ -124,6 +124,19 @@ There will be a lot of directories created if using the es_systems.xml file bund
|
|||
_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._
|
||||
|
||||
|
||||
## Specific notes for macOS
|
||||
|
||||
On macOS, the first time you launch a game from within ES-DE, the operating system will present you with a security option with the following description:
|
||||
|
||||
`"EmulationStation Desktop Edition" would like to access files in your Documents folder.`
|
||||
|
||||
If you don't allow this, you will not be able to place system BIOS ROMs in the RetroArch default system directory `~/Documents/RetroArch/system` even if you've already given RetroArch access to this folder. This is so because RetroArch runs as a subprocess to ES-DE and therefore inherits the security settings from the parent application. Attempting to launch a game without enabling the access will simply display an error message in the emulator that the BIOS files are missing. This of course only applies to emulators that require BIOS ROMs, all other games should work fine regardless of this security setting.
|
||||
|
||||
If you accidentally refused ES-DE the folder access, you can fix this by opening _System Preferences_, selecting _Security & Privacy_ and within the GUI choose _Files and Folders_. The option you need to enable is _Documents Folder_ under _EmulationStation Desktop Edition_.
|
||||
|
||||
Another issue on macOS 11 Big Sur (and possibly other OS versions) is that when connecting a DualShock 4 controller either via Bluetooth or using a USB cable, two separate controller devices are registered in parallel. This is a bug in either macOS or the DualShock driver and it makes it seem as if ES-DE is registering double button presses when actually two separate controller devices are generating identical input. A workaround if using Bluetooth mode is to plug in the USB cable just after connecting the controller, wait a second or two and then remove the cable again. This will remove the cabled device, leaving only the Bluetooth device active. Another workaround is to enable the setting _Only accept input from first controller_ in the ES-DE input device settings. The reason why this bug may not be visible in some other games and applications is that ES-DE enables and auto-configures all connected controllers.
|
||||
|
||||
|
||||
## Customizing the systems configuration file
|
||||
|
||||
The `es_systems.xml` file is located in the ES-DE resources directory which is part of the application installation. As such this file is not intended to be modified directly. If a customized file is needed, this should instead be placed in the `custom_systems` folder in the ES-DE home directory, i.e. `~/.emulationstation/custom_systems/es_systems.xml`. You can find information on the file structure and how to adapt the configuration in the [INSTALL.md](INSTALL.md#es_systemsxml) document.
|
||||
|
|
|
|||
Loading…
Reference in a new issue