From 5eae9d2f7ecf8f410facf116263f71f807b0cf37 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Sun, 10 Mar 2024 11:29:52 +0100 Subject: [PATCH] Documentation update --- ANDROID-DEV.md | 50 ++++++++++++++++++++++++++++-------------------- ANDROID.md | 19 +++++++++--------- CHANGELOG.md | 25 ++++++++++++------------ FAQ-ANDROID.md | 2 ++ INSTALL-DEV.md | 5 ++++- INSTALL.md | 5 ++++- USERGUIDE-DEV.md | 21 ++++++++++---------- 7 files changed, 72 insertions(+), 55 deletions(-) diff --git a/ANDROID-DEV.md b/ANDROID-DEV.md index f2a4a6aa7..447ba2048 100644 --- a/ANDROID-DEV.md +++ b/ANDROID-DEV.md @@ -187,6 +187,7 @@ In addition to the issues specific to the Ayn Odin 2 there are a couple of other * Poor performance/low frame rate after startup on some devices, which seems to happen randomly and is usually resolved by itself within 10 to 30 seconds. * The Android soft keyboard causes rendering issues when navigating using a controller or physical keyboard, as such the ES-DE built-in keyboard is enabled by default for the time being. For testing purposes the Android soft keyboard can be enabled via the _Enable virtual keyboard_ option in the _UI settings_ menu. If only using touch input the issue is not present. This problem is believed to be caused by a bug in the SDL library so it probably needs to be resolved there. +* Using a mounted USB storage device for the ES-DE and/or ROMs directories will lead to the configurator exiting after finishing the setup instead of launching ES-DE. Restarting ES-DE manually will lead to a successful startup. If the option to create the system directories was selected in the configurator then this will have to be executed again from inside ES-DE. Note that using a mounted USB storage device leads to a very crippled setup anyway, as for example RetroArch can't read any games from such devices (i.e. from the /mnt/media_rw/ directory tree). Only emulators supporting scoped storage will be usable in such a setup. ## Emulator installation and setup @@ -212,9 +213,8 @@ https://github.com/Trixarian/NetherSX2-patch ### Citra -The version of Citra on the Google Play store is very old and barely works. Instead download either the Canary or Nightly builds from the Citra website or use the Citra MMJ fork: +The Citra emulator is no longer in active development and it's unclear where it can be obtained and whether it will be worked on in the future. The Citra MMJ fork is still available for download from their GitHub site. -https://citra-emu.org/download \ https://github.com/weihuoya/citra/releases ### ColEm @@ -283,7 +283,9 @@ https://www.explusalpha.com/ ### Fake-08 -This RetroArch core is a good port of the official PICO-8 game engine which does not exist on Android. It's not shipped with RetroArch by default though so you need to manually install it. After download you'll need to place the core inside's RetroArch's downloads directory and then install it from the RetroArch app. You must use the 64-bit version with the filename `libfake08-arm64.so`. Details on how to manually install cores in RetroArch can be found on the Internet. Fake-08 can be downloaded from their GitHub site. +This RetroArch core is a good port of the official PICO-8 game engine which does not exist on Android. It's not shipped with RetroArch by default though so you need to manually install it. After downloading it you'll need to place the core inside's RetroArch's downloads directory and then install it from the RetroArch app. + +You must use the 64-bit version with the filename `libfake08-arm64.so` and it has to be renamed to `fake08_libretro_android.so` before you install it into RetroArch. Details on how to manually install cores in RetroArch can be found on the Internet. Fake-08 can be downloaded from their GitHub site. https://github.com/jtothebell/fake-08/releases @@ -368,16 +370,17 @@ You can download OpenBOR from their GitHub site, the version named _OpenBOR v3.0 https://github.com/DCurrent/openbor/releases +### Panda3DS (pandroid) + +This emulator is in early development and there currently seems to be no way to run a game directly from ES-DE. Instead the emulator GUI will be displayed on game launch and you will need to manually select the game from there. Note that the Android build of this emulator is named _pandroid_, but as the overall project name is Panda3DS it will be referred to as such in ES-DE. This emulator can be downloaded from their GitHub site. + +https://github.com/wheremyfoodat/Panda3DS/releases + ### Pizza Boy GBA and Pizza Boy GBC -The Pizza Boy GBA and Pizza Boy GBC emulators can be installed from the Play store. There are Basic (free) versions and Pro (paid) versions available. +The Pizza Boy GBA and Pizza Boy GBC emulators used to be available on the Play store but have since been taken down. There used to be Basic (free) versions and Pro (paid) versions. It's unclear what the status is for these emulators and if they are still in active development. It's also unclear where they can be downloaded. -As of writing this, the Basic version of the GBA emulator does not seem to be able to launch games from ES-DE, but the Pro version is working fine. Both the Basic and Pro versions of the GBC emulator are working correctly. - -https://play.google.com/store/apps/details?id=it.dbtecno.pizzaboygba \ -https://play.google.com/store/apps/details?id=it.dbtecno.pizzaboygbapro \ -https://play.google.com/store/apps/details?id=it.dbtecno.pizzaboy \ -https://play.google.com/store/apps/details?id=it.dbtecno.pizzaboypro +As of writing this, the latest available Basic version of the GBA emulator does not seem to be able to launch games from ES-DE, but the Pro version is working fine. Both the Basic and Pro versions of the GBC emulator are working correctly. ### Play! @@ -392,6 +395,8 @@ The Play store version of this emulator is getting frequent updates and is there https://play.google.com/store/apps/details?id=org.ppsspp.ppsspp \ https://play.google.com/store/apps/details?id=org.ppsspp.ppssppgold +Make sure that you press the _Browse_ button in PPSSPP when you're adding scoped storage access to your games directory or you will not be able to launch any games from ES-DE. + ### Ruffle This emulator can be downloaded from their GitHub site. @@ -444,9 +449,10 @@ This is clearly not a complete list of Android devices, but rather those we know | Ayn | Odin 2 | 13 | Yes | Can't launch some emulators,
Can't have dots in directory names,
Minor audio issues | Bugs in the firmware/OS image | | Google | Pixel 4a | 13 | Yes | None | | | Google | Pixel Tablet | 14 | Yes | None | | +| HONOR | Magic5 Pro | 13 | Yes | None | | | Nokia | 5.4 | 12 | Yes | None | | | Meta | Quest 3 | 12 ? | Yes | None | | -| Nvidia | Shield Pro | 11 (TV) | Yes | None | | +| Nvidia | Shield Pro | 11 (TV) | Yes | None | Limited RAM capacity on this device makes it unsuitable for demanding themes and large game collections | | OnePlus | 6T | 11 | Yes | None | | | REDMAGIC | 8 Pro | 13 | Yes | None | | | Retroid | Pocket 2s | 11 | Yes | None | | @@ -456,6 +462,8 @@ This is clearly not a complete list of Android devices, but rather those we know | Samsung | Galaxy S10 | 12 | Yes | None | | | Samsung | Galaxy S24 Ultra | 14 | Yes | None | | | 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 | Redmi Note 11 | 11 | Yes | None | | ## Supported game systems @@ -564,7 +572,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | naomi | Sega NAOMI | 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 | -| n3ds | Nintendo 3DS | Citra | Citra **(Standalone)** [Play store version or Nightly],
Citra Canary **(Standalone)**,
Citra MMJ **(Standalone)** | No | Single ROM file | +| n3ds | Nintendo 3DS | Citra | Citra **(Standalone)**,
Citra Canary **(Standalone)**,
Citra MMJ **(Standalone)**,
Panda3DS **(Standalone)** | No | Single ROM file | | n64 | Nintendo 64 | Mupen64Plus-Next | M64Plus FZ **(Standalone)**,
Mupen64Plus AE **(Standalone)**,
ParaLLEl N64 | No | Single archive or ROM file | | n64dd | Nintendo 64DD | Mupen64Plus-Next | M64Plus FZ **(Standalone)**,
Mupen64Plus AE **(Standalone)**,
ParaLLEl N64 | Yes | | | nds | Nintendo DS | melonDS DS | melonDS **(Standalone)**,
melonDS Nightly **(Standalone)**,
DeSmuME,
DeSmuME 2015,
DraStic **(Standalone)** | No | Single archive or ROM file | @@ -583,8 +591,8 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | pc88 | NEC PC-8800 Series | QUASI88 | | Yes | | | pc98 | NEC PC-9800 Series | Neko Project II Kai | Neko Project II | | | | pcarcade | PC Arcade Systems | _Placeholder_ | | | | | -| pcengine | NEC PC Engine | Beetle PCE | Beetle PCE FAST,
PCE.emu **(Standalone)** | No | Single archive or ROM file | -| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST,
PCE.emu **(Standalone)** | Yes | | +| pcengine | NEC PC Engine | Beetle PCE | Beetle PCE FAST,
Beetle SuperGrafx,
PCE.emu **(Standalone)** | No | Single archive or ROM file | +| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST,
Beetle SuperGrafx,
PCE.emu **(Standalone)** | Yes | | | pcfx | NEC PC-FX | Beetle PC-FX | | Yes | | | pico8 | PICO-8 Fantasy Console | Fake-08 | Retro8 | No | See the specific _PICO-8_ section in the User guide | | plus4 | Commodore Plus/4 | VICE xplus4 | | No | Single archive or image file for tape, cartridge or single-diskette games, .m3u playlist for multi-diskette games | @@ -599,7 +607,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | pv1000 | Casio PV-1000 | _Placeholder_ | | | | | quake | Quake | TyrQuake | vitaQuake 2,
vitaQuake 2 [Rogue],
vitaQuake 2 [Xatrix],
vitaQuake 2 [Zaero] | No | | | samcoupe | MGT SAM Coupé | Speccy **(Standalone)** | | No | Single archive or ROM file | -| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,
Snes9x EX+ **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
Mesen-S | | | +| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,
Snes9x 2005 Plus,
Snes9x EX+ **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
Mesen-S | | | | saturn | Sega Saturn | Beetle Saturn | YabaSanshiro,
Yabause,
Saturn.emu **(Standalone)** | Yes | .chd file for single-disc games, .m3u playlist for multi-disc games | | saturnjp | Sega Saturn [Japan] | Beetle Saturn | YabaSanshiro,
Yabause,
Saturn.emu **(Standalone)** | Yes | .chd file for single-disc games, .m3u playlist for multi-disc games | | scummvm | ScummVM Game Engine | ScummVM | | No | | @@ -608,24 +616,24 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | sega32xjp | Sega Super 32X [Japan] | PicoDrive | | No | Single archive or ROM file | | sega32xna | Sega Genesis 32X [North America] | PicoDrive | | No | Single archive or ROM file | | segacd | Sega CD | Genesis Plus GX | Genesis Plus GX Wide,
PicoDrive,
MD.emu **(Standalone)** | Yes | | -| sfc | Nintendo SFC (Super Famicom) | Snes9x - Current | Snes9x 2010,
Snes9x EX+ **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
Beetle Supafaust,
Mesen-S | No | Single archive or ROM file | +| sfc | Nintendo SFC (Super Famicom) | Snes9x - Current | Snes9x 2010,
Snes9x 2005 Plus,
Snes9x EX+ **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
Beetle Supafaust,
Mesen-S | No | Single archive or ROM file | | sg-1000 | Sega SG-1000 | Genesis Plus GX | Genesis Plus GX Wide,
Gearsystem,
blueMSX,
MasterGear **(Standalone)** | No | Single archive or ROM file | | sgb | Nintendo Super Game Boy | Mesen-S | SameBoy,
mGBA | | Single archive or ROM file | -| snes | Nintendo SNES (Super Nintendo) | Snes9x - Current | Snes9x 2010,
Snes9x EX+ **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
Beetle Supafaust,
Mesen-S | No | Single archive or ROM file | -| snesna | Nintendo SNES (Super Nintendo) [North America] | Snes9x - Current | Snes9x 2010,
Snes9x EX+ **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
Beetle Supafaust,
Mesen-S | No | Single archive or ROM file | +| snes | Nintendo SNES (Super Nintendo) | Snes9x - Current | Snes9x 2010,
Snes9x 2005 Plus,
Snes9x EX+ **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
Beetle Supafaust,
Mesen-S | No | Single archive or ROM file | +| snesna | Nintendo SNES (Super Nintendo) [North America] | Snes9x - Current | Snes9x 2010,
Snes9x 2005 Plus,
Snes9x EX+ **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
Beetle Supafaust,
Mesen-S | No | Single archive or ROM file | | solarus | Solarus Game Engine | _Placeholder_ | | | | | spectravideo | Spectravideo | blueMSX | | | | | steam | Valve Steam | _Placeholder_ | | | | | stv | Sega Titan Video Game System | MAME - Current | MAME4droid 2024 **(Standalone)**,
MAME4droid **(Standalone)** | Yes | Single archive file | -| sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,
Snes9x EX+ **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy | | | +| sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,
Snes9x 2005 Plus,
Snes9x EX+ **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy | | | | supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,
PCE.emu **(Standalone)** | No | Single archive or ROM file | | supervision | Watara Supervision | Potator | | No | Single archive or ROM file | | supracan | Funtech Super A'Can | _Placeholder_ | | | | | switch | Nintendo Switch | Skyline **(Standalone)** | | Yes | | | symbian | Symbian | EKA2L1 **(Standalone)** | | Yes | See the specific _Symbian and Nokia N-Gage_ section in the User guide | | tanodragon | Tano Dragon | _Placeholder_ | | | | -| tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST,
PCE.emu **(Standalone)** | No | Single archive or ROM file | -| tg-cd | NEC TurboGrafx-CD | Beetle PCE | Beetle PCE FAST,
PCE.emu **(Standalone)** | Yes | | +| tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST,
Beetle SuperGrafx,
PCE.emu **(Standalone)** | No | Single archive or ROM file | +| tg-cd | NEC TurboGrafx-CD | Beetle PCE | Beetle PCE FAST,
Beetle SuperGrafx,
PCE.emu **(Standalone)** | Yes | | | ti99 | Texas Instruments TI-99 | _Placeholder_ | | | | | tic80 | TIC-80 Fantasy Computer | TIC-80 | | No | Single .tic file | | to8 | Thomson TO8 | Theodore | | | | diff --git a/ANDROID.md b/ANDROID.md index 039799bd5..dbb513170 100644 --- a/ANDROID.md +++ b/ANDROID.md @@ -212,9 +212,8 @@ https://github.com/Trixarian/NetherSX2-patch ### Citra -The version of Citra on the Google Play store is very old and barely works. Instead download either the Canary or Nightly builds from the Citra website or use the Citra MMJ fork: +The Citra emulator is no longer in active development and it's unclear where it can be obtained and whether it will be worked on in the future. The Citra MMJ fork is still available for download from their GitHub site. -https://citra-emu.org/download \ https://github.com/weihuoya/citra/releases ### ColEm @@ -370,14 +369,9 @@ https://github.com/DCurrent/openbor/releases ### Pizza Boy GBA and Pizza Boy GBC -The Pizza Boy GBA and Pizza Boy GBC emulators can be installed from the Play store. There are Basic (free) versions and Pro (paid) versions available. +The Pizza Boy GBA and Pizza Boy GBC emulators used to be available on the Play store but have since been taken down. There used to be Basic (free) versions and Pro (paid) versions. It's unclear what the status is for these emulators and if they are still in active development. It's also unclear where they can be downloaded. -As of writing this, the Basic version of the GBA emulator does not seem to be able to launch games from ES-DE, but the Pro version is working fine. Both the Basic and Pro versions of the GBC emulator are working correctly. - -https://play.google.com/store/apps/details?id=it.dbtecno.pizzaboygba \ -https://play.google.com/store/apps/details?id=it.dbtecno.pizzaboygbapro \ -https://play.google.com/store/apps/details?id=it.dbtecno.pizzaboy \ -https://play.google.com/store/apps/details?id=it.dbtecno.pizzaboypro +As of writing this, the latest available Basic version of the GBA emulator does not seem to be able to launch games from ES-DE, but the Pro version is working fine. Both the Basic and Pro versions of the GBC emulator are working correctly. ### Play! @@ -392,6 +386,8 @@ The Play store version of this emulator is getting frequent updates and is there https://play.google.com/store/apps/details?id=org.ppsspp.ppsspp \ https://play.google.com/store/apps/details?id=org.ppsspp.ppssppgold +Make sure that you press the _Browse_ button in PPSSPP when you're adding scoped storage access to your games directory or you will not be able to launch any games from ES-DE. + ### Ruffle This emulator can be downloaded from their GitHub site. @@ -444,9 +440,10 @@ This is clearly not a complete list of Android devices, but rather those we know | Ayn | Odin 2 | 13 | Yes | Can't launch some emulators,
Can't have dots in directory names,
Minor audio issues | Bugs in the firmware/OS image | | Google | Pixel 4a | 13 | Yes | None | | | Google | Pixel Tablet | 14 | Yes | None | | +| HONOR | Magic5 Pro | 13 | Yes | None | | | Nokia | 5.4 | 12 | Yes | None | | | Meta | Quest 3 | 12 ? | Yes | None | | -| Nvidia | Shield Pro | 11 (TV) | Yes | None | | +| Nvidia | Shield Pro | 11 (TV) | Yes | None | Limited RAM capacity on this device makes it unsuitable for demanding themes and large game collections | | OnePlus | 6T | 11 | Yes | None | | | REDMAGIC | 8 Pro | 13 | Yes | None | | | Retroid | Pocket 2s | 11 | Yes | None | | @@ -456,6 +453,8 @@ This is clearly not a complete list of Android devices, but rather those we know | Samsung | Galaxy S10 | 12 | Yes | None | | | Samsung | Galaxy S24 Ultra | 14 | Yes | None | | | 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 | Redmi Note 11 | 11 | Yes | None | | ## Supported game systems diff --git a/CHANGELOG.md b/CHANGELOG.md index c6077664f..be525b404 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ # ES-DE (EmulationStation Desktop Edition) - Changelog -## Version 3.0.1 (in development) +## Version 3.0.1 / 3.0.1-xx (in development) **Release date:** TBD @@ -9,25 +9,26 @@ ### Detailed list of changes * Removed Yuzu from the switch system +* Added Panda3DS standalone as an alternative emulator for the n3ds system +* (Android) Added support for placing the ES-DE and ROMs directories on mounted USB storage (/mnt/media_rw/) * Added a more informative error message than "HTTP error code 430" when exceeding the daily ScreenScraper quota +* Added the Snes9x 2005 Plus RetroArch core as an alternative emulator for the satellaview, sfc, snes, snesna and sufami systems +* Added the Beetle SuperGrafx RetroArch core as an alternative emulator for the pcengine, pcenginecd, tg16 and tg-cd systems * Added the Geolith RetroArch core as an alternative emulator for the arcade, mame and neogeo systems * Added the .neo file extension to the arcade, mame and neogeo systems +* Added the .chd file extension to the sega32x, sega32xjp and sega32xna systems +* (Android) Changed the required filename for the Fake-08 RetroArch core from libfake08-arm64.so to fake08_libretro_android.so +* (Android) Increased the maximum waiting time for the storage mount retry loop from 3 to 4 seconds +* Improved resilience to empty gamelist.xml files (they can now be updated instead of generating an error) +* (Android) Removed symlink support * Removed the "v" before the version number from the version printout on application startup and from the main menu ### Bug fixes +* (Android) The supergrafx system had the Beetle SuperGrafx and Beetle PCE RetroArch cores mixed up +* (Windows) The MAME standalone emulator entry for the atari7800 system had the wrong machine type defined * (linear-es-de) Creating custom collections named "now-playing" or "completed" could lead to them being unthemed -## Version 3.0.0-xx (Android intermediate) - -**Release date:** TBD - -### Detailed list of changes - -* Removed Yuzu from the switch system - -### Bug fixes - ## Version 3.0.0-17 (Android intermediate) **Release date:** 2024-03-04 @@ -70,7 +71,7 @@ * Having spaces in the ROMs directory name broke game launching for emulators that used SAF URIs * Some special characters caused game launching to fail or behave strange for some emulators that used SAF URIs -## Version 3.0.0 +## Version 3.0.0 / 3.0.0-11 **Release date:** 2024-02-17 diff --git a/FAQ-ANDROID.md b/FAQ-ANDROID.md index 189d25a81..28c8097e9 100644 --- a/FAQ-ANDROID.md +++ b/FAQ-ANDROID.md @@ -67,6 +67,8 @@ Another reason for why it may not work is that the ROMs directories are in the w There seems to be a third situation as well where some emulators apparently keep some residual configuration even after changing the ROM path, which makes game launching fail. In some cases it's been successful to clear the emulator settings completely and then add access to the ROM directory again. The easiest way to do this is to go into the Android Settings app, choose _Apps_, select the emulator you want to clear the settings for, open _Storage & cache_ and select _Clear storage_. Just make sure that the emulator has not placed savestates and similar data on internal storage, as this might otherwise get lost. Following this open the emulator and give access to the correct ROM/game system directory. +Also be aware that there are some slight variations when it comes to how emulators behave when they can't access the game files. In most cases an explicit error message is displayed that it can't open the file, but some emulators like M64Plus FZ will just display the emulator GUI instead. + ## Why do some standalone emulators fail to launch with "ERROR CODE -1" or just display a black screen? ERROR CODE -1 is a general failure mode which could be caused by multiple things. Some emulators react like this when there's a permission issue and they can't access the game file. See the previous question above for how to deal with such permission problems. And some emulators return this error when the file you attempt to launch has an unsupported file extension. For example MD.emu does not support .bin files, but if you rename these to the .gen extension then game launching works as expected. diff --git a/INSTALL-DEV.md b/INSTALL-DEV.md index acc7b453b..23f1f2b54 100644 --- a/INSTALL-DEV.md +++ b/INSTALL-DEV.md @@ -1691,7 +1691,10 @@ ES-DE works a bit differently on Android which is also reflected in the es_find_ To better understand the configuration in this section it could be a good idea to refer the official Android documentation:\ https://developer.android.com/reference/android/content/Intent -There is a command line tool in Android named _am_ which implements the _Intent_ API and can be used to test emulator launching, but this is not intended to be used by other applications and therefore ES-DE implements direct (albeit partial) support for the Intent API. Testing the modern FileProvider interface using the _am_ utility may also be difficult, or maybe impossible. +There is a command line tool in Android named _am_ which implements the _Intent_ API and can be used to test emulator launching, but this is not intended to be used by other applications and therefore ES-DE implements direct (albeit partial) support for the Intent API. Testing the modern FileProvider interface using the _am_ utility is unfortunately not really possible as access permission is provided by the calling process, i.e. ES-DE. + +The es_find_rules.xml and es_systems.xml files are kept in an Android-internal directory and can't be accessed directly, but you can find them at the following location:\ +https://gitlab.com/es-de/emulationstation-de/-/tree/master/resources/systems/android **es_find_rules.xml** diff --git a/INSTALL.md b/INSTALL.md index 640f74315..9aa934c4a 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1689,7 +1689,10 @@ ES-DE works a bit differently on Android which is also reflected in the es_find_ To better understand the configuration in this section it could be a good idea to refer the official Android documentation:\ https://developer.android.com/reference/android/content/Intent -There is a command line tool in Android named _am_ which implements the _Intent_ API and can be used to test emulator launching, but this is not intended to be used by other applications and therefore ES-DE implements direct (albeit partial) support for the Intent API. Testing the modern FileProvider interface using the _am_ utility may also be difficult, or maybe impossible. +There is a command line tool in Android named _am_ which implements the _Intent_ API and can be used to test emulator launching, but this is not intended to be used by other applications and therefore ES-DE implements direct (albeit partial) support for the Intent API. Testing the modern FileProvider interface using the _am_ utility is unfortunately not really possible as access permission is provided by the calling process, i.e. ES-DE. + +The es_find_rules.xml and es_systems.xml files are kept in an Android-internal directory and can't be accessed directly, but you can find them at the following location:\ +https://gitlab.com/es-de/emulationstation-de/-/tree/master/resources/systems/android **es_find_rules.xml** diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index 182210321..cc313c6b8 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -679,6 +679,7 @@ The following emulators are supported in AppImage format when using the bundled | macintosh | Basilisk II | BasiliskII*.AppImage | | macintosh | SheepShaver | SheepShaver*.AppImage | | n3ds | Citra | citra-qt*.AppImage | +| n3ds | Panda3DS | Alber-*.AppImage | | n64/n64dd | Rosalie's Mupen GUI | RMG*.AppImage | | ngage/symbian | EKA2L1 | EKA2L1*.AppImage | | ps2 | PCSX2 | pcsx2*.AppImage | @@ -4069,7 +4070,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | naomi | Sega NAOMI | Flycast | Flycast **(Standalone)**,
Flycast Dojo **(Standalone)**,
Demul **(Standalone)** [W] | Yes | Single archive file + .chd file in subdirectory if GD-ROM game | | naomi2 | Sega NAOMI 2 | Flycast | Flycast **(Standalone)**,
Flycast Dojo **(Standalone)**,
Demul **(Standalone)** [W] | Yes | Single archive file + .chd file in subdirectory if GD-ROM game | | naomigd | Sega NAOMI GD-ROM | Flycast | Flycast **(Standalone)**,
Flycast Dojo **(Standalone)** | Yes | Single archive file + .chd file in subdirectory if GD-ROM game | -| n3ds | Nintendo 3DS | Citra [LW],
Citra **(Standalone)** [M] | Citra 2018 [LW],
Citra **(Standalone)** [LW] | No | Single ROM file | +| n3ds | Nintendo 3DS | Citra [LW],
Citra **(Standalone)** [M] | Citra 2018 [LW],
Citra **(Standalone)** [LW],
Panda3DS **(Standalone)** | No | Single ROM file | | n64 | Nintendo 64 | Mupen64Plus-Next | Mupen64Plus **(Standalone)**,
ParaLLEl N64,
simple64 **(Standalone)** [LW],
Rosalie's Mupen GUI **(Standalone)** [LW],
Project64 **(Standalone)** [W],
ares **(Standalone)**,
sixtyforce **(Standalone)** [M] | No | Single archive or ROM file | | n64dd | Nintendo 64DD | ParaLLEl N64 [LW],
Mupen64Plus-Next [M] | Mupen64Plus-Next [LW],
ParaLLEl N64 [M],
Rosalie's Mupen GUI **(Standalone)** [LW],
ares **(Standalone)** | Yes | See the specific _Nintendo 64DD_ section elsewhere in this guide | | nds | Nintendo DS | melonDS DS | melonDS @,
melonDS **(Standalone)**,
DeSmuME,
DeSmuME 2015,
DeSmuME **(Standalone)** [L],
SkyEmu **(Standalone)** | No | Single archive or ROM file | @@ -4088,8 +4089,8 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | pc88 | NEC PC-8800 Series | QUASI88 | QUASI88 **(Standalone)** | Yes | | | pc98 | NEC PC-9800 Series | Neko Project II Kai | Neko Project II | | | | pcarcade | PC Arcade Systems | Wine **(Standalone)** [L],
_Shortcut or script_ [MW] | Proton **(Standalone)** [L],
_AppImage_ [L],
_Shortcut or script_ [L] | No | | -| pcengine | NEC PC Engine | Beetle PCE | Beetle PCE FAST,
Mednafen **(Standalone)**,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | No | Single archive or ROM file | -| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST,
Mednafen **(Standalone)**,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | Yes | | +| pcengine | NEC PC Engine | Beetle PCE | Beetle PCE FAST,
Beetle SuperGrafx,
Mednafen **(Standalone)**,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | No | Single archive or ROM file | +| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST,
Beetle SuperGrafx,
Mednafen **(Standalone)**,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | Yes | | | pcfx | NEC PC-FX | Beetle PC-FX | Mednafen **(Standalone)** | Yes | | | pico8 | PICO-8 Fantasy Console | PICO-8 **(Standalone)** | PICO-8 Splore **(Standalone)**,
Retro8 | No | See the specific _PICO-8_ section elsewhere in this guide | | plus4 | Commodore Plus/4 | VICE xplus4 | VICE xplus4 **(Standalone)** | No | Single archive or image file for tape, cartridge or single-diskette games, .m3u playlist for multi-diskette games | @@ -4104,7 +4105,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | pv1000 | Casio PV-1000 | MAME - Current | MAME **(Standalone)** | No | Single archive or ROM file | | quake | Quake | TyrQuake | vitaQuake 2,
vitaQuake 2 [Rogue],
vitaQuake 2 [Xatrix],
vitaQuake 2 [Zaero],
vitaQuake 3 [LW],
_Shortcut or script_ | No | | | samcoupe | MGT SAM Coupé | SimCoupé **(Standalone)** | | No | Single archive or ROM file | -| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [LW],
Mesen-S,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | | | +| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,
Snes9x 2005 Plus,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [LW],
Mesen-S,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | | | | saturn | Sega Saturn | Beetle Saturn | Kronos [LW],
YabaSanshiro [LW],
Yabause,
Mednafen **(Standalone)**,
SSF **(Standalone)** [W] | Yes | .chd file for single-disc games, .m3u playlist for multi-disc games | | saturnjp | Sega Saturn [Japan] | Beetle Saturn | Kronos [LW],
YabaSanshiro [LW],
Yabause,
Mednafen **(Standalone)**,
SSF **(Standalone)** [W] | Yes | .chd file for single-disc games, .m3u playlist for multi-disc games | | scummvm | ScummVM Game Engine | ScummVM | ScummVM **(Standalone)** | No | See the specific _ScummVM_ section elsewhere in this guide | @@ -4113,24 +4114,24 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | sega32xjp | Sega Super 32X [Japan] | PicoDrive | ares **(Standalone)** | No | Single archive or ROM file | | sega32xna | Sega Genesis 32X [North America] | PicoDrive | ares **(Standalone)** | No | Single archive or ROM file | | segacd | Sega CD | Genesis Plus GX | Genesis Plus GX Wide,
PicoDrive,
ares **(Standalone)** | Yes | | -| sfc | Nintendo SFC (Super Famicom) | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [LW],
Beetle Supafaust [LW],
Mesen-S,
Mesen **(Standalone)** [LW],
Mednafen **(Standalone)**,
ares **(Standalone)** | No | Single archive or ROM file | +| sfc | Nintendo SFC (Super Famicom) | Snes9x - Current | Snes9x 2010,
Snes9x 2005 Plus,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [LW],
Beetle Supafaust [LW],
Mesen-S,
Mesen **(Standalone)** [LW],
Mednafen **(Standalone)**,
ares **(Standalone)** | No | Single archive or ROM file | | sg-1000 | Sega SG-1000 | Genesis Plus GX | Genesis Plus GX Wide,
Gearsystem,
blueMSX,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | No | Single archive or ROM file | | sgb | Nintendo Super Game Boy | Mesen-S | Mesen **(Standalone)** [LW],
SameBoy,
mGBA,
mGBA **(Standalone)** | | Single archive or ROM file | -| snes | Nintendo SNES (Super Nintendo) | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [LW],
Beetle Supafaust [LW],
Mesen-S,
Mesen **(Standalone)** [LW],
Mednafen **(Standalone)**,
ares **(Standalone)** | No | Single archive or ROM file | -| snesna | Nintendo SNES (Super Nintendo) [North America] | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [LW],
Beetle Supafaust [LW],
Mesen-S,
Mesen **(Standalone)** [LW],
Mednafen **(Standalone)**,
ares **(Standalone)** | No | Single archive or ROM file | +| snes | Nintendo SNES (Super Nintendo) | Snes9x - Current | Snes9x 2010,
Snes9x 2005 Plus,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [LW],
Beetle Supafaust [LW],
Mesen-S,
Mesen **(Standalone)** [LW],
Mednafen **(Standalone)**,
ares **(Standalone)** | No | Single archive or ROM file | +| snesna | Nintendo SNES (Super Nintendo) [North America] | Snes9x - Current | Snes9x 2010,
Snes9x 2005 Plus,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [LW],
Beetle Supafaust [LW],
Mesen-S,
Mesen **(Standalone)** [LW],
Mednafen **(Standalone)**,
ares **(Standalone)** | No | Single archive or ROM file | | solarus | Solarus Game Engine | Solarus **(Standalone)** | | No | Single .solarus game file | | spectravideo | Spectravideo | blueMSX | | | | | steam | Valve Steam | Steam **(Standalone)** | | No | See the specific _Steam_ section elsewhere in this guide | | stv | Sega Titan Video Game System | Kronos [LW],
MAME - Current [M] | MAME - Current [LW],
MAME **(Standalone)**,
Mednafen **(Standalone)** | Yes | Single archive file | -| sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [LW],
ares **(Standalone)** | | | +| sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,
Snes9x 2005 Plus,
Snes9x **(Standalone)**,
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [LW],
ares **(Standalone)** | | | | supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,
Mednafen **(Standalone)**,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | No | Single archive or ROM file | | supervision | Watara Supervision | Potator | MAME - Current,
MAME **(Standalone)** | No | Single archive or ROM file | | supracan | Funtech Super A'Can | MAME - Current | MAME **(Standalone)** | Yes/No | Single archive or ROM file. To make MAME start these games create an empty file named internal_68k.bin and zip it into supracan.zip | | switch | Nintendo Switch | Ryujinx **(Standalone)** | | Yes | | | symbian | Symbian | EKA2L1 [Nokia N-Gage] **(Standalone)** | EKA2L1 [Nokia N70] **(Standalone)**,
EKA2L1 [Nokia N97] **(Standalone)**,
EKA2L1 [Custom device] **(Standalone)** | Yes | See the specific _Symbian and Nokia N-Gage_ section elsewhere in this guide | | tanodragon | Tano Dragon | XRoar **(Standalone)** | | Yes | See the specific _Dragon 32 and Tano Dragon_ section elsewhere in this guide | -| tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST,
Mednafen **(Standalone)**,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | No | Single archive or ROM file | -| tg-cd | NEC TurboGrafx-CD | Beetle PCE | Beetle PCE FAST,
Mednafen **(Standalone)**,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | Yes | | +| tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST,
Beetle SuperGrafx,
Mednafen **(Standalone)**,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | No | Single archive or ROM file | +| tg-cd | NEC TurboGrafx-CD | Beetle PCE | Beetle PCE FAST,
Beetle SuperGrafx,
Mednafen **(Standalone)**,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | Yes | | | ti99 | Texas Instruments TI-99 | MAME **(Standalone)** | | Yes | See the specific _Texas Instruments TI-99_ section elsewhere in this guide | | tic80 | TIC-80 Fantasy Computer | TIC-80 | TIC-80 **(Standalone)** | No | Single .tic file | | to8 | Thomson TO8 | Theodore | | | |