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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2024-02-28 22:51:39 +01:00
parent db2d5bba09
commit 3b62f5750c
4 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
ANDROID-DEV.md
View file

@ -4,11 +4,8 @@ This document contains information specific to the Android release, for more gen
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. 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.
The official Amazon store listing for ES-DE:\ You can buy the Android APK from our Patreon page: \
https://www.amazon.com/dp/B0CVXRHWTT https://www.patreon.com/es_de
Use the Amazon Appstore app to install it on your device:\
https://www.amazon.com/gp/mas/get-appstore/android
Table of contents: Table of contents:
@ -115,12 +112,10 @@ Below are specific instructions and considerations for all supported emulators.
### RetroArch ### RetroArch
The RetroArch release in the Play store is problematic. It does not contain all emulator cores and a number of people have reported issues launching games from ES-DE (apparently it doesn't work at all on some specific devices). For these reasons it's strongly recommended to use the 64-bit release from the RetroArch website instead. The RetroArch release from the Google Play store is problematic. It does not contain all emulator cores and a number of people have reported issues launching games from ES-DE (apparently it doesn't work at all on some devices). For these reasons it's strongly recommended to use the 64-bit release from the RetroArch website instead, or to install it from the Amazon Appstore or the F-Droid store.
https://retroarch.com/
Or you could alternatively install their release on the F-Droid store.
https://retroarch.com \
https://www.amazon.com/dp/B09753XRVF \
https://f-droid.org/en/packages/com.retroarch https://f-droid.org/en/packages/com.retroarch
Be aware that you need to manually install every core you want to use from inside the RetroArch user interface, and you also need to install all necessary BIOS files. The Android release of RetroArch is pretty unforgiving and will usually just present a black screen on game launch if the core file or the BIOS file is missing, and it will hang there until Android realizes the app is not responding and displays a popup where you can choose to kill the process. Be aware that you need to manually install every core you want to use from inside the RetroArch user interface, and you also need to install all necessary BIOS files. The Android release of RetroArch is pretty unforgiving and will usually just present a black screen on game launch if the core file or the BIOS file is missing, and it will hang there until Android realizes the app is not responding and displays a popup where you can choose to kill the process.
@ -257,11 +252,18 @@ https://play.google.com/store/apps/details?id=me.magnum.melonds
### M64Plus FZ ### M64Plus FZ
This emulator can be installed from the Play store. The Pro version is recommended to avoid annoying ads. This emulator can be installed from the Amazon Appstore or the Google Play store. The Pro version is recommended to avoid annoying ads.
https://www.amazon.com/dp/B09L5FB7T4 \
https://play.google.com/store/apps/details?id=org.mupen64plusae.v3.fzurita.pro \ https://play.google.com/store/apps/details?id=org.mupen64plusae.v3.fzurita.pro \
https://play.google.com/store/apps/details?id=org.mupen64plusae.v3.fzurita https://play.google.com/store/apps/details?id=org.mupen64plusae.v3.fzurita
### Mupen64Plus AE
This emulator is very similar to M64Plus FZ and it can be downloaded from their GitHub automatic build system.
https://github.com/mupen64plus-ae/mupen64plus-ae/actions
### My Boy! and My OldBoy! ### My Boy! and My OldBoy!
These emulators can be installed from the Play store as paid apps. There are also free/Lite versions availble for these emulators but they have not been updated in years and don't run on modern devices. As such they are not supported by ES-DE. These emulators can be installed from the Play store as paid apps. There are also free/Lite versions availble for these emulators but they have not been updated in years and don't run on modern devices. As such they are not supported by ES-DE.
@ -463,8 +465,8 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| naomi2 | Sega NAOMI 2 | Flycast | Flycast **(Standalone)** | Yes | Single archive file + .chd file in subdirectory if GD-ROM game | | naomi2 | Sega NAOMI 2 | Flycast | Flycast **(Standalone)** | Yes | Single archive file + .chd file in subdirectory if GD-ROM game |
| naomigd | Sega NAOMI GD-ROM | Flycast | Flycast **(Standalone)** | Yes | Single archive file + .chd file in subdirectory if GD-ROM game | | naomigd | Sega NAOMI GD-ROM | Flycast | Flycast **(Standalone)** | Yes | Single archive file + .chd file in subdirectory if GD-ROM game |
| n3ds | Nintendo 3DS | Citra | Citra **(Standalone)** [Play store version or Nightly],<br>Citra Canary **(Standalone)**,<br>Citra MMJ **(Standalone)** | No | Single ROM file | | n3ds | Nintendo 3DS | Citra | Citra **(Standalone)** [Play store version or Nightly],<br>Citra Canary **(Standalone)**,<br>Citra MMJ **(Standalone)** | No | Single ROM file |
| n64 | Nintendo 64 | Mupen64Plus-Next | M64Plus FZ **(Standalone)**,<br>ParaLLEl N64 | No | Single archive or ROM file | | n64 | Nintendo 64 | Mupen64Plus-Next | M64Plus FZ **(Standalone)**,<br>Mupen64Plus AE **(Standalone)**,<br>ParaLLEl N64 | No | Single archive or ROM file |
| n64dd | Nintendo 64DD | Mupen64Plus-Next | M64Plus FZ **(Standalone)**,<br>ParaLLEl N64 | Yes | | | n64dd | Nintendo 64DD | Mupen64Plus-Next | M64Plus FZ **(Standalone)**,<br>Mupen64Plus AE **(Standalone)**,<br>ParaLLEl N64 | Yes | |
| nds | Nintendo DS | melonDS DS | melonDS **(Standalone)**,<br>melonDS Nightly **(Standalone)**,<br>DeSmuME,<br>DeSmuME 2015,<br>DraStic **(Standalone)** | No | Single archive or ROM file | | nds | Nintendo DS | melonDS DS | melonDS **(Standalone)**,<br>melonDS Nightly **(Standalone)**,<br>DeSmuME,<br>DeSmuME 2015,<br>DraStic **(Standalone)** | No | Single archive or ROM file |
| neogeo | SNK Neo Geo | FinalBurn Neo | NEO.emu **(Standalone)**,<br>MAME4droid 2024 **(Standalone)**,<br>MAME4droid **(Standalone)** | Yes | Single archive or ROM file | | neogeo | SNK Neo Geo | FinalBurn Neo | NEO.emu **(Standalone)**,<br>MAME4droid 2024 **(Standalone)**,<br>MAME4droid **(Standalone)** | Yes | Single archive or ROM file |
| neogeocd | SNK Neo Geo CD | NeoCD | FinalBurn Neo | Yes | | | neogeocd | SNK Neo Geo CD | NeoCD | FinalBurn Neo | Yes | |

7
ANDROID.md
View file

@ -4,11 +4,8 @@ This document contains information specific to the Android release, for more gen
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. 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.
The official Amazon store listing for ES-DE:\ You can buy the Android APK from our Patreon page: \
https://www.amazon.com/dp/B0CVXRHWTT https://www.patreon.com/es_de
Use the Amazon Appstore app to install it on your device:\
https://www.amazon.com/gp/mas/get-appstore/android
Table of contents: Table of contents:

8
FAQ-ANDROID.md
View file

@ -12,19 +12,19 @@ First it's branding, it would be very confusing to have different names for the
## Is it available for free, and is it open source? ## 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. The Android release specifically is not free, it's a paid app available for purchase through [Patreon](https://www.patreon.com/es_de). 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? ## 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. You could even argue whether the Play store is going to be relevant for emulation apps in the future. With the crippling restrictions and requirements that Google has put in place this store is starting look quite unfeasible. It doesn't matter how big a store is or how many users it has, if it doesn't fulfill the basic role of making it possible to publish your apps and getting paid for your work, then none of that really matters. 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. So there are no further plans at attempting to publish ES-DE there.
## How do I update ES-DE when there is a new release ## How do I update ES-DE when there is a new release
You update ES-DE via the [Amazon Appstore app](https://www.amazon.com/gp/mas/get-appstore/android). This works as expected, whenever a new release becomes available you can download and install it via this app. When a new release is available you will be sent a download link to the email address you used to sign up for Patreon. You can use that link to download the latest version, sideload it on your device and then update. We will explore other options to make this easier in the future.
## Can I use ES-DE on more than a single Android device or do I need to buy it multiple times? ## Can I use ES-DE on more than a single Android device or do I need to buy it multiple times?
You only need to buy it once, and then you can use it on all your devices, as long as you have the Amazon Appstore app installed on all these devices. There are no subscriptions or additional costs, you just buy it once. You only need to buy it once, and then you can use it on all your devices. There are no subscriptions or additional costs, you just buy it once. With that said we do appreciate if you want to support the project by keeping your paid Patreon subscription.
## Can I set ES-DE as my home app/launcher? ## Can I set ES-DE as my home app/launcher?

1
ROADMAP.md
View file

@ -5,6 +5,7 @@ ES-DE is developed using an agile methodology so which features to include per r
A more detailed breakdown can be found on the [Kanban](https://gitlab.com/es-de/emulationstation-de/-/boards) board, and for previous releases the [Changelog](CHANGELOG.md) contains all relevant details. A more detailed breakdown can be found on the [Kanban](https://gitlab.com/es-de/emulationstation-de/-/boards) board, and for previous releases the [Changelog](CHANGELOG.md) contains all relevant details.
**General functionality** **General functionality**
* (Android) Support for running native Android apps
* RetroAchievements.org integration * RetroAchievements.org integration
* "Time played" counter per game, similar to how it works in Steam * "Time played" counter per game, similar to how it works in Steam
* Bulk metadata editor * Bulk metadata editor