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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2024-03-17 22:21:45 +01:00
parent a1bebda5ab
commit feda142488
4 changed files with 28 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
ANDROID-DEV.md
View file

@ -60,7 +60,7 @@ The following emulators are configured for FileProvider access:
* GBA.emu * GBA.emu
* GBC.emu * GBC.emu
* Lynx.emu * Lynx.emu
* MD.emu * MD.emu (genesis, mastersystem, megadrive, megadrivejp)
* MAME4droid 2024 * MAME4droid 2024
* MAME4droid * MAME4droid
* NES.emu * NES.emu
@ -433,6 +433,13 @@ This PlayStation Vita emulator can be downloaded from their GitHub site. Refer t
https://github.com/Vita3K/Vita3K-Android/releases https://github.com/Vita3K/Vita3K-Android/releases
### Yaba Sanshiro 2
This emulator can be installed from the Play store, there is a paid Pro version as well. At the time of writing only the Pro version works when launching games from ES-DE.
https://play.google.com/store/apps/details?id=org.devmiyax.yabasanshioro2 \
https://play.google.com/store/apps/details?id=org.devmiyax.yabasanshioro2.pro
## Device compatibility ## Device compatibility
This is clearly not a complete list of Android devices, but rather those we know have been tested with ES-DE and for which there is a known status. This is clearly not a complete list of Android devices, but rather those we know have been tested with ES-DE and for which there is a known status.
@ -447,6 +454,7 @@ This is clearly not a complete list of Android devices, but rather those we know
| Google | Pixel Tablet | 14 | Yes | None | | | Google | Pixel Tablet | 14 | Yes | None | |
| Honor | 20 lite | 10 | Yes | None | | | Honor | 20 lite | 10 | Yes | None | |
| Honor | Magic5 Pro | 13 | Yes | None | | | Honor | Magic5 Pro | 13 | Yes | None | |
| Huawei | Mate 10 Pro | 10 | Yes | None | |
| Meta | Quest 3 | 12 ? | Yes | None | | | Meta | Quest 3 | 12 ? | Yes | None | |
| Nokia | 5.4 | 12 | Yes | None | | | Nokia | 5.4 | 12 | Yes | None | |
| Nokia | 7 Plus | 10 | Yes | None | | | Nokia | 7 Plus | 10 | Yes | None | |
@ -463,6 +471,7 @@ This is clearly not a complete list of Android devices, but rather those we know
| Samsung | Galaxy S22 Ultra | 14 | Yes | None | | | Samsung | Galaxy S22 Ultra | 14 | Yes | None | |
| Samsung | Galaxy S23 Ultra | 14 | Yes | None | | | Samsung | Galaxy S23 Ultra | 14 | Yes | None | |
| Samsung | Galaxy S24 Ultra | 14 | Yes | None | | | Samsung | Galaxy S24 Ultra | 14 | Yes | None | |
| Samsung | Galaxy Tab A7 | 12 | Yes | None | |
| Ulefone | Note 6P | 11 | Yes | None | | | Ulefone | Note 6P | 11 | Yes | None | |
| Wiko | Voix | 12 | No | Fails at configurator/onboarding | Probably a bug in the firmware/OS image as a libc system call fails | | Wiko | Voix | 12 | No | Fails at configurator/onboarding | Probably a bug in the firmware/OS image as a libc system call fails |
| Xiaomi | Pad 5 | 13 | Yes | None | | | Xiaomi | Pad 5 | 13 | Yes | None | |
@ -611,8 +620,8 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| quake | Quake | TyrQuake | vitaQuake 2,<br>vitaQuake 2 [Rogue],<br>vitaQuake 2 [Xatrix],<br>vitaQuake 2 [Zaero] | No | | | quake | Quake | TyrQuake | vitaQuake 2,<br>vitaQuake 2 [Rogue],<br>vitaQuake 2 [Xatrix],<br>vitaQuake 2 [Zaero] | No | |
| samcoupe | MGT SAM Coupé | Speccy **(Standalone)** | | No | Single archive or ROM file | | samcoupe | MGT SAM Coupé | Speccy **(Standalone)** | | No | Single archive or ROM file |
| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,<br>Snes9x 2005 Plus,<br>Snes9x EX+ **(Standalone)**,<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>Mesen-S | | | | satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,<br>Snes9x 2005 Plus,<br>Snes9x EX+ **(Standalone)**,<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>Mesen-S | | |
| saturn | Sega Saturn | Beetle Saturn | YabaSanshiro,<br>Yabause,<br>Saturn.emu **(Standalone)** | Yes | .chd file for single-disc games, .m3u playlist for multi-disc games | | saturn | Sega Saturn | Beetle Saturn | YabaSanshiro,<br>Yaba Sanshiro 2 **(Standalone)**,<br>Yabause,<br>Saturn.emu **(Standalone)** | Yes | .chd file for single-disc games, .m3u playlist for multi-disc games |
| saturnjp | Sega Saturn [Japan] | Beetle Saturn | YabaSanshiro,<br>Yabause,<br>Saturn.emu **(Standalone)** | Yes | .chd file for single-disc games, .m3u playlist for multi-disc games | | saturnjp | Sega Saturn [Japan] | Beetle Saturn | YabaSanshiro,<br>Yaba Sanshiro 2 **(Standalone)**,<br>Yabause,<br>Saturn.emu **(Standalone)** | Yes | .chd file for single-disc games, .m3u playlist for multi-disc games |
| scummvm | ScummVM Game Engine | ScummVM | | No | | | scummvm | ScummVM Game Engine | ScummVM | | No | |
| scv | Epoch Super Cassette Vision | _Placeholder_ | | | | | scv | Epoch Super Cassette Vision | _Placeholder_ | | | |
| sega32x | Sega Mega Drive 32X | PicoDrive | | No | Single archive or ROM file | | sega32x | Sega Mega Drive 32X | PicoDrive | | No | Single archive or ROM file |

2
ANDROID.md
View file

@ -447,6 +447,7 @@ This is clearly not a complete list of Android devices, but rather those we know
| Google | Pixel Tablet | 14 | Yes | None | | | Google | Pixel Tablet | 14 | Yes | None | |
| Honor | 20 lite | 10 | Yes | None | | | Honor | 20 lite | 10 | Yes | None | |
| Honor | Magic5 Pro | 13 | Yes | None | | | Honor | Magic5 Pro | 13 | Yes | None | |
| Huawei | Mate 10 Pro | 10 | Yes | None | |
| Meta | Quest 3 | 12 ? | Yes | None | | | Meta | Quest 3 | 12 ? | Yes | None | |
| Nokia | 5.4 | 12 | Yes | None | | | Nokia | 5.4 | 12 | Yes | None | |
| Nokia | 7 Plus | 10 | Yes | None | | | Nokia | 7 Plus | 10 | Yes | None | |
@ -463,6 +464,7 @@ This is clearly not a complete list of Android devices, but rather those we know
| Samsung | Galaxy S22 Ultra | 14 | Yes | None | | | Samsung | Galaxy S22 Ultra | 14 | Yes | None | |
| Samsung | Galaxy S23 Ultra | 14 | Yes | None | | | Samsung | Galaxy S23 Ultra | 14 | Yes | None | |
| Samsung | Galaxy S24 Ultra | 14 | Yes | None | | | Samsung | Galaxy S24 Ultra | 14 | Yes | None | |
| Samsung | Galaxy Tab A7 | 12 | Yes | None | |
| Ulefone | Note 6P | 11 | Yes | None | | | Ulefone | Note 6P | 11 | Yes | None | |
| Wiko | Voix | 12 | No | Fails at configurator/onboarding | Probably a bug in the firmware/OS image as a libc system call fails | | Wiko | Voix | 12 | No | Fails at configurator/onboarding | Probably a bug in the firmware/OS image as a libc system call fails |
| Xiaomi | Pad 5 | 13 | Yes | None | | | Xiaomi | Pad 5 | 13 | Yes | None | |

11
CHANGELOG.md
View file

@ -1,5 +1,16 @@
# ES-DE (EmulationStation Desktop Edition) - Changelog # ES-DE (EmulationStation Desktop Edition) - Changelog
## Version 3.0.1-xx (Android intermediate) (in development)
**Release date:** TBD
### Detailed list of changes
* (Android) Added Yaba Sanshiro 2 standalone as an alternative emulator for the saturn and saturnjp systems
* (Android) Changed from %ROMPROVIDER% to %ROMSAF% for MD.emu (only for megacd, megacdjp and segacd)
### Bug fixes
## Version 3.0.1 / 3.0.1-19 ## Version 3.0.1 / 3.0.1-19
**Release date:** 2024-03-16 **Release date:** 2024-03-16

6
FAQ-ANDROID.md
View file

@ -28,11 +28,11 @@ You only need to buy it once, and then you can use it on all your devices. There
## ES-DE doesn't work on my device, can I get a refund? ## ES-DE doesn't work on my device, can I get a refund?
Although the overwhelming majority of people have successfully got ES-DE to run correctly on their devices (assuming they are fulfilling the basic requirements of 64-bit Android 11 or later) there are some devices that have been problematic. These issues have only been observed on mobile phones as far as we know, and is likely due to customizations done by the manufacturers. Unfortunately Android is not really a standardized operating system and different vendors are applying custom patches and such which may prevent ES-DE from working. We will refund everyone that is unable to get ES-DE to run on their device, just send a DM on Patreon and we will issue a refund as soon as possible. Although the overwhelming majority of people have successfully got ES-DE to run correctly on their devices (assuming they are fulfilling the basic requirements of 64-bit Android 10 or later) there are some devices that have been problematic. These issues have only been observed on mobile phones as far as we know, and is likely due to customizations done by the manufacturers. Unfortunately Android is not really a standardized operating system and different vendors are applying custom patches and such which may prevent ES-DE from working. We will refund everyone that is unable to get ES-DE to run on their device, just send a DM on Patreon and we will issue a refund as soon as possible.
## Why do I get a "There was a problem parsing the package" error when I attempt to install ES-DE? ## Why do I get a "There was a problem parsing the package" error when I attempt to install ES-DE?
There are two possible reasons for this, the first and most common issue is that your device does not fulfill the basic requirements for ES-DE, which is that it has to run a 64-bit version of Android 11 or later. We are investigating whether Android 10 support could be added in a future release but for the time being this is not supported. There are two possible reasons for this, the first and most common issue is that your device does not fulfill the basic requirements for ES-DE, which is that it has to run a 64-bit version of Android 10 or later.
The second reason is that the APK is corrupt or not complete. When we make releases we include an MD5 hash value with the download link, and it's recommended to check the hash of the downloaded file before you attempt to install it. This will also ensure that you actually have the real release and not some third party scam or fake app or similar. A recommended app for generating the MD5 checksums is [Hash Checker](https://play.google.com/store/apps/details?id=com.smlnskgmail.jaman.hashchecker) from the Google Play store. The second reason is that the APK is corrupt or not complete. When we make releases we include an MD5 hash value with the download link, and it's recommended to check the hash of the downloaded file before you attempt to install it. This will also ensure that you actually have the real release and not some third party scam or fake app or similar. A recommended app for generating the MD5 checksums is [Hash Checker](https://play.google.com/store/apps/details?id=com.smlnskgmail.jaman.hashchecker) from the Google Play store.
@ -88,7 +88,7 @@ https://www.youtube.com/watch?v=k5WWacfIn6Y
## What type of Android devices are supported ## What type of Android devices are supported
ES-DE runs on a wide range on devices, for example handheld consoles like the Ayn Odin 2 and the Retroid Pocket 2s, 3 and 4, on mobile phones, on tablets and on Android TV devices like the Nvidia Shield Pro. It supports a wide range of screen resolutions and aspect ratios. A 64-bit version of Android 11 or later is required although we will investigate whether Android 10 support can be added in a future release. ES-DE runs on a wide range on devices, for example handheld consoles like the Ayn Odin and the Retroid Pocket models, on mobile phones, on tablets and on Android TV devices like the Nvidia Shield Pro. It supports a wide range of screen resolutions and aspect ratios. A 64-bit version of Android 10 or later is required.
## Will touch gesture support get added? ## Will touch gesture support get added?