Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-21 21:55:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-05-06 19:35:31 +02:00
parent b14d49faf5
commit 12c5c5b380
5 changed files with 21 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -146,6 +146,8 @@
### Detailed list of changes
* Added AetherSX2 standalone as an alternative emulator for the ps2 system on macOS
### Bug fixes
## Version 1.2.3

18
FAQ.md
View file

@ -1,7 +1,5 @@
# EmulationStation Desktop Edition (ES-DE) - Frequently Asked Questions
[[_TOC_]]
## What is this project and how it is related to other EmulationStation forks?
This project started in 2020 as a fork of RetroPie EmulationStation and it has been in very active development ever since. Large parts of the application have been rewritten and much functionality has been added, so overall it's a quite different application by now. It's a completely independent project from all other EmulationStation forks.
@ -24,7 +22,7 @@ ES-DE and EmuDeck are completely different projects, but we are friends and we c
## What systems/platforms and emulators are supported by ES-DE?
See the _Supported game systems_ section 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.
## I don't like the default emulator for a certain system, how can I choose an alternative?
@ -40,11 +38,11 @@ ES-DE acts strictly as a frontend, it does not interfere at all with the emulato
## How do I exit back from the emulators to ES-DE?
This is related to the previous question, ES-DE does not perform any emulator configuration or general system configuration. So you would either need to configure an exit button combination inside your emulator, or use a third party tool to map for instance Alt + F4 or Command + Q to a certain button combination on your controller. With that said, the plan is to add a section to the user guide on how to configure such third party tools. If you use RetroArch then it's easy to setup a button combination to exit back to ES-DE, which will apply to all cores. Refer to the RetroArch documentation or their support channels on how to accomplish this.
This is related to the previous question, ES-DE does not perform any emulator configuration or general system configuration. So you would either need to configure an exit button combination inside your emulator, or use a third party tool to map for instance Alt + F4 or Command + Q to a certain button combination on your controller. If you use RetroArch then it's easy to setup a button combination to exit back to ES-DE, which will apply to all cores. Refer to the RetroArch documentation or their support channels on how to accomplish this.
## How do I add more themes?
Most RetroPie EmulationStation theme sets will work with ES-DE, and there are numerous resources online where to find these. How to install them is described in the _Themes_ section of the [User guide](USERGUIDE.md#themes). Just be aware that some of these themes do not include support for modern systems like PlayStation 3 and Nintendo Switch so those platforms may look a bit ugly depending on how the theme is written.
Most RetroPie EmulationStation theme sets will work with ES-DE, and there are numerous resources online on where to find these. How to install them is described in the _Themes_ section of the [User guide](USERGUIDE.md#themes). Just be aware that some of these themes do not include support for modern systems like PlayStation 3 and Nintendo Switch so those platforms may look a bit ugly depending on how the theme is written.
## The themes I've added don't seem to work, what's wrong?
@ -52,12 +50,20 @@ Only RetroPie EmulationStation themes are supported, you can't use themes that w
## I used to be a Batocera/Recalbox user and ES-DE can't seem to find some of my games?
ES-DE uses the RetroPie naming conventions. In most cases the ROM directories are identical but for historical reasons some of them unfortunately don't match. For example Nintendo GameCube is called _gc_ in RetroPie and ES-DE while being named _gamecube_ in Batocera and Recalbox. The same is true for some other systems like n3ds vs. 3ds for Nintendo 3DS etc. See the _Supported game systems_ section of the [User guide](USERGUIDE.md#supported-game-systems) where there's a table listing the ROM directory names that ES-DE expects.
ES-DE uses the RetroPie naming conventions. In most cases the ROM directories are identical but for historical reasons some of them unfortunately don't match. For example Nintendo GameCube is called _gc_ in RetroPie and ES-DE while being named _gamecube_ in Batocera and Recalbox. The same is true for some other systems like n3ds vs. 3ds for Nintendo 3DS. See the _Supported game systems_ section at the bottom of the [User guide](USERGUIDE.md#supported-game-systems) where there's a table listing the system names that ES-DE expects.
## Can ES-DE update itself automatically when a new release becomes available?
This functionality is planned but not yet implemented. It will probably be rolled out in two steps, with the first step being a notitication that a new release is available, and at a later stage adding complete in-application update support. For the time being you therefore need to regularly check the https://es-de.org website or join the ES-DE [Discord](https://discord.gg/EVVX4DqWAP) server or [subreddit](https://www.reddit.com/r/EmulationStation_DE/) where new releases are announced.
## I can't find any game media links in the gamelist.xml files, where is this data stored?
ES-DE works completely different 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 name which makes for a much simpler, faster and completely portable setup. So replacing a game media file manually just involves copying a new file in place to overwrite the old file, no further updates are needed. Also see the next question below for more information.
## Can I use an external scraper application instead of the built-in scraper?
Yes to a certain extent this is supported and already used by some people. Few if any dedicated scrapers are updated specifically to support ES-DE though, so you may need to do some manual renaming and moving of files and directories for the time being. See the _Manually copying game media files_ section of the [User guide](USERGUIDE.md#manually-copying-game-media-files) for more details about this.
## I'm missing a feature, how can I request to have it added?
First check the project [Kanban](https://gitlab.com/leonstyhre/emulationstation-de/-/boards/1823720) board which contains an overview of planned future features and changes and search for the functionality you would like to see added. Chances are there is already a card on the board describing precisely what you intended to request. You can also check the [Release roadmap](CONTRIBUTING.md) which includes the planned implementation of 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 or [subreddit](https://www.reddit.com/r/EmulationStation_DE/).

2
README.md
View file

@ -72,6 +72,8 @@ If you would like to contribute to the development of ES-DE, then that's great!
# Additional information
[FAQ.md](FAQ.md) covers a number of Frequently Asked Questions and is recommended reading before diving into the other documents listed below.
[USERGUIDE.md](USERGUIDE.md) is a comprehensive guide on how to use ES-DE and it also contains a complete reference to all application settings.
[CHANGELOG.md](CHANGELOG.md) contains information about the current release as well as previous releases. This covers the features, improvements, bug fixes and known issues.

4
USERGUIDE-DEV.md
View file

@ -4,6 +4,8 @@ This document is intended as a quick start guide and as a reference for the appl
This version of the user guide is only relevant for the current ES-DE development version, if you are using the latest stable release, refer to [USERGUIDE.md](USERGUIDE.md) instead.
It's generally recommended to read the [Frequently Asked Questions](FAQ.md) document prior to diving into the information in this guide.
Table of contents:
[[_TOC_]]
@ -2232,7 +2234,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| pcfx | NEC PC-FX | Beetle PC-FX | | | |
| pokemini | Nintendo Pokémon Mini | PokeMini | | No | |
| ports | Ports | N/A | | No | Shell/batch script in separate folder (possibly combined with game data) |
| ps2 | Sony PlayStation 2 | PCSX2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 **(Standalone)** [UW],<br>Play! **(Standalone)** [UMW*] | Yes (No for Play!) | |
| ps2 | Sony PlayStation 2 | PCSX2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 **(Standalone)** [UW],<br>Play! **(Standalone)** [UMW*],<br>AetherSX2 **(Standalone)** [M] | Yes (No for Play!) | |
| ps3 | Sony PlayStation 3 | RPCS3 **(Standalone)** [UMW*] | | Yes | In separate folder (one folder per game with complete file structure retained, renamed to the .ps3 extension) |
| ps4 | Sony PlayStation 4 | _Placeholder_ | | | |
| psp | Sony PlayStation Portable | PPSSPP | PPSSPP **(Standalone)** | No | Single .iso file in root folder |

2
USERGUIDE.md
View file

@ -2,6 +2,8 @@
This document is intended as a quick start guide and as a reference for the application settings and general functionality. For details on how to build ES-DE from source code and to perform more advanced configuration, please refer to [INSTALL.md](INSTALL.md).
It's generally recommended to read the [Frequently Asked Questions](FAQ.md) document prior to diving into the information in this guide.
Table of contents:
[[_TOC_]]