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:
parent
8d180ff50c
commit
4f224eafd2
15
CHANGELOG.md
15
CHANGELOG.md
|
@ -31,6 +31,7 @@ In addition to the above many bugs have been fixed and the application has recei
|
||||||
* Added an entry to the Utilities menu for creating/updating the game system directories
|
* Added an entry to the Utilities menu for creating/updating the game system directories
|
||||||
* Added a "Debug mode" option to the Other settings menu (which is equivalent to starting with the --debug flag)
|
* Added a "Debug mode" option to the Other settings menu (which is equivalent to starting with the --debug flag)
|
||||||
* Added support for a %PRECOMMAND% launch command variable (useful for launching emulators via Wine or Proton)
|
* Added support for a %PRECOMMAND% launch command variable (useful for launching emulators via Wine or Proton)
|
||||||
|
* Added support for a %GAMEDIRRAW% launch command variable (useful for launching MESS systems using the MAME RetroArch cores)
|
||||||
* Added support for defining multiple %INJECT% launch command variables
|
* Added support for defining multiple %INJECT% launch command variables
|
||||||
* Added more debug log output when launching games
|
* Added more debug log output when launching games
|
||||||
* Duplicate es_systems.xml command label entries are now ignored on application startup
|
* Duplicate es_systems.xml command label entries are now ignored on application startup
|
||||||
|
@ -65,14 +66,18 @@ In addition to the above many bugs have been fixed and the application has recei
|
||||||
* Removed support for the Moonlight Game Streaming (moonlight) game system
|
* Removed support for the Moonlight Game Streaming (moonlight) game system
|
||||||
* Removed support for the Stratagus Game Engine (stratagus) game system
|
* Removed support for the Stratagus Game Engine (stratagus) game system
|
||||||
* Added support for the AdvanceMAME (mame-advmame) system on Unix and Windows
|
* Added support for the AdvanceMAME (mame-advmame) system on Unix and Windows
|
||||||
* Added Mesen standalone as an alternative emulator for 14 systems on Linux and Windows
|
* Added Mesen standalone as an alternative emulator for the famicom, fds, gb, gbc and nes systems on Unix and Windows
|
||||||
|
* Added Mesen standalone as an alternative emulator for the pcengine, pcenginecd, satellaview and sfc systems on Unix and Windows
|
||||||
|
* Added Mesen standalone as an alternative emulator for the sgb, snes, snesna, tg16 and tg-cd systems on Unix and Windows
|
||||||
* Added Flycast Dojo standalone as an alternative emulator for the arcade, atomiswave, dreamcast, mame, naomi and naomigd systems
|
* Added Flycast Dojo standalone as an alternative emulator for the arcade, atomiswave, dreamcast, mame, naomi and naomigd systems
|
||||||
* (Linux) Changed the Flycast AppImage find rules so that they don't collide with the Flycast Dojo AppImage
|
* (Linux) Changed the Flycast AppImage find rules so that they don't collide with the Flycast Dojo AppImage
|
||||||
|
* Added the MAME - Current RetroArch core as the default emulator for the apple2gs, arcadia, crvision, fmtowns and gamecom systems
|
||||||
|
* Added the MAME - Current RetroArch core as the default emulator for the gmaster, pv1000, scv and vsmile systems
|
||||||
|
* Added MAME standalone as an alternative emulator for the atari7800, fmtowns and x1 systems
|
||||||
* Added ares standalone as an alternative emulator for the gamegear, gb, gba, gbc and satellaview systems
|
* Added ares standalone as an alternative emulator for the gamegear, gb, gba, gbc and satellaview systems
|
||||||
* Added SkyEmu standalone as an alternative emulator for the gb, gba, gbc and nds systems
|
* Added SkyEmu standalone as an alternative emulator for the gb, gba, gbc and nds systems
|
||||||
* Added FS-UAE standalone as an alternative emulator for the amiga, amiga1200, amiga600, amigacd32 and cdtv systems
|
* Added FS-UAE standalone as an alternative emulator for the amiga, amiga1200, amiga600, amigacd32 and cdtv systems
|
||||||
* Added Amiberry standalone as an alternative emulator for the amiga, amiga1200, amiga600, amigacd32 and cdtv systems on Linux and macOS
|
* Added Amiberry standalone as an alternative emulator for the amiga, amiga1200, amiga600, amigacd32 and cdtv systems on Linux and macOS
|
||||||
* Added MAME standalone as an alternative emulator for the atari7800 and x1 systems
|
|
||||||
* Set %STARTDIR%=%GAMEDIR% for the X Millennium RetroArch core as it created temporary files in the ES-DE directory
|
* Set %STARTDIR%=%GAMEDIR% for the X Millennium RetroArch core as it created temporary files in the ES-DE directory
|
||||||
* Added the ECWolf, NXEngine, OpenLara and Super Bros War RetroArch cores as alternative emulators for the ports system on Unix and Windows
|
* Added the ECWolf, NXEngine, OpenLara and Super Bros War RetroArch cores as alternative emulators for the ports system on Unix and Windows
|
||||||
* Added the ECWolf, NXEngine and Super Bros War RetroArch cores as alternative emulators for the ports system on macOS
|
* Added the ECWolf, NXEngine and Super Bros War RetroArch cores as alternative emulators for the ports system on macOS
|
||||||
|
@ -85,15 +90,15 @@ In addition to the above many bugs have been fixed and the application has recei
|
||||||
* Added MAME standalone as an alternative emulator for the fmtowns system on Unix and Windows
|
* Added MAME standalone as an alternative emulator for the fmtowns system on Unix and Windows
|
||||||
* (macOS) Added MAME standalone as the default emulator for the fmtowns system (was previously a placeholder system)
|
* (macOS) Added MAME standalone as the default emulator for the fmtowns system (was previously a placeholder system)
|
||||||
* Added QUASI88 standalone as an alternative emulator for the pc88 system
|
* Added QUASI88 standalone as an alternative emulator for the pc88 system
|
||||||
|
* Changed the configuration for the astrocde system to no longer require a manually installed MAME hash file
|
||||||
* Added the Retro8 RetroArch core as an alternative emulator for the pico8 system
|
* Added the Retro8 RetroArch core as an alternative emulator for the pico8 system
|
||||||
* Added the .88d, .cmt and .t88 file extensions to the pc88 system
|
* Added the .88d, .cmt and .t88 file extensions to the pc88 system
|
||||||
* Removed the .7z and .zip file extensions from the pc88 system
|
* Removed the .7z and .zip file extensions from the pc88 system
|
||||||
* Removed the .cdi, .cue, .gdi, .m3u and .iso file extensions from the atomiswave, naomi and naomigd systems
|
* Removed the .cdi, .cue, .gdi, .m3u and .iso file extensions from the atomiswave, naomi and naomigd systems
|
||||||
* Added the .7z and .zip file extensions to the apple2gs, daphne and fmtowns systems
|
* Added the .7z and .zip file extensions to the apple2gs and daphne systems
|
||||||
|
* Added the .cdr, .chd and .gdi file extensions to the fmtowns system
|
||||||
* Added the .arcadedef file extension to the ps2 system
|
* Added the .arcadedef file extension to the ps2 system
|
||||||
* Added the .chd file extension to the psp system
|
* Added the .chd file extension to the psp system
|
||||||
* Added the MAME - Current RetroArch core as the default emulator for the apple2gs, arcadia, crvision, gamecom and gmaster systems
|
|
||||||
* Added the MAME - Current RetroArch core as the default emulator for the pv1000, scv and vsmile systems
|
|
||||||
* (Linux) Added support for the Microsoft Xbox 360 (xbox360) game system by running xenia via Wine or Proton
|
* (Linux) Added support for the Microsoft Xbox 360 (xbox360) game system by running xenia via Wine or Proton
|
||||||
* (Linux) Added support for the Atari Jaguar CD (atarijaguarcd) game system by running BigPEmu via Wine or Proton
|
* (Linux) Added support for the Atari Jaguar CD (atarijaguarcd) game system by running BigPEmu via Wine or Proton
|
||||||
* (Linux) Added BigPEmu Wine and BigPEmu Proton as alternative emulators for the atarijaguar system
|
* (Linux) Added BigPEmu Wine and BigPEmu Proton as alternative emulators for the atarijaguar system
|
||||||
|
|
36
FAQ.md
36
FAQ.md
|
@ -10,7 +10,7 @@ The correct name is EmulationStation Desktop Edition, which is for practical rea
|
||||||
|
|
||||||
## Is this software available for free, and is it open source?
|
## Is this software available for free, and is it open source?
|
||||||
|
|
||||||
ES-DE is available for free, and will continue to be available for free, if someone is asking you to pay money to use ES-DE in any form then you are being scammed. The software is released under the MIT open source license with the source code being publicly and freely available. Voluntary donations to support the project are however very welcome.
|
ES-DE is available for free. Voluntary donations to support the project are however very welcome. The application is released under the MIT open source license with the source code readily available to anyone via the project's [GitLab site](https://gitlab.com/es-de/emulationstation-de).
|
||||||
|
|
||||||
## Which operating systems are supported?
|
## Which operating systems are supported?
|
||||||
|
|
||||||
|
@ -34,7 +34,11 @@ Menus in ES-DE are not lists but grids, sometimes there is only a list but somet
|
||||||
|
|
||||||
## Can I change the system sorting to not sort by full system names?
|
## Can I change the system sorting to not sort by full system names?
|
||||||
|
|
||||||
Yes this is possible via an es_systems_sorting.xml file that you place in the ~/.emulationstation/custom_systems/ directory. There are four such files bundled with ES-DE which sort by _"Hardware type, release year", "Manufacturer, hardware type, release year", "Manufacturer, release year"_ or simply _"Release year"_. You can create your own custom sorting files as well if needed. More details about this setup can be found in the _es_systems_sorting.xml_ section of the [Building and advanced configuration](INSTALL.md#es_systems_sortingxml) document.
|
Yes the systems sorting configuration file can be selected via the _Systems sorting_ option in the _UI Settings_ menu. There are four such files bundled with ES-DE to sort by _"Release year", "Manufacturer, release year", "Hardware type, release year"_ and _"Manufacturer, hardware type, release year"_. If you don't want to use any of the bundled files then you can create your own custom sorting file and place it into the ~/.emulationstation/custom_systems/ directory. More details about this setup can be found in the _es_systems_sorting.xml_ section of the [Building and advanced configuration](INSTALL.md#es_systems_sortingxml) document.
|
||||||
|
|
||||||
|
## I'm missing some systems like SNES MSU-1 and WiiWare, could those get added to ES-DE?
|
||||||
|
|
||||||
|
To keep the system count within reason hack systems and e-shop systems are not included and there are no plans to add them in. This would include things like _PSP Minis, PlayStation Store, WiiWare, SNES MSU-1, Sega Mega Drive MSU-MD, ROM Hacks_ and so on. It's possible to add such games to the regular systems though, for example by placing them inside their own folders if you want to clearly separate them from the rest of the games. You could also create custom collections for these games.
|
||||||
|
|
||||||
## 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?
|
||||||
|
|
||||||
|
@ -66,7 +70,7 @@ This is related to the two questions above, ES-DE does not perform any emulator
|
||||||
|
|
||||||
## Why does it take a long time for ES-DE to resume after I've exited a game?
|
## Why does it take a long time for ES-DE to resume after I've exited a game?
|
||||||
|
|
||||||
With a few notable exceptions like the Valve Steam system on all platforms and the MAME standalone emulator on Windows, ES-DE will wait for emulators and games to fully exit before it resumes. Some emulators take quite some time to fully exit (sometimes even after their application windows have been destroyed). This may make it seem as if ES-DE is hanging although it's actually waiting for the launched child process to exit. Another reason for a delayed resume is if a custom event script is executed on game end which itself takes a long time to run. If you have such a custom setup then there is a way to work around this by executing scripts as background processes, which is documented [here](INSTALL.md#custom-event-scripts).
|
With a few notable exceptions like the Valve Steam system, ES-DE will wait for emulators and games to fully exit before it resumes. Some emulators take quite some time to fully exit (sometimes even after their application windows have been destroyed). This may make it seem as if ES-DE is hanging although it's actually waiting for the launched child process to exit. Another reason for a delayed resume is if a custom event script is executed on game end which itself takes a long time to run. If you have such a custom setup then there is a way to work around this by executing scripts as background processes. How this is accomplished is documented in the _Custom event scripts_ section of the [Building and advanced configuration](INSTALL.md#custom-event-scripts) document.
|
||||||
|
|
||||||
## I have many games with multiple files, is there a way to show these as single entries?
|
## I have many games with multiple files, is there a way to show these as single entries?
|
||||||
|
|
||||||
|
@ -78,11 +82,11 @@ See the question above for a possible solution. Another approach would be to hid
|
||||||
|
|
||||||
## When I hide a game using the metadata editor it's not really getting hidden, is this a bug?
|
## 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 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.
|
No, by default games are not removed from the gamelists when they are hidden and are instead only marked with a much lower opacity. You need to disable the setting _Show hidden games_ 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.
|
||||||
|
|
||||||
## I'm using Linux or macOS and I can't find the .emulationstation directory, where is it located?
|
## I'm using Linux or macOS and I can't find the .emulationstation directory, where is it located?
|
||||||
|
|
||||||
The .emulationstation directory is normally located in your home directory, but on these Unix-based operating systems files and directories starting with a dot are hidden by default. So you need to enable hidden files and directories in your file manager. On macOS this is done in Finder using the Shift + Command + . (a dot) keyboard combination. On Linux it depends on which file manager you're using, but in Dolphin it's accomplished by using the Alt + . (a dot) keyboard combination or via the corresponding entry in the hamburger menu.
|
The .emulationstation directory is normally located in your home directory, but on these Unix-based operating systems files and directories starting with a dot are hidden by default. So you need to enable hidden files and directories in your file manager. On macOS this is done in Finder using the Shift + Command + . (a dot) keyboard combination. On Linux it depends on which file manager you're using, but in KDE's Dolphin it's accomplished by using the Alt + . (a dot) keyboard combination or via the corresponding entry in the hamburger menu.
|
||||||
|
|
||||||
## I can't find a ROM directory setting in the user interface, so how do I relocate my games?
|
## I can't find a ROM directory setting in the user interface, so how do I relocate my games?
|
||||||
|
|
||||||
|
@ -102,11 +106,11 @@ This release of RetroArch has multiple technical issues so it's not officially s
|
||||||
|
|
||||||
## How do I add more themes?
|
## How do I add more themes?
|
||||||
|
|
||||||
You would normally use the built-in theme downloader to install additional themes. This utility can be found in the _UI Settings_ menu. There is also a [web version](https://gitlab.com/es-de/themes/themes-list) of the themes list which contains a number of additional themes not available via the theme downloader interface.
|
You would normally use the built-in theme downloader to install additional themes. This utility can be found in the _UI Settings_ menu. There is also a [web version](https://gitlab.com/es-de/themes/themes-list) of the themes list which contains a number of additional themes not available via the downloader interface. Themes can also be updated via the downloader which is a recommended activity to perform every now and then, especially after upgrading to a newer ES-DE release as there may have been new systems added.
|
||||||
|
|
||||||
## The themes I've added don't seem to work?
|
## I added some EmulationStation themes manually but they don't seem to show up inside ES-DE?
|
||||||
|
|
||||||
Most themes from Batocera, Recalbox and similar EmulationStation forks can't be used as ES-DE has a different theme engine than those applications. For the time being RetroPie themes can be used, but support for these legacy themes will be removed in a future version. It's generally a good idea to stick to the themes provided via the theme downloader and the official [themes list](https://gitlab.com/es-de/themes/themes-list).
|
Only themes made specifically for ES-DE can be used. If you want to use a theme from Batocera, Recalbox, RetroBat, RetroPie etc. then it first needs to be ported to the ES-DE theme engine. If you place a non-supported theme in the ~/.emulationtation/themes/ directory then this will be ignored on startup, meaning it will not be selectable from the _UI Settings_ menu.
|
||||||
|
|
||||||
## I used to be a Batocera/Recalbox user and ES-DE can't seem to find some of my games?
|
## I used to be a Batocera/Recalbox user and ES-DE can't seem to find some of my games?
|
||||||
|
|
||||||
|
@ -114,15 +118,15 @@ ES-DE uses mostly the same system names as these other frontends, but there are
|
||||||
|
|
||||||
## Can ES-DE update itself automatically when a new release becomes available?
|
## Can ES-DE update itself automatically when a new release becomes available?
|
||||||
|
|
||||||
There is a built-in application updater that works with the Linux AppImage releases. And if using the AUR release then updates are handled via the operating system's package manager. Likewise if using RetroDECK, then ES-DE is updated as part of the overall RetroDECK Flatpak. For Windows and macOS only a version check and a notification window has been implemented, meaning the new release needs to be manually downloaded from the ES-DE website. The process to manually upgrade ES-DE is covered in the _Upgrading to a newer release_ section of the [User guide](USERGUIDE.md#upgrading-to-a-newer-release). If you find the update notification messages annoying you can change the frequency of update checks between _Always_, _Daily_, _Weekly_, _Monthly_ or _Never_ from the _Other Settings_ menu.
|
There is a built-in application updater that works with the Linux AppImage releases. And if using the AUR release updates are handled via the operating system's package manager. Likewise if using RetroDECK, then ES-DE is updated as part of the overall RetroDECK Flatpak. For Windows and macOS the application updater will download the latest version (as of ES-DE 2.2.0) but you need to manually perform the upgrade. The process to upgrade ES-DE is covered in the _Upgrading to a newer release_ section of the [User guide](USERGUIDE.md#upgrading-to-a-newer-release). If you find the update notification messages annoying you can change the frequency of update checks between _Always_, _Daily_, _Weekly_, _Monthly_ or _Never_ from the _Other Settings_ menu.
|
||||||
|
|
||||||
## I can't find any game media links in the gamelist.xml files, where is this data stored?
|
## I can't find any game media links in the gamelist.xml files, where is this data stored?
|
||||||
|
|
||||||
ES-DE works very differently compared to all other EmulationStation forks when it comes to handling of game media. There are no links in the gamelist.xml files, instead media files are simply matched against the ROM/game file names which makes for a much simpler, faster and completely portable setup. Migrating game media from other EmulationStation forks (and potentially from other frontends as well) can be accomplished quite easily. See the next question below for more information. Make sure to also read the _Migrating from other EmulationStation forks_ section of the [User guide](USERGUIDE.md#migrating-from-other-emulationstation-forks) to avoid data loss if running ES-DE with existing data from another EmulationStation fork.
|
ES-DE works differently compared to all other EmulationStation forks when it comes to handling of game media. There are no links in the gamelist.xml files, instead media files are matched against the ROM/game file names which makes for a much simpler, faster and completely portable setup. Migrating game media from other EmulationStation forks (and potentially from other frontends as well) can be accomplished quite easily. See the next question below for more information. Make sure to also read the _Migrating from other EmulationStation forks_ section of the [User guide](USERGUIDE.md#migrating-from-other-emulationstation-forks) to avoid data loss if running ES-DE with existing data from another EmulationStation fork.
|
||||||
|
|
||||||
## It seems like gamelist.xml files in the ROMs directory tree are no longer getting loaded as of ES-DE 2.0?
|
## It seems like gamelist.xml files in the ROM directory tree are not getting loaded?
|
||||||
|
|
||||||
Yes, to optionally read gamelist.xml files from the ROMs directory tree in previous releases was a mistake as it has caused a lot of confusion as well as invalid bug reports. As such the logic has now been changed to only read these files from .emulationstation/gamelists/ which is where they belong. If you insist on retaining the old logic you can do so by manually setting LegacyGamelistFileLocation to true in es_settings.xml as explained [here](INSTALL.md#settings-not-configurable-via-the-gui), but it's definitely not recommended.
|
These files are not loaded by default as of ES-DE 2.0.0, only files placed in .emulationstation/gamelists/ are processed. If you insist on retaining the old logic of also looking for gamelist.xml files in the ROM directory tree then you can enable the LegacyGamelistFileLocation setting in es_settings.xml as explained in the _Settings not configurable via the GUI_ section of the [Building and advanced configuration](INSTALL.md#settings-not-configurable-via-the-gui) document.
|
||||||
|
|
||||||
## Why do I sometimes get error messages when scraping stating that files are less than 350 bytes in size?
|
## Why do I sometimes get error messages when scraping stating that files are less than 350 bytes in size?
|
||||||
|
|
||||||
|
@ -138,14 +142,14 @@ If the controller works in other applications and games but not in ES-DE, then y
|
||||||
|
|
||||||
## Why is every controller button press registered twice in ES-DE?
|
## Why is every controller button press registered twice in ES-DE?
|
||||||
|
|
||||||
There are two reasons why double input is received in ES-DE, either because Steam is running and the _Desktop Configuration_ of the Steam Controller functionality is enabled, or due to buggy controller drivers where two devices are registered in parallel by the operating system. In the former case, enabling the Steam Controller functionality will by default also enable keyboard input to be sent whenever a button is pressed on the controller. As ES-DE reads both the keyboard and controller events this will be registered as double or conflicting input. To disable this functionality, go into the Steam settings interface, then select the _Controller_ entry followed by the _DESKTOP CONFIGURATION_ button. Make sure to remove all keyboard mappings and the problem should disappear. An alternative solution is to add ES-DE as a Non-Steam game and launch it via the Steam application in which case the keyboard events will be automatically disabled (that's how it's normally done on the Steam Deck for instance). Making sure Steam is shut down while ES-DE is running is another possible solution.
|
There are two main reasons why double input is received in ES-DE, either because Steam is running and Steam Input with Desktop Layout mappings is enabled, or due to buggy controller drivers where two devices are registered in parallel by the operating system. In the former case, enabling the Steam Input functionality will by default also enable keyboard input to be sent whenever a button is pressed on the controller. As ES-DE by default reads both the keyboard and controller events this will be registered as double or conflicting input. To disable this functionality, go into the Steam _Settings_ interface, then select the _Controller_ tab followed by the _Edit_ button for the _Desktop Layout_ option. Make sure to remove all keyboard mappings and the problem should disappear. An alternative solution is to add ES-DE as a Non-Steam game and launch it via the Steam application in which case the keyboard events will be automatically disabled (that's how it's normally done on the Steam Deck for instance). Making sure Steam is shut down while ES-DE is running is another possible solution. Yet another solution is to enable the _Ignore keyboard input_ option in the _Input Device Settings_ menu, although this is generally not recommended.
|
||||||
|
|
||||||
The second reason for double input is buggy controller drivers. This seems to only occur with wireless controllers but it's possible that it also happens with wired devices. As ES-DE auto-configures all devices, every button press will in practice be received twice. The easiest solution to this problem is to enable the option _Only accept input from first controller_ in the _Input device settings_ menu, but the drawback of this is that all other attached controllers will also be ignored. A more proper workaround is to blacklist the redundant controller device, see the previous question above as blacklisting is essentially a custom controller profile entry. Note that neither of these approaches will affect the emulators/games launched from ES-DE, it only applies to the ES-DE application itself.
|
The second reason for double input is buggy controller drivers. This seems to only occur with wireless controllers but it's possible that it also happens with wired devices. As ES-DE auto-configures all devices, every button press will in practice be received twice. The easiest solution to this problem is to enable the option _Only accept input from first controller_ in the _Input device settings_ menu, but the drawback of this is that all other attached controllers will also be ignored. A more proper workaround is to blacklist the redundant controller device, see the previous question above as blacklisting is essentially a custom controller profile entry. Note that neither of these approaches will affect the emulators/games launched from ES-DE, it only applies to the ES-DE application itself.
|
||||||
|
|
||||||
## I'm missing a feature, how can I make a request to have it added?
|
## I'm missing a feature, how can I make a request to have it added?
|
||||||
|
|
||||||
First check the project [Kanban](https://gitlab.com/es-de/emulationstation-de/-/boards/1823720) board which contains an overview of planned future features and search for the functionality you would like to see added. Chances are there is already a card on the board describing what you intended to request. You can also check the [Roadmap](ROADMAP.md) document which contains a list of planned major features. If you can't find the feature you're looking for, you can request it either via adding an issue directly to the Kanban board, or by asking for it in our [Discord](https://discord.gg/EVVX4DqWAP) server.
|
First check the project [Kanban](https://gitlab.com/es-de/emulationstation-de/-/boards/1823720) board which contains an overview of planned future features and search for the functionality you would like to see added. Chances are there is already a card on the board describing what you intended to request. You can also check the [Roadmap](ROADMAP.md) document which contains a list of planned major features. If you can't find the feature you're looking for, then you can request it either via adding an issue directly to the Kanban board, or by asking for it in our [Discord](https://discord.gg/EVVX4DqWAP) server.
|
||||||
|
|
||||||
## I want to setup a gaming appliance based on the Raspberry Pi, can I use ES-DE for this?
|
## I want to setup a gaming appliance based on a single-board computer, can I use ES-DE for this?
|
||||||
|
|
||||||
This is not the goal of ES-DE, the application requires a desktop environment to run. If you want to run a frontend on a single-board computer or similar then there are better options out there. But many people run ES-DE on arcade cabinets and similar which is definitely possible, it just requires a desktop-class operating system.
|
This is not the goal of ES-DE, the application requires a desktop environment to run. If you want to run a frontend on a single-board computer without using Xorg or Wayland then there are better options out there. But many people run ES-DE on arcade cabinets and similar which is definitely possible, it just requires a desktop-class operating system.
|
||||||
|
|
|
@ -1337,6 +1337,8 @@ The following variables are expanded for the `command` tag:
|
||||||
|
|
||||||
`%GAMEDIR%` - Replaced with the path to the game.
|
`%GAMEDIR%` - Replaced with the path to the game.
|
||||||
|
|
||||||
|
`%GAMEDIRRAW%` - Replaced with the unescaped 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.
|
`%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.
|
`%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.
|
||||||
|
|
|
@ -1230,19 +1230,6 @@ That's basically it, for the atarijaguar system just make sure to select _BigPEm
|
||||||
|
|
||||||
There are many settings in Wine that may affect compatibility, performance etc. but covering all that is beyond the scope of this guide.
|
There are many settings in Wine that may affect compatibility, performance etc. but covering all that is beyond the scope of this guide.
|
||||||
|
|
||||||
### Bally Astrocade
|
|
||||||
|
|
||||||
Place your ROMs in the `~/ROMs/astrocde` directory, the files must have the short MAME names such as _astrobat.zip_ and _conan.zip_. Also make sure that the BIOS archive astrocde.zip is included with the ROM set. If using MAME standalone then no further setup is required and the games should just launch.
|
|
||||||
|
|
||||||
If instead using the _MAME - Current_ RetroArch core, then a hash file must be added inside the RetroArch system directory at this location:
|
|
||||||
|
|
||||||
```
|
|
||||||
mame/hash/astrocde.xml
|
|
||||||
```
|
|
||||||
|
|
||||||
The hash file is available from the MAME GitHub repository: \
|
|
||||||
https://raw.githubusercontent.com/mamedev/mame/master/hash/astrocde.xml
|
|
||||||
|
|
||||||
### Commodore Amiga and CDTV
|
### Commodore Amiga and CDTV
|
||||||
|
|
||||||
There are multiple ways to run these games, for the computer models like the A500, A1200 etc. it's either via diskette images, hard disk images or using specially packaged WHDLoad games. For the CD32 and CDTV you normally run games via CD-ROM disc images. As for emulators all operating systems that ES-DE runs on support the PAUE RetroArch core and the FS-UAE standalone emulator. On Linux and macOS there is also support for the Amiberry standalone emulator.
|
There are multiple ways to run these games, for the computer models like the A500, A1200 etc. it's either via diskette images, hard disk images or using specially packaged WHDLoad games. For the CD32 and CDTV you normally run games via CD-ROM disc images. As for emulators all operating systems that ES-DE runs on support the PAUE RetroArch core and the FS-UAE standalone emulator. On Linux and macOS there is also support for the Amiberry standalone emulator.
|
||||||
|
@ -1452,7 +1439,26 @@ Setup for the standalone EasyRPG Player is identical with the exception that run
|
||||||
|
|
||||||
### Fujitsu FM Towns
|
### Fujitsu FM Towns
|
||||||
|
|
||||||
This system is emulated using Tsugaru or MAME standalone.
|
This system is emulated using MAME or Tsugaru.
|
||||||
|
|
||||||
|
**MAME**
|
||||||
|
|
||||||
|
As of the time of writing MAME has somehow preliminary FM Towns support, but it seems to work well enough for most games and support will likely improve over time.
|
||||||
|
|
||||||
|
Only CD-ROM games are supported and the .chd format is recommended. It's not adviced to go for game files using MAME software list names as these can't be scraped by either ScreenScraper or TheGames DB. It's instead better to use files with full game names.
|
||||||
|
|
||||||
|
You also need the `fmtowns.zip` BIOS archive placed in ~/ROMs/fmtowns/ for the games to run.
|
||||||
|
|
||||||
|
Here's an example setup:
|
||||||
|
```
|
||||||
|
~/ROMs/fmtowns/Flying Shark (Jp-En).chd
|
||||||
|
~/ROMs/fmtowns/Shadow of the Beast (1994)(Psygnosis)(Jp-En).bin
|
||||||
|
~/ROMs/fmtowns/Shadow of the Beast (1994)(Psygnosis)(Jp-En).cue
|
||||||
|
~/ROMs/fmtowns/fmtowns.zip
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that if you're using MAME standalone you will need to enable UI controls to be able to exit the emulator via the normal exit key. The following page documents the default keys for exiting and toggling UI mode:\
|
||||||
|
https://docs.mamedev.org/usingmame/defaultkeys.html
|
||||||
|
|
||||||
**Tsugaru**
|
**Tsugaru**
|
||||||
|
|
||||||
|
@ -1504,15 +1510,6 @@ To map the controller to the keyboard and to set a 33 MHz CPU speed, the file co
|
||||||
-FREQ 33 -GAMEPORT0 KEY
|
-FREQ 33 -GAMEPORT0 KEY
|
||||||
```
|
```
|
||||||
|
|
||||||
**MAME standalone**
|
|
||||||
|
|
||||||
As of the time of writing MAME only has preliminary FM Towns support, but this will hopefully improve over time. All games need to be packaged specifically for MAME with software list names as filenames. You also need the `fmtowns.zip` BIOS archive stored in ~/ROMs/fmtowns/ but apart from this it should be fairly straightforward to launch these games. Just be aware that you can't launch .iso or .cue files directly with MAME, only Tsugaru can launch such files.
|
|
||||||
|
|
||||||
Note that you will need to enable UI controls in MAME to be able to exit the emulator via the normal exit key. The following page documents the default keys for exiting and toggling UI mode:\
|
|
||||||
https://docs.mamedev.org/usingmame/defaultkeys.html
|
|
||||||
|
|
||||||
Scraping can also be a bit challenging as neither ScreenScraper nor TheGamesDB support MAME software list names for this system. So it's recommended to run the scraper in interactive mode and refine the searches for all games that are not properly identified.
|
|
||||||
|
|
||||||
### LaserDisc Games
|
### LaserDisc Games
|
||||||
|
|
||||||
There are three ways to run LaserDisc games in ES-DE, via MAME, via Hypseus Singe or via the DirkSimple RetroArch core. There are also two separate systems available, _daphne_ and _laserdisc_. The latter is recommended as the _daphne_ system is mostly existing for legacy reasons and may be removed in a future ES-DE release. The configuration for these two systems is identical as they are essentially clones.
|
There are three ways to run LaserDisc games in ES-DE, via MAME, via Hypseus Singe or via the DirkSimple RetroArch core. There are also two separate systems available, _daphne_ and _laserdisc_. The latter is recommended as the _daphne_ system is mostly existing for legacy reasons and may be removed in a future ES-DE release. The configuration for these two systems is identical as they are essentially clones.
|
||||||
|
@ -3798,7 +3795,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
||||||
| arcadia | Emerson Arcadia 2001 | MAME - Current | MAME **(Standalone)** | No | Single archive or ROM file |
|
| arcadia | Emerson Arcadia 2001 | MAME - Current | MAME **(Standalone)** | No | Single archive or ROM file |
|
||||||
| archimedes | Acorn Archimedes | MAME [Model A440/1] **(Standalone)** | MAME [Model A3000] **(Standalone)**,<br>MAME [Model A310] **(Standalone)**,<br>MAME [Model A540] **(Standalone)** | Yes | |
|
| archimedes | Acorn Archimedes | MAME [Model A440/1] **(Standalone)** | MAME [Model A3000] **(Standalone)**,<br>MAME [Model A310] **(Standalone)**,<br>MAME [Model A540] **(Standalone)** | Yes | |
|
||||||
| arduboy | Arduboy Miniature Game System | Arduous | | No | Single archive or .hex file |
|
| arduboy | Arduboy Miniature Game System | Arduous | | No | Single archive or .hex file |
|
||||||
| astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** | Yes | See the specific _Bally Astrocade_ section elsewhere in this guide |
|
| astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file |
|
||||||
| atari2600 | Atari 2600 | Stella | Stella 2014,<br>Stella **(Standalone)**,<br>Gopher2600 **(Standalone)** [UW],<br>ares **(Standalone)** | No | Single archive or ROM file |
|
| atari2600 | Atari 2600 | Stella | Stella 2014,<br>Stella **(Standalone)**,<br>Gopher2600 **(Standalone)** [UW],<br>ares **(Standalone)** | No | Single archive or ROM file |
|
||||||
| atari5200 | Atari 5200 | a5200 | Atari800,<br>Atari800 **(Standalone)**,<br>Altirra **(Standalone)** [W] | Yes except for Altirra | Single archive or ROM file |
|
| atari5200 | Atari 5200 | a5200 | Atari800,<br>Atari800 **(Standalone)**,<br>Altirra **(Standalone)** [W] | Yes except for Altirra | Single archive or ROM file |
|
||||||
| atari7800 | Atari 7800 ProSystem | ProSystem | MAME **(Standalone)** | Yes | Single archive or ROM file |
|
| atari7800 | Atari 7800 ProSystem | ProSystem | MAME **(Standalone)** | Yes | Single archive or ROM file |
|
||||||
|
@ -3839,7 +3836,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
||||||
| fds | Nintendo Famicom Disk System | Mesen | Mesen **(Standalone)** [UW],<br>Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>Mednafen **(Standalone)**,<br>ares **(Standalone)** | Yes | Single archive or ROM file |
|
| fds | Nintendo Famicom Disk System | Mesen | Mesen **(Standalone)** [UW],<br>Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>Mednafen **(Standalone)**,<br>ares **(Standalone)** | Yes | Single archive or ROM file |
|
||||||
| flash | Adobe Flash | Ruffle **(Standalone)** | Lightspark **(Standalone)** [U],<br>ArcadeFlashWeb **(Standalone)** [W] | No | Single .swf file |
|
| flash | Adobe Flash | Ruffle **(Standalone)** | Lightspark **(Standalone)** [U],<br>ArcadeFlashWeb **(Standalone)** [W] | No | Single .swf file |
|
||||||
| fm7 | Fujitsu FM-7 | MAME [FM-7 Diskette] **(Standalone)** | MAME [FM-7 Tape] **(Standalone)**,<br>MAME [FM-7 Software list] **(Standalone)**,<br>MAME [FM77AV Diskette] **(Standalone)**,<br>MAME [FM77AV Tape] **(Standalone)**,<br>MAME [FM77AV Software list] **(Standalone)** | Yes | For tape files you need to manually start the cassette player from the MAME menu after the "load" command, as well as entering the "run" command after loading is complete |
|
| fm7 | Fujitsu FM-7 | MAME [FM-7 Diskette] **(Standalone)** | MAME [FM-7 Tape] **(Standalone)**,<br>MAME [FM-7 Software list] **(Standalone)**,<br>MAME [FM77AV Diskette] **(Standalone)**,<br>MAME [FM77AV Tape] **(Standalone)**,<br>MAME [FM77AV Software list] **(Standalone)** | Yes | For tape files you need to manually start the cassette player from the MAME menu after the "load" command, as well as entering the "run" command after loading is complete |
|
||||||
| fmtowns | Fujitsu FM Towns | Tsugaru **(Standalone)** [UW],<br>MAME **(Standalone)** [M] | MAME **(Standalone)** [UW] | Yes | See the specific _Fujitsu FM Towns_ section elsewhere in this guide |
|
| fmtowns | Fujitsu FM Towns | MAME - Current,<br>MAME **(Standalone)** | Tsugaru **(Standalone)** [UW] | Yes | See the specific _Fujitsu FM Towns_ section elsewhere in this guide |
|
||||||
| fpinball | Future Pinball | Future Pinball **(Standalone)** [W] | | No | |
|
| fpinball | Future Pinball | Future Pinball **(Standalone)** [W] | | No | |
|
||||||
| gamate | Bit Corporation Gamate | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file |
|
| gamate | Bit Corporation Gamate | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file |
|
||||||
| gameandwatch | Nintendo Game and Watch | MAME Local Artwork **(Standalone)** | MAME **(Standalone)**,<br>Handheld Electronic (GW) | No | See the specific _LCD handheld games_ section elsewhere in this guide |
|
| gameandwatch | Nintendo Game and Watch | MAME Local Artwork **(Standalone)** | MAME **(Standalone)**,<br>Handheld Electronic (GW) | No | See the specific _LCD handheld games_ section elsewhere in this guide |
|
||||||
|
|
Loading…
Reference in a new issue