From 8d45677484fd4535c1d6077a546f9bf18678a0a8 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Tue, 20 Feb 2024 17:26:50 +0100 Subject: [PATCH] Documentation update --- ANDROID.md | 4 +++- CHANGELOG.md | 15 ++++++++++++++- FAQ-ANDROID.md | 26 ++++++++++++++++++++++++++ FAQ.md | 2 +- 4 files changed, 44 insertions(+), 3 deletions(-) create mode 100644 FAQ-ANDROID.md diff --git a/ANDROID.md b/ANDROID.md index 0c7e8bf1b..747517af2 100644 --- a/ANDROID.md +++ b/ANDROID.md @@ -1,7 +1,9 @@ -# ES-DE (EmulationStation Desktop Edition) v3.0 (development version) - Android documentation +# ES-DE (EmulationStation Desktop Edition) v3.0 - Android documentation This document contains information specific to the Android release, for more general ES-DE documentation refer to the [User guide](USERGUIDE-DEV.md). +It's also generally recommended to read the [Frequently Asked Questions (FAQ) for Android](FAQ-ANDROID.md) document prior to diving into the information in this document. + Table of contents: [[_TOC_]] diff --git a/CHANGELOG.md b/CHANGELOG.md index 9e0bad016..30cc758cc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,12 +1,24 @@ # ES-DE (EmulationStation Desktop Edition) - Changelog +## Version 3.0.1 (in development) + +**Release date:** TBD + +### Release overview + +### Detailed list of changes + +### Bug fixes + +* (linear-es-de) Creating custom collections named "now-playing" or "completed" could lead to them being unthemed + ## Version 3.0.0 **Release date:** 2024-02-17 ### Release overview -The 3.0 release rebrands the application from EmulationStation Desktop Edition to simply ES-DE. And as part of this the application data directory has changed from .emulationstation to ES-DE and its internal structure has been improved. There is also a new default theme named Linear that is bundled with the application. +The main feature of the 3.0 release is that it adds support for the Android operating system. It also rebrands the application from EmulationStation Desktop Edition to simply ES-DE. As part of this the application data directory has changed from .emulationstation to ES-DE and its internal structure has been improved. There is also a new default theme named Linear that is bundled with the application. Support for configurable font sizes has also been added, so assuming the theme supports it, it's now possible to select between these sizes from the _UI settings_ menu. @@ -14,6 +26,7 @@ A number of minor improvements and bug fixes are also part of this release. ### Detailed list of changes +* Added support for the Android operating system * Renamed the application from EmulationStation Desktop Edition to ES-DE * Renamed the application data directory from .emulationstation to ES-DE * Updated the splash screen to reflect the new application name diff --git a/FAQ-ANDROID.md b/FAQ-ANDROID.md new file mode 100644 index 000000000..2a7793921 --- /dev/null +++ b/FAQ-ANDROID.md @@ -0,0 +1,26 @@ +# ES-DE (EmulationStation Desktop Edition) - Frequently Asked Questions for Android + +## Is this the same application as the releases for Linux, macOS and Windows? + +Yes it's the exact same application, with only some minor differences. This means that it behaves exactly as you're used to from those other platforms, and it means that you can transfer files between your Android device and any other devices where you have ES-DE installed. This for example includes your game ROMs, gamelists, scraped media and custom collections. + +## Is it available for free, and is it open source? + +The Android release specifically is not free, it's a paid app available for purchase on the [Amazon Appstore](https://www.amazon.com/dp/B0CVXRHWTT). And although approximately 99% of the app is open source there are some portions of the code that is closed source. + +## Why is ES-DE not available on the Google Play store? + +That is a question for Google. They are have done everything in their power to obstruct the release of ES-DE including constantly rejecting the releases without supplying meaningful explanations why, refusing to respond to tickets and emails and in general being incredibly difficult to deal with. There's a chance that there will be a Play Store release in the future but there's also a chance that it never happens. + +## Can I set ES-DE as my launcher? + +No ES-DE can't be set as your launcher. It's not a native Android application, it's written in C++ and essentially works as a game engine with a game loop that constantly runs. It's not written in a way that integrates well with the Android operating system, except for what is required to provide its basic functionality. ES-DE really has more in common with a game than with a regular Android launcher application that is native to the operating system. You can however install a native launcher and use it with ES-DE, this makes for a nice game console experience. To achieve this the following app is recommended:\ +https://play.google.com/store/apps/details?id=com.k2.consolelauncher + +## Can I launch Android applications and games from inside ES-DE? + +Not at the moment. Although there is an _android_ system in ES-DE it's not in use at the moment, but this functionality is planned for a future release. + +## What game systems/platforms and emulators are supported by ES-DE? + +See the _Supported game systems_ section at the bottom of the [Android documentation](ANDROID.md#supported-game-systems) where there's a table listing all supported systems/platforms and emulators. diff --git a/FAQ.md b/FAQ.md index 594b8ac05..07a9abb4e 100644 --- a/FAQ.md +++ b/FAQ.md @@ -6,7 +6,7 @@ As of the 3.0.0 release the official name for the project and application is ES- ## Is this software available for free, and is it open source? -ES-DE is available for free on Windows, macOS and Linux and it's released under the MIT open source license. +ES-DE is available for free on Windows, macOS and Linux and it's released under the MIT open source license. For Android it's a paid app available on the [Amazon Appstore](https://www.amazon.com/dp/B0CVXRHWTT) and this port is partially closed source. ## Which operating systems are supported?