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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2024-03-05 18:43:25 +01:00
parent 6a6d9904dc
commit 66c6b5c4c2
8 changed files with 75 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
ANDROID-DEV.md
View file

@ -67,7 +67,6 @@ The following emulators are configured for FileProvider access:
* Ruffle * Ruffle
* Saturn.emu * Saturn.emu
* Swan.emu * Swan.emu
* Yuzu
Some of these emulators still require BIOS files, so not all of them will be completely free from manual configuration. Some of these emulators still require BIOS files, so not all of them will be completely free from manual configuration.
@ -76,9 +75,9 @@ The following emulators have partial FileProvider access support but are current
* M64Plus FZ (the FileProvider interface doesn't work reliably and game launching randomly fails when using it) * M64Plus FZ (the FileProvider interface doesn't work reliably and game launching randomly fails when using it)
* PPSSPP (the FileProvider interface doesn't work with .chd files specifically) * PPSSPP (the FileProvider interface doesn't work with .chd files specifically)
## Splitting system directories across multiple storage devices (not recommended) ## Splitting system directories across multiple storage devices
While it's possible to split the game system directories across multiple storage devices this is definitely not recommended. First it's tedious to setup, but more importantly it breaks portability for the installation. For instance you can't easily migrate between the different operating systems that ES-DE support and your custom collections will not be portable at all, as they will instead contain absolute paths to your games. While it's possible to split the game system directories across multiple storage devices this is not recommended. First it's tedious to setup, but more importantly it breaks portability for the installation. For instance you can't easily migrate between the different operating systems that ES-DE support and your custom collections will not be portable at all, as they will instead contain absolute paths to your games.
The way ES-DE works is that you have a defined ROMs directory which corresponds to the %ROMPATH% variable that is used throughout the es_systems.xml file and the custom collections files. For example this is the system configuration for the samcoupe system: The way ES-DE works is that you have a defined ROMs directory which corresponds to the %ROMPATH% variable that is used throughout the es_systems.xml file and the custom collections files. For example this is the system configuration for the samcoupe system:
```xml ```xml
@ -167,7 +166,7 @@ There are two serious issues that seem to be specific to the Ayn Odin 2, althoug
The first problem is that some emulators refuse to run games that you place inside directories that contain dots in their names. This is quite problematic as the [directories interpreted as files](USERGUIDE.md#directories-interpreted-as-files) functionality depends on the ability to add file extensions to directory names. The first problem is that some emulators refuse to run games that you place inside directories that contain dots in their names. This is quite problematic as the [directories interpreted as files](USERGUIDE.md#directories-interpreted-as-files) functionality depends on the ability to add file extensions to directory names.
This has been observed with M64Plus FZ, Play!, Saturn.emu, FPse and FPseNG and it's working fine with RetroArch, NetherSX2, ePSXe, DuckStation and Yuzu. Note however that this is not a complete list as not all emulators have been tested for this problem. This has been observed with M64Plus FZ, Play!, Saturn.emu, FPse and FPseNG and it's working fine with RetroArch, NetherSX2, ePSXe and DuckStation. Note however that this is not a complete list as not all emulators have been tested for this problem.
If you run into this issue you can use the _folder link_ functionality as an alternative to the _directories interpreted as files_ functionality. How to use folder links is described in the [User guide](USERGUIDE.md). If you run into this issue you can use the _folder link_ functionality as an alternative to the _directories interpreted as files_ functionality. How to use folder links is described in the [User guide](USERGUIDE.md).
@ -433,13 +432,6 @@ 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
### Yuzu
The Play store version of this emulator is getting frequent updates and is therefore recommended. There's an Early Access version as well which is also recommended.
https://play.google.com/store/apps/details?id=org.yuzu.yuzu_emu \
https://play.google.com/store/apps/details?id=org.yuzu.yuzu_emu.ea
## 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.
@ -456,6 +448,7 @@ This is clearly not a complete list of Android devices, but rather those we know
| Meta | Quest 3 | 12 ? | Yes | None | | | Meta | Quest 3 | 12 ? | Yes | None | |
| Nvidia | Shield Pro | 11 (TV) | Yes | None | | | Nvidia | Shield Pro | 11 (TV) | Yes | None | |
| OnePlus | 6T | 11 | Yes | None | | | OnePlus | 6T | 11 | Yes | None | |
| REDMAGIC | 8 Pro | 13 | Yes | None | |
| Retroid | Pocket 2s | 11 | Yes | None | | | Retroid | Pocket 2s | 11 | Yes | None | |
| Retroid | Pocket 3+ | 11 | Yes | None | | | Retroid | Pocket 3+ | 11 | Yes | None | |
| Retroid | Pocket 4 Pro | 13 | Yes | None | | | Retroid | Pocket 4 Pro | 13 | Yes | None | |
@ -628,7 +621,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,<br>PCE.emu **(Standalone)** | No | Single archive or ROM file | | supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,<br>PCE.emu **(Standalone)** | No | Single archive or ROM file |
| supervision | Watara Supervision | Potator | | No | Single archive or ROM file | | supervision | Watara Supervision | Potator | | No | Single archive or ROM file |
| supracan | Funtech Super A'Can | _Placeholder_ | | | | | supracan | Funtech Super A'Can | _Placeholder_ | | | |
| switch | Nintendo Switch | Yuzu **(Standalone)** | Yuzu EA **(Standalone)**,<br>Skyline **(Standalone)** | Yes | | | switch | Nintendo Switch | Skyline **(Standalone)** | | Yes | |
| symbian | Symbian | EKA2L1 **(Standalone)** | | Yes | See the specific _Symbian and Nokia N-Gage_ section in the User guide | | symbian | Symbian | EKA2L1 **(Standalone)** | | Yes | See the specific _Symbian and Nokia N-Gage_ section in the User guide |
| tanodragon | Tano Dragon | _Placeholder_ | | | | | tanodragon | Tano Dragon | _Placeholder_ | | | |
| tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST,<br>PCE.emu **(Standalone)** | No | Single archive or ROM file | | tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST,<br>PCE.emu **(Standalone)** | No | Single archive or ROM file |

18
ANDROID.md
View file

@ -67,7 +67,6 @@ The following emulators are configured for FileProvider access:
* Ruffle * Ruffle
* Saturn.emu * Saturn.emu
* Swan.emu * Swan.emu
* Yuzu
Some of these emulators still require BIOS files, so not all of them will be completely free from manual configuration. Some of these emulators still require BIOS files, so not all of them will be completely free from manual configuration.
@ -76,9 +75,9 @@ The following emulators have partial FileProvider access support but are current
* M64Plus FZ (the FileProvider interface doesn't work reliably and game launching randomly fails when using it) * M64Plus FZ (the FileProvider interface doesn't work reliably and game launching randomly fails when using it)
* PPSSPP (the FileProvider interface doesn't work with .chd files specifically) * PPSSPP (the FileProvider interface doesn't work with .chd files specifically)
## Splitting system directories across multiple storage devices (not recommended) ## Splitting system directories across multiple storage devices
While it's possible to split the game system directories across multiple storage devices this is definitely not recommended. First it's tedious to setup, but more importantly it breaks portability for the installation. For instance you can't easily migrate between the different operating systems that ES-DE support and your custom collections will not be portable at all, as they will instead contain absolute paths to your games. While it's possible to split the game system directories across multiple storage devices this is not recommended. First it's tedious to setup, but more importantly it breaks portability for the installation. For instance you can't easily migrate between the different operating systems that ES-DE support and your custom collections will not be portable at all, as they will instead contain absolute paths to your games.
The way ES-DE works is that you have a defined ROMs directory which corresponds to the %ROMPATH% variable that is used throughout the es_systems.xml file and the custom collections files. For example this is the system configuration for the samcoupe system: The way ES-DE works is that you have a defined ROMs directory which corresponds to the %ROMPATH% variable that is used throughout the es_systems.xml file and the custom collections files. For example this is the system configuration for the samcoupe system:
```xml ```xml
@ -167,7 +166,7 @@ There are two serious issues that seem to be specific to the Ayn Odin 2, althoug
The first problem is that some emulators refuse to run games that you place inside directories that contain dots in their names. This is quite problematic as the [directories interpreted as files](USERGUIDE.md#directories-interpreted-as-files) functionality depends on the ability to add file extensions to directory names. The first problem is that some emulators refuse to run games that you place inside directories that contain dots in their names. This is quite problematic as the [directories interpreted as files](USERGUIDE.md#directories-interpreted-as-files) functionality depends on the ability to add file extensions to directory names.
This has been observed with M64Plus FZ, Play!, Saturn.emu, FPse and FPseNG and it's working fine with RetroArch, NetherSX2, ePSXe, DuckStation and Yuzu. Note however that this is not a complete list as not all emulators have been tested for this problem. This has been observed with M64Plus FZ, Play!, Saturn.emu, FPse and FPseNG and it's working fine with RetroArch, NetherSX2, ePSXe and DuckStation. Note however that this is not a complete list as not all emulators have been tested for this problem.
If you run into this issue you can use the _folder link_ functionality as an alternative to the _directories interpreted as files_ functionality. How to use folder links is described in the [User guide](USERGUIDE.md). If you run into this issue you can use the _folder link_ functionality as an alternative to the _directories interpreted as files_ functionality. How to use folder links is described in the [User guide](USERGUIDE.md).
@ -433,13 +432,6 @@ 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
### Yuzu
The Play store version of this emulator is getting frequent updates and is therefore recommended. There's an Early Access version as well which is also recommended.
https://play.google.com/store/apps/details?id=org.yuzu.yuzu_emu \
https://play.google.com/store/apps/details?id=org.yuzu.yuzu_emu.ea
## 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.
@ -456,6 +448,7 @@ This is clearly not a complete list of Android devices, but rather those we know
| Meta | Quest 3 | 12 ? | Yes | None | | | Meta | Quest 3 | 12 ? | Yes | None | |
| Nvidia | Shield Pro | 11 (TV) | Yes | None | | | Nvidia | Shield Pro | 11 (TV) | Yes | None | |
| OnePlus | 6T | 11 | Yes | None | | | OnePlus | 6T | 11 | Yes | None | |
| REDMAGIC | 8 Pro | 13 | Yes | None | |
| Retroid | Pocket 2s | 11 | Yes | None | | | Retroid | Pocket 2s | 11 | Yes | None | |
| Retroid | Pocket 3+ | 11 | Yes | None | | | Retroid | Pocket 3+ | 11 | Yes | None | |
| Retroid | Pocket 4 Pro | 13 | Yes | None | | | Retroid | Pocket 4 Pro | 13 | Yes | None | |
@ -464,7 +457,6 @@ This is clearly not a complete list of Android devices, but rather those we know
| Samsung | Galaxy S24 Ultra | 14 | 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 | | Wiko | Voix | 12 | No | Fails at configurator/onboarding | Probably a bug in the firmware/OS image as a libc system call fails |
## Supported game systems ## Supported game systems
All emulators are RetroArch cores unless marked as **(Standalone)** All emulators are RetroArch cores unless marked as **(Standalone)**
@ -629,7 +621,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,<br>PCE.emu **(Standalone)** | No | Single archive or ROM file | | supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,<br>PCE.emu **(Standalone)** | No | Single archive or ROM file |
| supervision | Watara Supervision | Potator | | No | Single archive or ROM file | | supervision | Watara Supervision | Potator | | No | Single archive or ROM file |
| supracan | Funtech Super A'Can | _Placeholder_ | | | | | supracan | Funtech Super A'Can | _Placeholder_ | | | |
| switch | Nintendo Switch | Yuzu **(Standalone)** | Yuzu EA **(Standalone)**,<br>Skyline **(Standalone)** | Yes | | | switch | Nintendo Switch | Skyline **(Standalone)** | | Yes | |
| symbian | Symbian | EKA2L1 **(Standalone)** | | Yes | See the specific _Symbian and Nokia N-Gage_ section in the User guide | | symbian | Symbian | EKA2L1 **(Standalone)** | | Yes | See the specific _Symbian and Nokia N-Gage_ section in the User guide |
| tanodragon | Tano Dragon | _Placeholder_ | | | | | tanodragon | Tano Dragon | _Placeholder_ | | | |
| tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST,<br>PCE.emu **(Standalone)** | No | Single archive or ROM file | | tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST,<br>PCE.emu **(Standalone)** | No | Single archive or ROM file |

11
CHANGELOG.md
View file

@ -8,6 +8,7 @@
### Detailed list of changes ### Detailed list of changes
* Removed Yuzu from the switch system
* Added a more informative error message than "HTTP error code 430" when exceeding the daily ScreenScraper quota * Added a more informative error message than "HTTP error code 430" when exceeding the daily ScreenScraper quota
* Added the Geolith RetroArch core as an alternative emulator for the arcade, mame and neogeo 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 .neo file extension to the arcade, mame and neogeo systems
@ -17,6 +18,16 @@
* (linear-es-de) Creating custom collections named "now-playing" or "completed" could lead to them being unthemed * (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) ## Version 3.0.0-17 (Android intermediate)
**Release date:** 2024-03-04 **Release date:** 2024-03-04

4
FAQ-ANDROID.md
View file

@ -51,11 +51,11 @@ See the _Supported game systems_ section at the bottom of the [Android documenta
## Can I split my game system directories across multiple storage devices? ## Can I split my game system directories across multiple storage devices?
Yes but this is not recommended. It's tedious to setup and not how ES-DE is intended to be used. If you still insist on doing it you can read the _Splitting system directories across multiple storage devices (not recommended)_ section in the [Android documentation](ANDROID.md#splitting-system-directories-across-multiple-storage-devices-not-recommended). Yes but this is not recommended. It's tedious to setup and not how ES-DE is intended to be used. If you still insist on doing it you can read the _Splitting system directories across multiple storage devices_ section in the [Android documentation](ANDROID.md#splitting-system-directories-across-multiple-storage-devices).
## When I launch a game using RetroArch I just see a black screen, what is wrong? ## When I launch a game using RetroArch I just see a black screen, what is wrong?
RetroArch on Android is very unforgiving, if you haven't installed the necessary core or BIOS files it's a high chance that you just see a black screen and it will hang there, possibly until you kill it. And due to the security model in Android it's not possible for ES-DE to check if a core is actually installed prior to attempting to launch RetroArch (on Linux, macOS and Windows a popup is shown if the core file is missing and the game is never actually launched in this case). RetroArch on Android is very unforgiving, if you haven't installed the necessary core or BIOS files it's a high chance that you just see a black screen and it will hang there, possibly until you kill it. And due to the security model in Android it's not possible for ES-DE to check if a core is actually installed prior to attempting to launch RetroArch (on Linux, macOS and Windows a popup is shown if the core file is missing and the game is never actually launched in this case). Also make sure that the core you have installed in RetroArch is the one you actually use in ES-DE. You can select between different cores and emulators for most systems using the _Alternative emulators_ interface in the _Other settings_ menu.
Also note that the RetroArch release on the Google Play store is not working correctly on some devices, it can be used on its own but game launching fails from ES-DE. These issues have been resolved by a number of people by instead switching to the release from the [RetroArch](https://retroarch.com) website. Also note that the RetroArch release on the Google Play store is not working correctly on some devices, it can be used on its own but game launching fails from ES-DE. These issues have been resolved by a number of people by instead switching to the release from the [RetroArch](https://retroarch.com) website.

50
INSTALL-DEV.md
View file

@ -1179,18 +1179,19 @@ Here's an example es_find_rules.xml file for Linux (this is not the complete fil
<entry>~/.local/share/flatpak/exports/bin/io.github.dosbox-staging</entry> <entry>~/.local/share/flatpak/exports/bin/io.github.dosbox-staging</entry>
</rule> </rule>
</emulator> </emulator>
<emulator name="YUZU"> <emulator name="XEMU">
<!-- Nintendo Switch emulator Yuzu --> <!-- Microsoft Xbox emulator xemu -->
<rule type="systempath"> <rule type="systempath">
<entry>yuzu</entry> <entry>xemu</entry>
<entry>org.yuzu_emu.yuzu</entry> <entry>app.xemu.xemu</entry>
</rule> </rule>
<rule type="staticpath"> <rule type="staticpath">
<entry>~/Applications/yuzu*.AppImage</entry> <entry>~/Applications/xemu*.AppImage</entry>
<entry>~/.local/bin/yuzu*.AppImage</entry> <entry>~/.local/share/applications/xemu*.AppImage</entry>
<entry>~/bin/yuzu*.AppImage</entry> <entry>~/.local/bin/xemu*.AppImage</entry>
<entry>/var/lib/flatpak/exports/bin/org.yuzu_emu.yuzu</entry> <entry>~/bin/xemu*.AppImage</entry>
<entry>~/.local/share/flatpak/exports/bin/org.yuzu_emu.yuzu</entry> <entry>/var/lib/flatpak/exports/bin/app.xemu.xemu</entry>
<entry>~/.local/share/flatpak/exports/bin/app.xemu.xemu</entry>
</rule> </rule>
</emulator> </emulator>
</ruleList> </ruleList>
@ -1223,11 +1224,11 @@ The other rules are probably self-explanatory with `systempath` searching the PA
```xml ```xml
<rule type="staticpath"> <rule type="staticpath">
<!-- This is supported, first matching file will be selected --> <!-- This is supported, first matching file will be selected -->
<entry>~/Applications/yuzu*.AppImage</entry> <entry>~/Applications/xemu*.AppImage</entry>
<!-- This is also supported --> <!-- This is also supported -->
<entry>~/Applications/yuzu*.App*</entry> <entry>~/Applications/xemu*.App*</entry>
<!-- This is NOT supported --> <!-- This is NOT supported -->
<entry>~/App*/yuzu*.AppImage</entry> <entry>~/App*/xemu*.AppImage</entry>
</rule> </rule>
``` ```
@ -1361,15 +1362,14 @@ For reference, here are also example es_find_rules.xml files for macOS and Windo
<entry>%ESPATH%\..\Emulators\PCSX2-Qt\pcsx2-qt*.exe</entry> <entry>%ESPATH%\..\Emulators\PCSX2-Qt\pcsx2-qt*.exe</entry>
</rule> </rule>
</emulator> </emulator>
<emulator name="YUZU"> <emulator name="XEMU">
<!-- Nintendo Switch emulator Yuzu --> <!-- Microsoft Xbox emulator xemu -->
<rule type="systempath"> <rule type="systempath">
<entry>yuzu.exe</entry> <entry>xemu.exe</entry>
</rule> </rule>
<rule type="staticpath"> <rule type="staticpath">
<entry>~\AppData\Local\yuzu\yuzu-windows-msvc\yuzu.exe</entry> <entry>%ESPATH%\Emulators\xemu\xemu.exe</entry>
<entry>%ESPATH%\Emulators\yuzu\yuzu-windows-msvc\yuzu.exe</entry> <entry>%ESPATH%\..\Emulators\xemu\xemu.exe</entry>
<entry>%ESPATH%\..\Emulators\yuzu\yuzu-windows-msvc\yuzu.exe</entry>
</rule> </rule>
</emulator> </emulator>
</ruleList> </ruleList>
@ -1398,11 +1398,11 @@ But instead of changing the sorting directly in the es_systems.xml file it could
Wildcards are supported for emulator binaries, but not for directories: Wildcards are supported for emulator binaries, but not for directories:
```xml ```xml
<!-- This is supported, first matching file will be selected --> <!-- This is supported, first matching file will be selected -->
<command>~/Applications/yuzu*.AppImage %ROM%</command> <command>~/Applications/xemu*.AppImage %ROM%</command>
<!-- This is also supported --> <!-- This is also supported -->
<command>~/Applications/yuzu*.App* %ROM%</command> <command>~/Applications/xemu*.App* %ROM%</command>
<!-- This is NOT supported --> <!-- This is NOT supported -->
<command>~/App*/yuzu*.AppImage %ROM%</command> <command>~/App*/xemu*.AppImage %ROM%</command>
``` ```
There is a special case when it comes to file extensions where it's possible to use extensionless files if required. To accomplish this simply add a dot (.) to the list of extensions in the `<extension>` tag. Obviously this makes it impossible to use the _directories interpreted as files_ functionality as there is no file extension, but apart from that everything should work the same as for regular files. There is a special case when it comes to file extensions where it's possible to use extensionless files if required. To accomplish this simply add a dot (.) to the list of extensions in the `<extension>` tag. Obviously this makes it impossible to use the _directories interpreted as files_ functionality as there is no file extension, but apart from that everything should work the same as for regular files.
@ -1712,11 +1712,11 @@ Here's an example es_find_rules.xml file defining two emulators:
<entry>com.retroarch/com.retroarch.browser.retroactivity.RetroActivityFuture</entry> <entry>com.retroarch/com.retroarch.browser.retroactivity.RetroActivityFuture</entry>
</rule> </rule>
</emulator> </emulator>
<emulator name="YUZU"> <emulator name="COLEM">
<!-- Nintendo Switch emulator Yuzu --> <!-- Coleco ColecoVision and Adam emulator ColEm -->
<rule type="androidpackage"> <rule type="androidpackage">
<entry>org.yuzu.yuzu_emu.ea/org.yuzu.yuzu_emu.activities.EmulationActivity</entry> <entry>com.fms.colem.deluxe/com.fms.emulib.TVActivity</entry>
<entry>org.yuzu.yuzu_emu/org.yuzu.yuzu_emu.activities.EmulationActivity</entry> <entry>com.fms.colem/com.fms.emulib.TVActivity</entry>
</rule> </rule>
</emulator> </emulator>
</ruleList> </ruleList>

50
INSTALL.md
View file

@ -1177,18 +1177,19 @@ Here's an example es_find_rules.xml file for Linux (this is not the complete fil
<entry>~/.local/share/flatpak/exports/bin/io.github.dosbox-staging</entry> <entry>~/.local/share/flatpak/exports/bin/io.github.dosbox-staging</entry>
</rule> </rule>
</emulator> </emulator>
<emulator name="YUZU"> <emulator name="XEMU">
<!-- Nintendo Switch emulator Yuzu --> <!-- Microsoft Xbox emulator xemu -->
<rule type="systempath"> <rule type="systempath">
<entry>yuzu</entry> <entry>xemu</entry>
<entry>org.yuzu_emu.yuzu</entry> <entry>app.xemu.xemu</entry>
</rule> </rule>
<rule type="staticpath"> <rule type="staticpath">
<entry>~/Applications/yuzu*.AppImage</entry> <entry>~/Applications/xemu*.AppImage</entry>
<entry>~/.local/bin/yuzu*.AppImage</entry> <entry>~/.local/share/applications/xemu*.AppImage</entry>
<entry>~/bin/yuzu*.AppImage</entry> <entry>~/.local/bin/xemu*.AppImage</entry>
<entry>/var/lib/flatpak/exports/bin/org.yuzu_emu.yuzu</entry> <entry>~/bin/xemu*.AppImage</entry>
<entry>~/.local/share/flatpak/exports/bin/org.yuzu_emu.yuzu</entry> <entry>/var/lib/flatpak/exports/bin/app.xemu.xemu</entry>
<entry>~/.local/share/flatpak/exports/bin/app.xemu.xemu</entry>
</rule> </rule>
</emulator> </emulator>
</ruleList> </ruleList>
@ -1221,11 +1222,11 @@ The other rules are probably self-explanatory with `systempath` searching the PA
```xml ```xml
<rule type="staticpath"> <rule type="staticpath">
<!-- This is supported, first matching file will be selected --> <!-- This is supported, first matching file will be selected -->
<entry>~/Applications/yuzu*.AppImage</entry> <entry>~/Applications/xemu*.AppImage</entry>
<!-- This is also supported --> <!-- This is also supported -->
<entry>~/Applications/yuzu*.App*</entry> <entry>~/Applications/xemu*.App*</entry>
<!-- This is NOT supported --> <!-- This is NOT supported -->
<entry>~/App*/yuzu*.AppImage</entry> <entry>~/App*/xemu*.AppImage</entry>
</rule> </rule>
``` ```
@ -1359,15 +1360,14 @@ For reference, here are also example es_find_rules.xml files for macOS and Windo
<entry>%ESPATH%\..\Emulators\PCSX2-Qt\pcsx2-qt*.exe</entry> <entry>%ESPATH%\..\Emulators\PCSX2-Qt\pcsx2-qt*.exe</entry>
</rule> </rule>
</emulator> </emulator>
<emulator name="YUZU"> <emulator name="XEMU">
<!-- Nintendo Switch emulator Yuzu --> <!-- Microsoft Xbox emulator xemu -->
<rule type="systempath"> <rule type="systempath">
<entry>yuzu.exe</entry> <entry>xemu.exe</entry>
</rule> </rule>
<rule type="staticpath"> <rule type="staticpath">
<entry>~\AppData\Local\yuzu\yuzu-windows-msvc\yuzu.exe</entry> <entry>%ESPATH%\Emulators\xemu\xemu.exe</entry>
<entry>%ESPATH%\Emulators\yuzu\yuzu-windows-msvc\yuzu.exe</entry> <entry>%ESPATH%\..\Emulators\xemu\xemu.exe</entry>
<entry>%ESPATH%\..\Emulators\yuzu\yuzu-windows-msvc\yuzu.exe</entry>
</rule> </rule>
</emulator> </emulator>
</ruleList> </ruleList>
@ -1396,11 +1396,11 @@ But instead of changing the sorting directly in the es_systems.xml file it could
Wildcards are supported for emulator binaries, but not for directories: Wildcards are supported for emulator binaries, but not for directories:
```xml ```xml
<!-- This is supported, first matching file will be selected --> <!-- This is supported, first matching file will be selected -->
<command>~/Applications/yuzu*.AppImage %ROM%</command> <command>~/Applications/xemu*.AppImage %ROM%</command>
<!-- This is also supported --> <!-- This is also supported -->
<command>~/Applications/yuzu*.App* %ROM%</command> <command>~/Applications/xemu*.App* %ROM%</command>
<!-- This is NOT supported --> <!-- This is NOT supported -->
<command>~/App*/yuzu*.AppImage %ROM%</command> <command>~/App*/xemu*.AppImage %ROM%</command>
``` ```
There is a special case when it comes to file extensions where it's possible to use extensionless files if required. To accomplish this simply add a dot (.) to the list of extensions in the `<extension>` tag. Obviously this makes it impossible to use the _directories interpreted as files_ functionality as there is no file extension, but apart from that everything should work the same as for regular files. There is a special case when it comes to file extensions where it's possible to use extensionless files if required. To accomplish this simply add a dot (.) to the list of extensions in the `<extension>` tag. Obviously this makes it impossible to use the _directories interpreted as files_ functionality as there is no file extension, but apart from that everything should work the same as for regular files.
@ -1710,11 +1710,11 @@ Here's an example es_find_rules.xml file defining two emulators:
<entry>com.retroarch/com.retroarch.browser.retroactivity.RetroActivityFuture</entry> <entry>com.retroarch/com.retroarch.browser.retroactivity.RetroActivityFuture</entry>
</rule> </rule>
</emulator> </emulator>
<emulator name="YUZU"> <emulator name="COLEM">
<!-- Nintendo Switch emulator Yuzu --> <!-- Coleco ColecoVision and Adam emulator ColEm -->
<rule type="androidpackage"> <rule type="androidpackage">
<entry>org.yuzu.yuzu_emu.ea/org.yuzu.yuzu_emu.activities.EmulationActivity</entry> <entry>com.fms.colem.deluxe/com.fms.emulib.TVActivity</entry>
<entry>org.yuzu.yuzu_emu/org.yuzu.yuzu_emu.activities.EmulationActivity</entry> <entry>com.fms.colem/com.fms.emulib.TVActivity</entry>
</rule> </rule>
</emulator> </emulator>
</ruleList> </ruleList>

4
USERGUIDE-DEV.md
View file

@ -687,7 +687,6 @@ The following emulators are supported in AppImage format when using the bundled
| psvita | Vita3K | Vita3K*.AppImage | | psvita | Vita3K | Vita3K*.AppImage |
| psx | DuckStation | DuckStation*.AppImage | | psx | DuckStation | DuckStation*.AppImage |
| snes | Snes9x | Snes9x*.AppImage | | snes | Snes9x | Snes9x*.AppImage |
| switch | Yuzu | yuzu*.AppImage |
| xbox | xemu | xemu*.AppImage | | xbox | xemu | xemu*.AppImage |
| wii | Dolphin | Dolphin_Emulator*.AppImage | | wii | Dolphin | Dolphin_Emulator*.AppImage |
| wiiu | Cemu | Cemu*.AppImage | | wiiu | Cemu | Cemu*.AppImage |
@ -3961,7 +3960,6 @@ On Windows the following emulators provide a way to inform ES-DE where they have
* Rosalie's Mupen GUI * Rosalie's Mupen GUI
* ScummVM * ScummVM
* SimCoupé * SimCoupé
* Yuzu
Default emulator/Alternative emulators columns: \ Default emulator/Alternative emulators columns: \
**[L]**: Linux, **[M]**: macOS, **[W]**: Windows **[L]**: Linux, **[M]**: macOS, **[W]**: Windows
@ -4128,7 +4126,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [LW],<br>ares **(Standalone)** | No | Single archive or ROM file | | supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [LW],<br>ares **(Standalone)** | No | Single archive or ROM file |
| supervision | Watara Supervision | Potator | MAME - Current,<br>MAME **(Standalone)** | No | Single archive or ROM file | | supervision | Watara Supervision | Potator | MAME - Current,<br>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 | | 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 | Yuzu **(Standalone)** [LW],<br>Ryujinx **(Standalone)** [M] | Ryujinx **(Standalone)** [LW] | Yes | | | switch | Nintendo Switch | Ryujinx **(Standalone)** | | Yes | |
| symbian | Symbian | EKA2L1 [Nokia N-Gage] **(Standalone)** | EKA2L1 [Nokia N70] **(Standalone)**,<br>EKA2L1 [Nokia N97] **(Standalone)**,<br>EKA2L1 [Custom device] **(Standalone)** | Yes | See the specific _Symbian and Nokia N-Gage_ section elsewhere in this guide | | symbian | Symbian | EKA2L1 [Nokia N-Gage] **(Standalone)** | EKA2L1 [Nokia N70] **(Standalone)**,<br>EKA2L1 [Nokia N97] **(Standalone)**,<br>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 | | 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,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [LW],<br>ares **(Standalone)** | No | Single archive or ROM file | | tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [LW],<br>ares **(Standalone)** | No | Single archive or ROM file |

4
USERGUIDE.md
View file

@ -685,7 +685,6 @@ The following emulators are supported in AppImage format when using the bundled
| psvita | Vita3K | Vita3K*.AppImage | | psvita | Vita3K | Vita3K*.AppImage |
| psx | DuckStation | DuckStation*.AppImage | | psx | DuckStation | DuckStation*.AppImage |
| snes | Snes9x | Snes9x*.AppImage | | snes | Snes9x | Snes9x*.AppImage |
| switch | Yuzu | yuzu*.AppImage |
| xbox | xemu | xemu*.AppImage | | xbox | xemu | xemu*.AppImage |
| wii | Dolphin | Dolphin_Emulator*.AppImage | | wii | Dolphin | Dolphin_Emulator*.AppImage |
| wiiu | Cemu | Cemu*.AppImage | | wiiu | Cemu | Cemu*.AppImage |
@ -3959,7 +3958,6 @@ On Windows the following emulators provide a way to inform ES-DE where they have
* Rosalie's Mupen GUI * Rosalie's Mupen GUI
* ScummVM * ScummVM
* SimCoupé * SimCoupé
* Yuzu
Default emulator/Alternative emulators columns: \ Default emulator/Alternative emulators columns: \
**[L]**: Linux, **[M]**: macOS, **[W]**: Windows **[L]**: Linux, **[M]**: macOS, **[W]**: Windows
@ -4126,7 +4124,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [LW],<br>ares **(Standalone)** | No | Single archive or ROM file | | supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [LW],<br>ares **(Standalone)** | No | Single archive or ROM file |
| supervision | Watara Supervision | Potator | MAME - Current,<br>MAME **(Standalone)** | No | Single archive or ROM file | | supervision | Watara Supervision | Potator | MAME - Current,<br>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 | | 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 | Yuzu **(Standalone)** [LW],<br>Ryujinx **(Standalone)** [M] | Ryujinx **(Standalone)** [LW] | Yes | | | switch | Nintendo Switch | Ryujinx **(Standalone)** | | Yes | |
| symbian | Symbian | EKA2L1 [Nokia N-Gage] **(Standalone)** | EKA2L1 [Nokia N70] **(Standalone)**,<br>EKA2L1 [Nokia N97] **(Standalone)**,<br>EKA2L1 [Custom device] **(Standalone)** | Yes | See the specific _Symbian and Nokia N-Gage_ section elsewhere in this guide | | symbian | Symbian | EKA2L1 [Nokia N-Gage] **(Standalone)** | EKA2L1 [Nokia N70] **(Standalone)**,<br>EKA2L1 [Nokia N97] **(Standalone)**,<br>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 | | 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,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [LW],<br>ares **(Standalone)** | No | Single archive or ROM file | | tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [LW],<br>ares **(Standalone)** | No | Single archive or ROM file |