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 2022-08-27 18:12:32 +02:00
parent e1c1b40916
commit bfc29380c5
2 changed files with 17 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CHANGELOG.md
View file

@ -18,8 +18,12 @@
* Added support for caching of SVG images
* (Windows) Made game launching more seamless by making the application window one pixel wider instead of one pixel less in height
* Added ares standalone as an alternative emulator for many systems
* (Linux) Added support for the Nintendo Wii U (wiiu) game system
* Added Triforce (Dolphin fork) standalone as an alternative emulator for the gc system on Linux and Windows
* Added VICE standalone as an alternative emulator for the c64 (x64sc only) and vic20 systems
* (Windows) Added PrimeHack as an alternative emulator for the gc and wii systems
* (Windows) Added Project64 as an alternative emulator for the n64 system
* (Windows) Changed the binary for emulator Citra from citra.exe to citra-qt.exe as the command line binary is broken on this OS
* Added CPCemu standalone as an alternative emulator for the amstradcpc system
* Added MAME standalone as an alternative emulator for the gx4000 system
* Added the .bin file extension to the gx4000 system
@ -75,6 +79,7 @@
* Added scraper support for displaying the returned platform if it does not match the game platform, or if multiple platforms are defined for the system
* Added scraping of fan art and updated the media viewer to display these images
* Added scraping of box back covers when using TheGamesDB
* If a wheel (marquee) image on ScreenScraper falls back to another region, then the wheel-hd image is now used instead if it matches the set region
* Moved the option "Scrape actual folders" higher up in the scraper options menu
* Added the ability to set a manual sortname specifically for custom collections using the metadata editor
* When scraping in semi-automatic mode, horizontal scrolling of long game names are no longer reset when automatically selecting the result

16
USERGUIDE-DEV.md
View file

@ -632,6 +632,7 @@ The following emulators are supported in AppImage format when using the bundled
| _Multiple_ | RetroArch | RetroArch-Linux-x86_64.AppImage |
| gba | mGBA | mGBA*.AppImage |
| gc | Dolphin | Dolphin_Emulator*.AppImage |
| gc | Triforce | dolphin-emu-triforce*.AppImage |
| macintosh | Basilisk II | BasiliskII-x86_64.AppImage |
| macintosh | SheepShaver | SheepShaver-x86_64.AppImage |
| ps2 | PCSX2 | pcsx2*-Qt.AppImage |
@ -679,6 +680,7 @@ The following manually downloaded emulators are supported when using the bundled
| samcoupe | SimCoupé | simcoupe/simcoupe |
| switch | Ryujinx | publish/Ryujinx |
| trs-80 | sdl2trs | sdl2trs/sdl2trs |
| wiiu | Cemu | Cemu/Cemu |
Note that the Ryujinx binary is not set as executable after unpacking the archive, so you need to do that once before ES-DE can run it:
```
@ -692,6 +694,12 @@ cd ~/Applications/Vita3K
chmod +x ./Vita3K
```
And also for Cemu:
```
cd ~/Applications/Cemu
chmod +x ./Cemu
```
## 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.
@ -915,7 +923,7 @@ Apart from the potential difficulty in locating the emulator binary, there are s
#### Nintendo Wii U
This section is specific to Windows as Cemu is currently only supported on this operating system.
Cemu is available for Windows and in somewhat experimental form on Linux.
Recently Cemu added support for the .wua archive format which is much easier to use than the unpacked game format. Therefore this is now the recommended approach. But both this and the traditional method of adding unpacked games are covered here.
@ -2940,7 +2948,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| gb | Nintendo Game Boy | Gambatte | SameBoy,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes,<br>mGBA,<br>mGBA **(Standalone)**,<br>VBA-M,<br>VBA-M **(Standalone)** | No | Single archive or ROM file in root folder |
| gba | Nintendo Game Boy Advance | mGBA | mGBA **(Standalone)**,<br>VBA-M,<br>VBA-M **(Standalone)** [UMW*],<br>VBA Next,<br>gpSP | No | Single archive or ROM file in root folder |
| gbc | Nintendo Game Boy Color | Gambatte | SameBoy,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes,<br>mGBA,<br>mGBA **(Standalone)**,<br>VBA-M,<br>VBA-M **(Standalone)** | No | Single archive or ROM file in root folder |
| gc | Nintendo GameCube | Dolphin | Dolphin **(Standalone)** [UMW*], PrimeHack **(Standalone)** [UW*] | No | Single .iso file in root folder |
| gc | Nintendo GameCube | Dolphin | Dolphin **(Standalone)** [UMW*], PrimeHack **(Standalone)** [UW*],<br>Triforce **(Standalone)** [UW*] | No | Single .iso file in root folder |
| genesis | Sega Genesis | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive,<br>BlastEm,<br>BlastEm **(Standalone)** [U],<br>Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder |
| gx4000 | Amstrad GX4000 | Caprice32 | CrocoDS,<br>MAME **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder |
| intellivision | Mattel Electronics Intellivision | FreeIntv | | | |
@ -2971,7 +2979,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| naomi | Sega NAOMI | Flycast | Flycast **(Standalone)** [UMW*] | | |
| naomigd | Sega NAOMI GD-ROM | Flycast | Flycast **(Standalone)** [UMW*] | | |
| n3ds | Nintendo 3DS | Citra [UW],<br>Citra **(Standalone)** [M] | Citra 2018 [UW],<br>Citra **(Standalone)** [UW*] | No | Single ROM file in root folder |
| n64 | Nintendo 64 | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | Mupen64Plus **(Standalone)** [UMW*],<br>ParaLLEl N64 [UW],<br>ares **(Standalone)** [UMW*],<br>sixtyforce **(Standalone)** [M] | No | Single archive or ROM file in root folder |
| n64 | Nintendo 64 | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | Mupen64Plus **(Standalone)** [UMW*],<br>ParaLLEl N64 [UW],<br>Project64 **(Standalone)** [W*],<br>ares **(Standalone)** [UMW*],<br>sixtyforce **(Standalone)** [M] | No | Single archive or ROM file in root folder |
| n64dd | Nintendo 64DD | ParaLLEl N64 | Mupen64Plus-Next [UW] | Yes | See the specific _Nintendo 64DD_ section elsewhere in this guide |
| nds | Nintendo DS | DeSmuME | DeSmuME 2015,<br>DeSmuME **(Standalone)** [U],<br>melonDS,<br>melonDS **(Standalone)** [UMW*] | No | |
| neogeo | SNK Neo Geo | FinalBurn Neo | | Yes | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
@ -3035,7 +3043,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| videopac | Philips Videopac G7000 | O2EM | | | |
| virtualboy | Nintendo Virtual Boy | Beetle VB | Mednafen **(Standalone)** [UMW*] | No | |
| wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)** [UMW*],<br>PrimeHack **(Standalone)** [UW*] | No | |
| wiiu | Nintendo Wii U | Cemu **(Standalone)** [W*] | | No | See the specific _Nintendo Wii U_ section elsewhere in this guide |
| wiiu | Nintendo Wii U | Cemu **(Standalone)** [UW*] | | No | See the specific _Nintendo Wii U_ section elsewhere in this guide |
| wonderswan | Bandai WonderSwan | Beetle Cygne | Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*] | No | |
| wonderswancolor | Bandai WonderSwan Color | Beetle Cygne | Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*] | No | |
| x1 | Sharp X1 | x1 | | | Single archive or ROM file in root folder |