Emulation/emulationstation-de
1
0
Fork 0
mirror of https://gitlab.com/es-de/emulationstation-de.git synced 2024-05-16 11:21:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2024-03-21 20:02:20 +01:00
parent f271839e8d
commit 4a9e04f106
15 changed files with 55 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
ANDROID-DEV.md
View file

@ -1,4 +1,4 @@
# ES-DE (EmulationStation Desktop Edition) 3.0 (development version) - Android documentation
# ES-DE Frontend (development version) - Android documentation
This document contains information specific to the Android release, for more general ES-DE documentation refer to the [User guide](USERGUIDE.md) as well as the general [FAQ](FAQ.md).
@ -453,6 +453,7 @@ This is clearly not a complete list of Android devices, but rather those we know
| Retroid | Pocket 2s | 11 | Yes | None | |
| Retroid | Pocket 3+ | 11 | Yes | None | |
| Retroid | Pocket 4 Pro | 13 | Yes | None | |
| Samsung | Galaxy A20 | 10 | Yes | No write access to SD card | ROMs folder can be moved to SD card after setup and be used in read-only mode |
| Samsung | Galaxy Note 20 | 13 | No | Fails at configurator/onboarding | Has a non-standard app permission screen, possibly this breaks the configurator |
| Samsung | Galaxy S9+ | 10 | Yes | | |
| Samsung | Galaxy S10 | 12 | Yes | None | |

3
ANDROID.md
View file

@ -1,4 +1,4 @@
# ES-DE (EmulationStation Desktop Edition) 3.0 - Android documentation
# ES-DE Frontend - Android documentation
This document contains information specific to the Android release, for more general ES-DE documentation refer to the [User guide](USERGUIDE.md) as well as the general [FAQ](FAQ.md).
@ -446,6 +446,7 @@ This is clearly not a complete list of Android devices, but rather those we know
| Retroid | Pocket 2s | 11 | Yes | None | |
| Retroid | Pocket 3+ | 11 | Yes | None | |
| Retroid | Pocket 4 Pro | 13 | Yes | None | |
| Samsung | Galaxy A20 | 10 | Yes | No write access to SD card | ROMs folder can be moved to SD card after setup and be used in read-only mode |
| Samsung | Galaxy Note 20 | 13 | No | Fails at configurator/onboarding | Has a non-standard app permission screen, possibly this breaks the configurator |
| Samsung | Galaxy S9+ | 10 | Yes | | |
| Samsung | Galaxy S10 | 12 | Yes | None | |

2
CHANGELOG.md
View file

@ -1,4 +1,4 @@
# ES-DE (EmulationStation Desktop Edition) - Changelog
# ES-DE Frontend - Changelog
## Version 3.0.1-xx (Android intermediate) (in development)

9
CREDITS.md
View file

@ -1,15 +1,14 @@
# ES-DE (EmulationStation Desktop Edition) - Credits
# ES-DE Frontend - Credits
# Programming
**ES-DE**\
Leon Styhre \
Sophia Hadash
Leon Styhre
**RetroPie fork**\
**RetroPie EmulationStation**\
RetroPie community
**Original version**\
**Original EmulationStation**\
Alec Lofquist
# Original UI Art & Design

4
FAQ-ANDROID.md
View file

@ -1,4 +1,4 @@
# ES-DE (EmulationStation Desktop Edition) - Frequently Asked Questions for Android
# ES-DE Frontend - Frequently Asked Questions for Android
In addition to this document it's a good idea to read the [Android documentation](ANDROID.md) and the [User guide](USERGUIDE.md).
@ -83,7 +83,7 @@ No Android may stop applications that are not currently focused if it needs to r
## On game launch RetroArch runs an old game instead of the one I just selected, how do I prevent this?
We have a video on our YouTube channel describing how to configure RetroArch correctly so that it quits completely when you're exiting a game:\
There is a video on the official ES-DE YouTube channel on how to configure RetroArch correctly so that it quits completely when you're exiting a game:\
https://www.youtube.com/watch?v=k5WWacfIn6Y
## What type of Android devices are supported

4
FAQ.md
View file

@ -1,8 +1,8 @@
# ES-DE (EmulationStation Desktop Edition) - Frequently Asked Questions
# ES-DE Frontend - Frequently Asked Questions
## What's the correct name for the application? ES-DE, EmulationStation etc?
As of the 3.0.0 release the official name for the project and application is ES-DE or sometimes ES-DE Frontend. This stands for EmulationStation Desktop Edition as the project originated from the RetroPie fork of EmulationStation in 2020, and was originally intended for desktop computers. However the application has now changed so much that it would just cause confusion to keep the EmulationStation name. During a transition period EmulationStation Desktop Edition will be included as a subtitle on the splash screen and mentioned in some documentation entries, but long term this will be dropped entirely. The red version of the EmulationStation logo will however remain as it's part of the application legacy.
As of the 3.0.0 release the official name for the project and application is ES-DE Frontend or simply ES-DE. This originally stood for EmulationStation Desktop Edition as the project originated from the RetroPie fork of EmulationStation in 2020, and was originally intended for desktop computers. However the application has now changed so much that it would just cause confusion to keep the EmulationStation name. During a transition period EmulationStation Desktop Edition will be included as a subtitle on the splash screen and mentioned in some documentation entries, but long term this will be dropped entirely. The red version of the EmulationStation logo will however remain as it's part of the application legacy.
## Is this software available for free, and is it open source?

2
INSTALL-DEV.md
View file

@ -1,4 +1,4 @@
# ES-DE (EmulationStation Desktop Edition) v3.0 (development version) - Building and advanced configuration
# ES-DE Frontend (development version) - Building and advanced configuration
This document is only relevant for the current ES-DE development version, if you would like to see the documentation for the latest stable release, refer to [INSTALL.md](INSTALL.md) instead.

2
INSTALL.md
View file

@ -1,4 +1,4 @@
# ES-DE (EmulationStation Desktop Edition) v3.0 - Building and advanced configuration
# ES-DE Frontend - Building and advanced configuration
Table of contents:

25
README.md
View file

@ -1,26 +1,35 @@
# ES-DE (EmulationStation Desktop Edition)
# ES-DE Frontend
ES-DE is a frontend for browsing and launching games from your multi-platform game collection.
ES-DE (formerly EmulationStation Desktop Edition) is a frontend for browsing and launching games from your multi-platform collection.
It's officially supported on Linux, macOS, Windows and Android but can also be used on BSD Unix and the Raspberry Pi if you build it yourself from source code.
Website:\
[https://es-de.org](https://es-de.org)
https://es-de.org
Patreon:\
https://www.patreon.com/es_de
YouTube:\
https://www.youtube.com/@ES-DE_Frontend
Discord:\
[https://discord.gg/EVVX4DqWAP](https://discord.gg/EVVX4DqWAP)
https://discord.gg/EVVX4DqWAP
The goal of this project is to make a high quality frontend that is easy to use, requires minimal setup and configuration, looks nice, and is available across a wide range of operating systems.
It comes preconfigured for use with [RetroArch](https://www.retroarch.com) and a large selection of standalone emulators. It's also fully customizable so you can easily expand it to include emulators or applications not covered by the bundled configuration.
It comes preconfigured for use with a large selection of emulators, game engines, game managers and gaming services. It can also run locally installed games and applications. It's fully customizable, so you can easily expand it with support for additional systems and applications.
You can find the complete list of supported systems and emulators in the [User guide](USERGUIDE.md#supported-game-systems).
You can find the complete list of supported game systems in the [User guide](USERGUIDE.md#supported-game-systems).
Three themes (Linear, Modern and Slate) are bundled with the application, and additional themes can be found on the [official themes list](https://gitlab.com/es-de/themes/themes-list) or can be installed using the built-in theme downloader.
There are many high-quality themes that can be installed using the built-in theme downloader. You can also find the web version of the themes list here: \
https://gitlab.com/es-de/themes/themes-list
## Download
Visit https://es-de.org/ to download the latest ES-DE release or go to the [package registry](https://gitlab.com/es-de/emulationstation-de/-/packages) where you can also find most previous releases.
Visit https://es-de.org to download the latest ES-DE release or go to the [package registry](https://gitlab.com/es-de/emulationstation-de/-/packages) where you can also find most previous releases.
The Android port of ES-DE is a paid app, which you can get on [Patreon](https://www.patreon.com/es_de).
If you're using a Raspberry Pi or if you run FreeBSD, NetBSD or OpenBSD then you need to compile from source code as no prebuilt packages are provided for these platforms. A detailed build guide is available in [INSTALL.md](INSTALL.md).

2
ROADMAP.md
View file

@ -1,4 +1,4 @@
# ES-DE (EmulationStation Desktop Edition) - Feature roadmap
# ES-DE Frontend - Feature roadmap
ES-DE is developed using an agile methodology so which features to include per release is reviewed and adjusted continuously. As such this document is basically a list of the main features that are planned to be added eventually.

2
THEMES-DEV.md
View file

@ -1,4 +1,4 @@
# ES-DE (EmulationStation Desktop Edition) v3.0 (development version) - Themes
# ES-DE Frontend (development version) - Themes
**Note:** This document is only relevant for the current ES-DE development version, if you would like to see the documentation for the latest stable release, refer to [THEMES.md](THEMES.md) instead.

2
THEMES.md
View file

@ -1,4 +1,4 @@
# ES-DE (EmulationStation Desktop Edition) v3.0 - Themes
# ES-DE Frontend - Themes
If creating themes for ES-DE, please add `-es-de` to the repository/directory name to clearly indicate that it's a theme for this frontend. Two examples would be `linear-es-de` and `modern-es-de`. The actual theme name as defined using the `themeName` tag in capabilities.xml does of course not need to include the `-es-de` extension as that's the actual theme name that will be displayed when selecting themes from the _UI Settings_ menu. For example linear-es-de will be listed simply as _Linear_ in this menu.

11
USERGUIDE-DEV.md
View file

@ -1,4 +1,4 @@
# ES-DE (EmulationStation Desktop Edition) v3.0 (development version) - User guide
# ES-DE Frontend (development version) - User guide
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.
@ -2419,7 +2419,8 @@ When using this setup method you need to set the alternative emulator to _RPCS3
### Sony PlayStation Vita
Support for the PS Vita is currently experimental due to the early stages of development for the Vita3K emulator. While there's a growing list of games that are playable, integration with ES-DE is a bit rough at the moment. Hopefully this will improve as Vita3K evolves.
There is also a video on the official ES-DE YouTube channel on how to setup Vita3K:\
https://www.youtube.com/watch?v=4U8yAUJ9-Tk
On Android and Windows the Vita3K installation is straightforward, but on Linux you may need to place the emulator in a location recognized by ES-DE. See the [Using manually downloaded emulators on Linux](USERGUIDE-DEV.md#using-manually-downloaded-emulators-on-linux) section of this guide for more details. If using a Linux distribution that provides Vita3K via the repository (such as the AUR on Arch/Manjaro) then you can skip this step and install the emulator using your OS package manager.
@ -2730,6 +2731,9 @@ With folder flattening in place the .vpx and .vpt files will show up as file ent
Scraping means downloading metadata and game media files (images and videos) for the games in your collection.
In addition to this document there is a video on the official ES-DE YouTube channel on how to use the scraper:\
https://www.youtube.com/watch?v=js_m_jVnX2s
ES-DE supports the two scraper services [ScreenScraper.fr](https://www.screenscraper.fr) and [TheGamesDB.net](https://thegamesdb.net). In general TheGamesDB supports less formats and less systems but in some areas such PC gaming the quality is better and sometimes ScreenScraper is missing some specific information such as release dates where TheGamesDB may be able to fill in the gaps.
Here's an overview of what's supported when using these scrapers:
@ -3830,6 +3834,9 @@ The _custom_ image is not scraped, but can be manually added to the downloaded_m
If the game has a downloaded PDF manual then you can view it by pressing the _up_ button which will change the media viewer to PDF viewing mode. To get back to displaying videos and images when in this mode, press the _down_ button. Pages are navigated using the _left_ and _right_ buttons, and the trigger buttons can additionally be used to jump to the first and last page. When in PDF viewing mode it's possible to zoom in and out using the shoulder buttons. When zoomed in, the left, right, up and down buttons will pan the view. To re-enable page navigation either zoom out completely or reset the view by pressing the left or right trigger button.
There is also a video on the official ES-DE YouTube channel on how to download and view PDF manuals:\
https://www.youtube.com/watch?v=AH_gTWv4ZUM
Pressing any other button than those mentioned closes the media viewer.
The settings for the media viewer are similar to what is available for the screensavers; the audio can be enabled or disabled, the video can be stretched to fill the entire screen and scanlines and blur can be rendered on top of it. For screenshots and title screens, scanline rendering can be enabled or disabled. It's also possible to change the positioning of the help prompts to the top or bottom, or to disable them entirely. All these options are configurable via the _UI Settings_ menu and are described in more detail elsewhere in this document.

11
USERGUIDE.md
View file

@ -1,4 +1,4 @@
# ES-DE (EmulationStation Desktop Edition) v3.0 - User guide
# ES-DE Frontend - User guide
It's generally recommended to read the [Frequently Asked Questions (FAQ)](FAQ.md) document prior to diving into the information in this guide.
@ -2417,7 +2417,8 @@ When using this setup method you need to set the alternative emulator to _RPCS3
### Sony PlayStation Vita
Support for the PS Vita is currently experimental due to the early stages of development for the Vita3K emulator. While there's a growing list of games that are playable, integration with ES-DE is a bit rough at the moment. Hopefully this will improve as Vita3K evolves.
There is also a video on the official ES-DE YouTube channel on how to setup Vita3K:\
https://www.youtube.com/watch?v=4U8yAUJ9-Tk
On Android and Windows the Vita3K installation is straightforward, but on Linux you may need to place the emulator in a location recognized by ES-DE. See the [Using manually downloaded emulators on Linux](USERGUIDE.md#using-manually-downloaded-emulators-on-linux) section of this guide for more details. If using a Linux distribution that provides Vita3K via the repository (such as the AUR on Arch/Manjaro) then you can skip this step and install the emulator using your OS package manager.
@ -2728,6 +2729,9 @@ With folder flattening in place the .vpx and .vpt files will show up as file ent
Scraping means downloading metadata and game media files (images and videos) for the games in your collection.
In addition to this document there is a video on the official ES-DE YouTube channel on how to use the scraper:\
https://www.youtube.com/watch?v=js_m_jVnX2s
ES-DE supports the two scraper services [ScreenScraper.fr](https://www.screenscraper.fr) and [TheGamesDB.net](https://thegamesdb.net). In general TheGamesDB supports less formats and less systems but in some areas such PC gaming the quality is better and sometimes ScreenScraper is missing some specific information such as release dates where TheGamesDB may be able to fill in the gaps.
Here's an overview of what's supported when using these scrapers:
@ -3828,6 +3832,9 @@ The _custom_ image is not scraped, but can be manually added to the downloaded_m
If the game has a downloaded PDF manual then you can view it by pressing the _up_ button which will change the media viewer to PDF viewing mode. To get back to displaying videos and images when in this mode, press the _down_ button. Pages are navigated using the _left_ and _right_ buttons, and the trigger buttons can additionally be used to jump to the first and last page. When in PDF viewing mode it's possible to zoom in and out using the shoulder buttons. When zoomed in, the left, right, up and down buttons will pan the view. To re-enable page navigation either zoom out completely or reset the view by pressing the left or right trigger button.
There is also a video on the official ES-DE YouTube channel on how to download and view PDF manuals:\
https://www.youtube.com/watch?v=AH_gTWv4ZUM
Pressing any other button than those mentioned closes the media viewer.
The settings for the media viewer are similar to what is available for the screensavers; the audio can be enabled or disabled, the video can be stretched to fill the entire screen and scanlines and blur can be rendered on top of it. For screenshots and title screens, scanline rendering can be enabled or disabled. It's also possible to change the positioning of the help prompts to the top or bottom, or to disable them entirely. All these options are configurable via the _UI Settings_ menu and are described in more detail elsewhere in this document.

4
es-app/assets/Windows_Portable_README.txt
View file

@ -1,5 +1,5 @@
ES-DE (EmulationStation Desktop Edition) - Portable installation on Windows
---------------------------------------------------------------------------
ES-DE Frontend - Portable installation on Windows
-------------------------------------------------
ES-DE release:
3.0.1