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 2023-11-09 17:34:54 +01:00
parent 062753de7c
commit bbfb655ee1
3 changed files with 52 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
FAQ.md
View file

@ -18,7 +18,7 @@ ES-DE runs on Windows, macOS and BSD Unix as well as on multiple Linux distribut
## What is the relationship between ES-DE and RetroDECK? ## What is the relationship between ES-DE and RetroDECK?
ES-DE and [RetroDECK](http://retrodeck.net) are completely separate projects, but we collaborate to give the best possible user experience. RetroDECK bundles ES-DE with all emulators in the same Flatpak so you don't need to update emulators separately or set Flatpak permissions manually. It's a good idea to read the _Specific notes for Steam Deck_ section of the [User guide](USERGUIDE.md#specific-notes-for-steam-deck) if ES-DE has been installed via RetroDECK. ES-DE and [RetroDECK](http://retrodeck.net) are completely separate projects, but we collaborate to give the best possible user experience. RetroDECK bundles ES-DE with all emulators in the same Flatpak so you don't need to update emulators separately or set Flatpak permissions manually. It's a good idea to read the _Specific notes for Steam Deck_ section of the [User guide](USERGUIDE.md#specific-notes-for-steam-deck) if ES-DE has been installed via RetroDECK. Note however that RetroDECK can also be used on regular Linux desktops and not only on the Steam Deck.
## What is the relationship between ES-DE and EmuDeck? ## What is the relationship between ES-DE and EmuDeck?

13
USERGUIDE-DEV.md
View file

@ -657,6 +657,8 @@ rpcs3-v0.0.19-13103-cc21d1b3_linux64_54579676ed3fa60dafec7188286495e4.AppImage
``` ```
Again, the wildcard matching means this filename should be found by ES-DE when launching a game so no additional setup should be required. Again, the wildcard matching means this filename should be found by ES-DE when launching a game so no additional setup should be required.
Just be aware that AppImageLauncher causes multiple issues and its use is therefore not recommended. You can read more about this in the next section below.
If not using AppImageLauncher, then make sure to set the AppImages as executable or ES-DE will not be able to launch them. For example: If not using AppImageLauncher, then make sure to set the AppImages as executable or ES-DE will not be able to launch them. For example:
``` ```
cd ~/Applications cd ~/Applications
@ -692,6 +694,14 @@ The following emulators are supported in AppImage format when using the bundled
The EKA2L1 AppImage has the very generic name `ubuntu-latest.AppImage` and as such needs to be renamed to match the entry in the table above. The EKA2L1 AppImage has the very generic name `ubuntu-latest.AppImage` and as such needs to be renamed to match the entry in the table above.
## Using AppImageLauncher on Linux
[AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher) will by default move any AppImage you attempt to run to the root of the ~/Applications directory and integreate it into the desktop environment's application menu. While this may sound convenient it causes multiple issues.
It's a gross oversimplification to assume that people want all their AppImages in the ~/Applications directory. For example OpenBOR games are supposed to be packaged as standalone units with the AppImage game engine together with all game assets as different games may require different game engine versions. Another example would be Windows games that are packaged together with Wine or Proton into an AppImage. In ES-DE there are multiple systems that can scrape and launch AppImages directly, which means they need to be placed into the ROMs directory tree.
For these and other reasons it's not recommended to use AppImageLauncher. If you still insist on using it you will need to setup some symlinks to point the relocated AppImages back to their expected locations. This is covered in some specific sections of this user guide, but not everywhere as AppImageLauncher is not a recommended solution for ES-DE.
## AppImage vs Flatpak search order on Linux ## AppImage vs Flatpak search order on Linux
Emulator AppImages are almost always searched before Flatpaks by the bundled configuration. Take the following es_find_rules.xml entry as an example: Emulator AppImages are almost always searched before Flatpaks by the bundled configuration. Take the following es_find_rules.xml entry as an example:
@ -1283,6 +1293,9 @@ That's basically it, for the atarijaguar system just make sure to select _BigPEm
There are many settings in Wine that may affect compatibility, performance etc. but covering all that is beyond the scope of this guide. There are many settings in Wine that may affect compatibility, performance etc. but covering all that is beyond the scope of this guide.
In addition to the above instructions there's an unofficial YouTube video available on how to setup BigPEmu with ES-DE:\
https://www.youtube.com/watch?v=GuPAjgICc-4
### Commodore Amiga and CDTV ### Commodore Amiga and CDTV
There are multiple ways to run these games, for the computer models like the A500, A1200 etc. it's either via diskette images, hard disk images or using specially packaged WHDLoad games. For the CD32 and CDTV you normally run games via CD-ROM disc images. As for emulators all operating systems that ES-DE runs on support the PAUE RetroArch core and the FS-UAE standalone emulator. On Linux and macOS there is also support for the Amiberry standalone emulator. There are multiple ways to run these games, for the computer models like the A500, A1200 etc. it's either via diskette images, hard disk images or using specially packaged WHDLoad games. For the CD32 and CDTV you normally run games via CD-ROM disc images. As for emulators all operating systems that ES-DE runs on support the PAUE RetroArch core and the FS-UAE standalone emulator. On Linux and macOS there is also support for the Amiberry standalone emulator.

38
USERGUIDE.md
View file

@ -655,6 +655,8 @@ rpcs3-v0.0.19-13103-cc21d1b3_linux64_54579676ed3fa60dafec7188286495e4.AppImage
``` ```
Again, the wildcard matching means this filename should be found by ES-DE when launching a game so no additional setup should be required. Again, the wildcard matching means this filename should be found by ES-DE when launching a game so no additional setup should be required.
Just be aware that AppImageLauncher causes multiple issues and its use is therefore not recommended. You can read more about this in the next section below.
If not using AppImageLauncher, then make sure to set the AppImages as executable or ES-DE will not be able to launch them. For example: If not using AppImageLauncher, then make sure to set the AppImages as executable or ES-DE will not be able to launch them. For example:
``` ```
cd ~/Applications cd ~/Applications
@ -690,6 +692,14 @@ The following emulators are supported in AppImage format when using the bundled
The EKA2L1 AppImage has the very generic name `ubuntu-latest.AppImage` and as such needs to be renamed to match the entry in the table above. The EKA2L1 AppImage has the very generic name `ubuntu-latest.AppImage` and as such needs to be renamed to match the entry in the table above.
## Using AppImageLauncher on Linux
[AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher) will by default move any AppImage you attempt to run to the root of the ~/Applications directory and integreate it into the desktop environment's application menu. While this may sound convenient it causes multiple issues.
It's a gross oversimplification to assume that people want all their AppImages in the ~/Applications directory. For example OpenBOR games are supposed to be packaged as standalone units with the AppImage game engine together with all game assets as different games may require different game engine versions. Another example would be Windows games that are packaged together with Wine or Proton into an AppImage. In ES-DE there are multiple systems that can scrape and launch AppImages directly, which means they need to be placed into the ROMs directory tree.
For these and other reasons it's not recommended to use AppImageLauncher. If you still insist on using it you will need to setup some symlinks to point the relocated AppImages back to their expected locations. This is covered in some specific sections of this user guide, but not everywhere as AppImageLauncher is not a recommended solution for ES-DE.
## AppImage vs Flatpak search order on Linux ## AppImage vs Flatpak search order on Linux
Emulator AppImages are almost always searched before Flatpaks by the bundled configuration. Take the following es_find_rules.xml entry as an example: Emulator AppImages are almost always searched before Flatpaks by the bundled configuration. Take the following es_find_rules.xml entry as an example:
@ -865,6 +875,31 @@ The following Windows emulators are supported, and the setup for most of these i
| xbox360 | xenia | xenia/xenia.exe | | xbox360 | xenia | xenia/xenia.exe |
| xbox360 | xenia | xenia/xenia_canary.exe | | xbox360 | xenia | xenia/xenia_canary.exe |
**Setup for AppImageLauncher**
[AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher) will by default move any AppImage you attempt to run to the root of the ~/Applications directory. This annoyingly also includes files in subdirectories in the ~/Applications tree, so the Wine and Proton AppImages would get relocated there too.
For instance:
```
~/Applications/Wine/wine-stable_8.0.2-x86_64.AppImage
```
Would be moved to:
```
~/Applications/wine-stable_8.0.2-x86_64_7218a7d163a0ce403cac23ebcb3747a3.AppImage
```
A hash will be applied to the filename as part of the move process.
To work around this simply symlink the newly moved and renamed AppImage back into the Wine or Proton directory, like so:
```
cd ~/Applications/Wine
ln -s ../wine-stable_8.0.2-x86_64_7218a7d163a0ce403cac23ebcb3747a3.AppImage .
```
While it's possible to setup a custom find rule entry to look for the Wine and Proton AppImages directly in ~/Applications this is not a good idea as the filename similarities between these two files can lead to a mixup, you really want them separated into their own directories.
An alternative and recommended solution to avoid the symlinking would be to not use AppImageLauncher at all.
## Running emulators in fullscreen mode ## Running emulators in fullscreen mode
In general ES-DE does not pass command line parameters to emulators to start them in fullscreen mode. This is so as for most (if not all) emulators, command line arguments overrides the settings the user has defined. This means that windowed mode would become impossible to achieve without creating custom systems configuration entries if ES-DE enforced fullscreen mode. There are only a very few exceptions for emulators where there is no other way to enter fullscreen mode than by passing such options during game launch. In general ES-DE does not pass command line parameters to emulators to start them in fullscreen mode. This is so as for most (if not all) emulators, command line arguments overrides the settings the user has defined. This means that windowed mode would become impossible to achieve without creating custom systems configuration entries if ES-DE enforced fullscreen mode. There are only a very few exceptions for emulators where there is no other way to enter fullscreen mode than by passing such options during game launch.
@ -1256,6 +1291,9 @@ That's basically it, for the atarijaguar system just make sure to select _BigPEm
There are many settings in Wine that may affect compatibility, performance etc. but covering all that is beyond the scope of this guide. There are many settings in Wine that may affect compatibility, performance etc. but covering all that is beyond the scope of this guide.
In addition to the above instructions there's an unofficial YouTube video available on how to setup BigPEmu with ES-DE:\
https://www.youtube.com/watch?v=GuPAjgICc-4
### Commodore Amiga and CDTV ### Commodore Amiga and CDTV
There are multiple ways to run these games, for the computer models like the A500, A1200 etc. it's either via diskette images, hard disk images or using specially packaged WHDLoad games. For the CD32 and CDTV you normally run games via CD-ROM disc images. As for emulators all operating systems that ES-DE runs on support the PAUE RetroArch core and the FS-UAE standalone emulator. On Linux and macOS there is also support for the Amiberry standalone emulator. There are multiple ways to run these games, for the computer models like the A500, A1200 etc. it's either via diskette images, hard disk images or using specially packaged WHDLoad games. For the CD32 and CDTV you normally run games via CD-ROM disc images. As for emulators all operating systems that ES-DE runs on support the PAUE RetroArch core and the FS-UAE standalone emulator. On Linux and macOS there is also support for the Amiberry standalone emulator.