Wiki/wiki-rtd/docs/wiki_experiments/external-emulator/external-emulator.md

109 lines
4.4 KiB
Markdown
Raw Normal View History

2025-03-21 12:34:42 +00:00
# Launching External Emulators
2025-03-21 15:00:42 +00:00
This experiment was initiated by the user **TopHatCat:** and later expanded upon by the RetroDECK Team. The goal was to explore the possibility of launching external emulators games and via RetroDECK of ES-DE supported systems.
The main downside of this is that you are getting none of the RetroDECK Features for these emulator: Hotkeys, Configurator, Unified Folders, Backups etc.. etc...
You are bound by each emulators defaults and you will need to personally change them to your liking.
2025-03-21 12:34:42 +00:00
### Disclaimer on Experiments
These experiments are created by the RetroDECK Team and/or Community. The guides are intended for people with technical knowledge and a passion for tinkering. Using these guides *might* put RetroDECK and your data at risk. The RetroDECK Team can't provide any support for these experiments or fix any issues they might cause on your system or RetroDECK installation.
## Prerequisites
### Flatpak Spawn Permission
**Information:**
This experiment requires the `flatpak-spawn` permission, which breaks the sandbox environment that RetroDECK operates in. Therefore, we do not recommend attempting this unless you are confident in your understanding of the process and its implications.
You can enable it by running this command in the terminal.
```
flatpak override --user --talk-name=org.freedesktop.Flatpak net.retrodeck.retrodeck
```
### Add RetroDECK to Steam
2025-03-21 15:00:42 +00:00
We also recommend that you add RetroDECK to Steam to utilize Steam Input if you need to rebind the emulators hotkeys manually.
2025-03-21 12:34:42 +00:00
2025-03-21 15:00:42 +00:00
## Folder Structure
2025-03-21 12:34:42 +00:00
2025-03-21 15:00:42 +00:00
Depending how you installed RetroDECK the Flatpak paths are different.
2025-03-21 12:51:33 +00:00
2025-03-21 15:00:42 +00:00
You can either install it as a system or user application.
2025-03-21 12:51:33 +00:00
2025-03-21 15:00:42 +00:00
| Type | Folder | Comment |
| :---: | :---: | :---: |
| **User Application:** ES-DE Linux Folder |`~/.local/share/flatpak/app/net.retrodeck.retrodeck/current/active/files/share/es-de/resources/systems/linux/` | `es_find_rules.xml` `es_systems.xml` |
| **System Application:** ES-DE Linux Folder |`/var/lib/flatpak/app/net.retrodeck.retrodeck/current/active/files/share/es-de/resources/systems/linux/` | `es_find_rules.xml` `es_systems.xml` |
2025-03-21 12:51:33 +00:00
2025-03-21 15:00:42 +00:00
## How-to add an Flathub installed Emulator
2025-03-21 12:51:33 +00:00
2025-03-21 15:26:09 +00:00
Step one: es_find_rules.xml
2025-03-21 12:51:33 +00:00
2025-03-21 15:00:42 +00:00
1. Go to the ES-DE Linux Folder via the path above (depending how you installed RetroDECK).
2. Find and open `es_find_rules.xml` (if you have RetroDECK installed as a System Application, you will need more permissions).
2025-03-21 15:26:09 +00:00
Step two: Edit es_find_rules.xml
At the end of file add a new ruleset
2025-03-21 12:51:33 +00:00
```
2025-03-21 15:26:09 +00:00
<emulator name="FLATPAKSPAWN">
2025-03-21 15:00:42 +00:00
<rule type="systempath">
<entry>flatpak-spawn</entry>
</rule>
2025-03-21 12:51:33 +00:00
</emulator>
```
2025-03-21 15:26:09 +00:00
Local APP:
2025-03-21 12:51:33 +00:00
2025-03-21 15:26:09 +00:00
```
<command label="Dolphin (External)">
%EMULATOR_HOST% --host /usr/bin/dolphin-emu -b -e %ROM%
</command>
```
2025-03-21 12:51:33 +00:00
```
<command label="Dolphin (External)">
%EMULATOR_HOST% --host /usr/bin/dolphin-emu -b -e %ROM%
</command>
```
2025-03-21 15:26:09 +00:00
Example of full:
```
<system>
<name>supracan</name>
<fullname>Funtech Super A'Can</fullname>
<path>%ROMPATH%/supracan</path>
<extension>.bin .BIN .7z .7Z .zip .ZIP</extension>
<command label="MAME - Current">%EMULATOR_RETROARCH% -L %CORE_RETROARCH%/mame_libretro.so "supracan -rompath \"%GAMEDIRRAW%;%ROMPATH%/supracan\" -cart \"%ROMRAW%\""</command>
<command label="MAME (Standalone)">%EMULATOR_MAME% -inipath /var/config/mame/ini -rompath %GAMEDIR%\;%ROMPATH%/supracan supracan -cart %ROM%</command>
<platform>supracan</platform>
<theme>supracan</theme>
</system>
```
```
<system>
<name>switch</name>
<fullname>Nintendo Switch</fullname>
<path>%ROMPATH%/switch</path>
<extension>.nca .NCA .nro .NRO .nso .NSO .nsp .NSP .xci .XCI</extension>
<command label="Ryujinx (Legacy) (Standalone)">%EMULATOR_RYUJINX% %ROM%</command>
<command label="Yuzu (via Ponzu)">%INJECT%=%BASENAME%.esprefix %EMULATOR_YUZU% -f -g %ROM%</command>
<command label="Ryubing (External)">%EMULATOR_FLATPAKSPAWN% --host flatpak run --branch=stable --arch=x86_64 --command=ryujinx-wrapper --file-forwarding io.github.ryubing.Ryujinx %ROM%</command>
<platform>switch</platform>
<theme>switch</theme>
</system>
```
run --branch=stable --arch=x86_64 --command=ryujinx-wrapper --file-forwarding io.github.ryubing.Ryujinx
<entry>/var/lib/flatpak/exports/bin/org.ryujinx.Ryujinx</entry>
<entry>~/.local/share/flatpak/exports/bin/org.ryujinx.Ryujinx</entry>