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-07-05 19:32:54 +02:00
parent 4adddbea12
commit 13f8b92ebf
3 changed files with 35 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CHANGELOG.md
View file

@ -20,9 +20,14 @@
* Changed the scraper auto-retry functionality to never run on non-recoverable errors such as insufficient file permissions * Changed the scraper auto-retry functionality to never run on non-recoverable errors such as insufficient file permissions
* Added options to the video and slideshow screensavers to only include favorite games * Added options to the video and slideshow screensavers to only include favorite games
* Added support for a dedicated es_systems_sorting.xml file to change systems sorting without having to modify es_systems.xml * Added support for a dedicated es_systems_sorting.xml file to change systems sorting without having to modify es_systems.xml
* Bundled four complete es_systems_sorting.xml files with the application (they can be found in the resources/sorting/ directory)
* Placing an es_find_rules.xml file in custom_systems will now complement rather than override the bundled file * Placing an es_find_rules.xml file in custom_systems will now complement rather than override the bundled file
* Added support for the LowRes NX Fantasy Console (lowresnx) game system
* Added support for the Epoch Super Cassette Vision (scv) game system
* Added the SameBoy RetroArch core as an alternative emulator for the sgb system * Added the SameBoy RetroArch core as an alternative emulator for the sgb system
* Added MAME standalone as an alternative emulator for the cdimono1 system * Added MAME standalone as an alternative emulator for the amstradcpc, cdimono1 and x68000 systems
* Added ares standalone as an alternative emulator for the n64dd system
* Added ares [Benesse Pocket Challenge V2] standalone as an alternative emulator for the wonderswan system
* Added the .sh file extension to the ags system on Unix and macOS and set the %STARTDIR% variable to the game directory * Added the .sh file extension to the ags system on Unix and macOS and set the %STARTDIR% variable to the game directory
* (Linux) Added "AppImage (Suspend ES-DE)" and "AppImage (Keep ES-DE running)" as alternative emulators for the windows system * (Linux) Added "AppImage (Suspend ES-DE)" and "AppImage (Keep ES-DE running)" as alternative emulators for the windows system
* (Linux) Added the .AppImage file extension to the windows system * (Linux) Added the .AppImage file extension to the windows system
@ -31,6 +36,8 @@
* Added support for scraping the arduboy and ps4 systems using ScreenScraper * Added support for scraping the arduboy and ps4 systems using ScreenScraper
* Added an sgb (Nintendo Super Game Boy) platform to improve scraping using ScreenScraper * Added an sgb (Nintendo Super Game Boy) platform to improve scraping using ScreenScraper
* Removed the experimental status for the theme downloader * Removed the experimental status for the theme downloader
* Simplified ApplicationUpdater by only using the release number when checking for updates
* Added more error checking to ApplicationUpdater by checking for blank name, filename, url and md5 keys in latest_release.json
* Improved resilience to buggy controller drivers which could previously crash the application (mostly relevant for macOS) * Improved resilience to buggy controller drivers which could previously crash the application (mostly relevant for macOS)
* Removed the custom SDL patch for the Linux AppImage builds that prevented the device virtual keyboard from being automatically displayed * Removed the custom SDL patch for the Linux AppImage builds that prevented the device virtual keyboard from being automatically displayed
* If the SDL library release is 2.28.0 or higher, then the automatic popup of the device's virtual keyboard is now disabled * If the SDL library release is 2.28.0 or higher, then the automatic popup of the device's virtual keyboard is now disabled
@ -39,11 +46,14 @@
* Added a setRawImage function to ImageComponent to load raw pixel data into textures (needed by PDFViewer) * Added a setRawImage function to ImageComponent to load raw pixel data into textures (needed by PDFViewer)
* Added the Poppler PDF rendering library as a dependency * Added the Poppler PDF rendering library as a dependency
* Removed the unused graphics files resources/graphics/cartridge.svg and resources/graphics/folder.svg * Removed the unused graphics files resources/graphics/cartridge.svg and resources/graphics/folder.svg
* Modified the resources/graphics/help/dpad_all.svg file to actually show all directions as available
* Updated FFmpeg to 6.0, FreeType to 2.13.0, libgit2 to 1.6.4 and pugixml to 1.13 on Windows and macOS * Updated FFmpeg to 6.0, FreeType to 2.13.0, libgit2 to 1.6.4 and pugixml to 1.13 on Windows and macOS
* Updated SDL to 2.28.0 on Windows, macOS and the Linux AppImage builds * Updated SDL to 2.28.0 on Windows, macOS and the Linux AppImage builds
* (Windows) Updated curl to 8.1.2 * (Windows) Updated curl to 8.1.2
* (Windows) Changed all dependencies to not include version numbers in their directory names to simplify future updates * (Windows) Changed all dependencies to not include version numbers in their directory names to simplify future updates
* Updated LunaSVG to commit f924651b85cac47dbe15f51a4aa320461fc1d07b to fix a GCC 13 build error * Updated LunaSVG to commit f924651b85cac47dbe15f51a4aa320461fc1d07b to fix a GCC 13 build error
* Updated the MAME index files to include ROMs up to MAME version 0.256
* Bundled the May 2023 release of the Mozilla TLS/SSL certificates
* Changed the default OpenGL version from 4.6 to 3.3 when building for RetroDECK * Changed the default OpenGL version from 4.6 to 3.3 when building for RetroDECK
### Bug fixes ### Bug fixes

11
INSTALL-DEV.md
View file

@ -1490,6 +1490,17 @@ You only need to include systems that you want to customize sorting for, and if
Note that the `<systemsortname>` tags are sorted in [lexicographic order](https://en.wikipedia.org/wiki/Lexicographic_order) so 11 will be sorted above 2 but 002 will be sorted above 011. Note that the `<systemsortname>` tags are sorted in [lexicographic order](https://en.wikipedia.org/wiki/Lexicographic_order) so 11 will be sorted above 2 but 002 will be sorted above 011.
There are also four complete sorting files bundled with ES-DE, you can find them in the resources/sorting/ directory, or you can access them [here](https://gitlab.com/es-de/emulationstation-de/-/tree/master/resources/sorting).
These files include all systems supported by ES-DE and provide the following sorting options:
* Hardware type, release year
* Manufacturer, hardware type, release year
* Manufacturer, release year
* Release year
To use these es_systems_sorting.xml files, simply copy any of them to your custom_systems directory.
## es_find_rules.xml ## es_find_rules.xml
This file makes it possible to define rules for where to search for the emulator binaries and emulator cores. This file makes it possible to define rules for where to search for the emulator binaries and emulator cores.

20
USERGUIDE-DEV.md
View file

@ -1455,9 +1455,9 @@ Do NOT overwrite any files when copying over the `data` and `font` directories,
#### Nintendo 64DD #### Nintendo 64DD
The Japan-only 64DD floppy disk addon for the Nintendo 64 is of limited use since there were almost no games released for it, but ES-DE still supports it. The setup below is applicable to both the regular n64 system and the specific n64dd system. The Japan-only 64DD floppy disk addon for the Nintendo 64 is of limited use since there were almost no games released for it, but ES-DE still supports it. The setup below is applicable to both the regular n64 system and the specific n64dd system, with the exception of ares which can't launch 64DD games if they are placed in the regular n64 system.
The setup is quite particular and works differently between the three supported emulators ParaLLEl N64, Mupen64Plus-Next and Rosalie's Mupen GUI. The setup is quite particular and works differently between the four supported emulators ParaLLEl N64, Mupen64Plus-Next, Rosalie's Mupen GUI and ares.
**ParaLLEl N64** **ParaLLEl N64**
@ -1487,6 +1487,10 @@ For RMG you should use the exact same IPL file as for ParaLLEl N64 but it has to
Following this setup you will be able to launch games with the .ndd, .d64, .7z and .zip file extensions. Following this setup you will be able to launch games with the .ndd, .d64, .7z and .zip file extensions.
**ares**
For ares you need the `64DD_IPL.bin` file added to the Firmware configuration screen inside the emulator. Following this you should be able to launch games with the .ndd file extension or such files compressed into .zip archives.
#### Nintendo Wii U #### Nintendo Wii U
The .wua archive format is the preferred method to use for Wii U games, but the method of using unpacked games is also documented here for reference. The .wua archive format is the preferred method to use for Wii U games, but the method of using unpacked games is also documented here for reference.
@ -3100,7 +3104,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| amiga1200 | Commodore Amiga 1200 | PUAE | PUAE 2021 | Yes | See the specific _Commodore Amiga_ section elsewhere in this guide | | amiga1200 | Commodore Amiga 1200 | PUAE | PUAE 2021 | Yes | See the specific _Commodore Amiga_ section elsewhere in this guide |
| amiga600 | Commodore Amiga 600 | PUAE | PUAE 2021 | Yes | See the specific _Commodore Amiga_ section elsewhere in this guide | | amiga600 | Commodore Amiga 600 | PUAE | PUAE 2021 | Yes | See the specific _Commodore Amiga_ section elsewhere in this guide |
| amigacd32 | Commodore Amiga CD32 | PUAE | PUAE 2021 | Yes | | | amigacd32 | Commodore Amiga CD32 | PUAE | PUAE 2021 | Yes | |
| amstradcpc | Amstrad CPC | Caprice32 | CrocoDS,<br>CPCemu **(Standalone)** | No | | | amstradcpc | Amstrad CPC | Caprice32 | CrocoDS,<br>CPCemu **(Standalone)**,<br>MAME **(Standalone)** | Yes for MAME | Single archive or disk file |
| android | Google Android | BlueStacks **(Standalone)** [W] | | No | Shortcut (.lnk) file | | android | Google Android | BlueStacks **(Standalone)** [W] | | No | Shortcut (.lnk) file |
| apple2 | Apple II | LinApple **(Standalone)** [U],<br>Mednafen **(Standalone)** [M],<br>AppleWin **(Standalone)** [W] | Mednafen **(Standalone)** [UW],<br>MAME **(Standalone)** | Yes for Mednafen and MAME | See the specific _Apple II_ section elsewhere in this guide | | apple2 | Apple II | LinApple **(Standalone)** [U],<br>Mednafen **(Standalone)** [M],<br>AppleWin **(Standalone)** [W] | Mednafen **(Standalone)** [UW],<br>MAME **(Standalone)** | Yes for Mednafen and MAME | See the specific _Apple II_ section elsewhere in this guide |
| apple2gs | Apple IIGS | MAME **(Standalone)** | | Yes | See the specific _Apple IIGS_ section elsewhere in this guide | | apple2gs | Apple IIGS | MAME **(Standalone)** | | Yes | See the specific _Apple IIGS_ section elsewhere in this guide |
@ -3159,6 +3163,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| j2me | Java 2 Micro Edition (J2ME) | SquirrelJME | KEmulator **(Standalone)** [W] | No | Single .jar file | | j2me | Java 2 Micro Edition (J2ME) | SquirrelJME | KEmulator **(Standalone)** [W] | No | Single .jar file |
| kodi | Kodi Home Theatre Software | Kodi **(Standalone)** | | No | Shortcut (.desktop/.app/.lnk) file | | kodi | Kodi Home Theatre Software | Kodi **(Standalone)** | | No | Shortcut (.desktop/.app/.lnk) file |
| lcdgames | LCD Handheld Games | MAME Local Artwork **(Standalone)** | MAME **(Standalone)**,<br>Handheld Electronic (GW) | No | See the specific _LCD handheld games_ section elsewhere in this guide | | lcdgames | LCD Handheld Games | MAME Local Artwork **(Standalone)** | MAME **(Standalone)**,<br>Handheld Electronic (GW) | No | See the specific _LCD handheld games_ section elsewhere in this guide |
| lowresnx | LowRes NX Fantasy Console | LowRes NX | | No | Single ROM file |
| lutris | Lutris Open Gaming Platform | Lutris **(Standalone)** [U] | | No | See the specific _Lutris_ section elsewhere in this guide | | lutris | Lutris Open Gaming Platform | Lutris **(Standalone)** [U] | | No | See the specific _Lutris_ section elsewhere in this guide |
| lutro | Lutro Game Engine | Lutro | | | | | lutro | Lutro Game Engine | Lutro | | | |
| macintosh | Apple Macintosh | MAME Mac SE Bootable **(Standalone)** | MAME Mac SE Boot Disk **(Standalone)**,<br>MAME Mac Plus Bootable **(Standalone)**,<br>MAME Mac Plus Boot Disk **(Standalone)**,<br>Basilisk II **(Standalone)**,<br>SheepShaver **(Standalone)** | Yes | See the specific _Apple Macintosh_ section elsewhere in this guide | | macintosh | Apple Macintosh | MAME Mac SE Bootable **(Standalone)** | MAME Mac SE Boot Disk **(Standalone)**,<br>MAME Mac Plus Bootable **(Standalone)**,<br>MAME Mac Plus Boot Disk **(Standalone)**,<br>Basilisk II **(Standalone)**,<br>SheepShaver **(Standalone)** | Yes | See the specific _Apple Macintosh_ section elsewhere in this guide |
@ -3186,7 +3191,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| naomigd | Sega NAOMI GD-ROM | Flycast | Flycast **(Standalone)** | | | | naomigd | Sega NAOMI GD-ROM | Flycast | Flycast **(Standalone)** | | |
| n3ds | Nintendo 3DS | Citra [UW],<br>Citra **(Standalone)** [M] | Citra 2018 [UW],<br>Citra **(Standalone)** [UW] | No | Single ROM file | | n3ds | Nintendo 3DS | Citra [UW],<br>Citra **(Standalone)** [M] | Citra 2018 [UW],<br>Citra **(Standalone)** [UW] | No | Single ROM file |
| n64 | Nintendo 64 | Mupen64Plus-Next | Mupen64Plus **(Standalone)**,<br>ParaLLEl N64,<br>simple64 **(Standalone)** [UW],<br>Rosalie's Mupen GUI **(Standalone)** [UW],<br>Project64 **(Standalone)** [W],<br>ares **(Standalone)**,<br>sixtyforce **(Standalone)** [M] | No | Single archive or ROM file | | n64 | Nintendo 64 | Mupen64Plus-Next | Mupen64Plus **(Standalone)**,<br>ParaLLEl N64,<br>simple64 **(Standalone)** [UW],<br>Rosalie's Mupen GUI **(Standalone)** [UW],<br>Project64 **(Standalone)** [W],<br>ares **(Standalone)**,<br>sixtyforce **(Standalone)** [M] | No | Single archive or ROM file |
| n64dd | Nintendo 64DD | ParaLLEl N64 [UW],<br>Mupen64Plus-Next [M] | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M],<br>Rosalie's Mupen GUI **(Standalone)** [UW] | Yes | See the specific _Nintendo 64DD_ section elsewhere in this guide | | n64dd | Nintendo 64DD | ParaLLEl N64 [UW],<br>Mupen64Plus-Next [M] | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M],<br>Rosalie's Mupen GUI **(Standalone)** [UW],<br>ares **(Standalone)** | 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)** | No | Single archive or ROM file | | nds | Nintendo DS | DeSmuME | DeSmuME 2015,<br>DeSmuME **(Standalone)** [U],<br>melonDS,<br>melonDS **(Standalone)** | No | Single archive or ROM file |
| neogeo | SNK Neo Geo | FinalBurn Neo | FinalBurn Neo **(Standalone)** [UW],<br>MAME **(Standalone)** | Yes | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | | neogeo | SNK Neo Geo | FinalBurn Neo | FinalBurn Neo **(Standalone)** [UW],<br>MAME **(Standalone)** | Yes | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| neogeocd | SNK Neo Geo CD | NeoCD | FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [U],<br>MAME **(Standalone)** | Yes | .chd (NeoCD and MAME only) or .cue file | | neogeocd | SNK Neo Geo CD | NeoCD | FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [U],<br>MAME **(Standalone)** | Yes | .chd (NeoCD and MAME only) or .cue file |
@ -3220,6 +3225,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| saturn | Sega Saturn | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause,<br>Mednafen **(Standalone)**,<br>SSF **(Standalone)** [W] | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game | | saturn | Sega Saturn | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause,<br>Mednafen **(Standalone)**,<br>SSF **(Standalone)** [W] | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game |
| saturnjp | Sega Saturn [Japan] | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause,<br>Mednafen **(Standalone)**,<br>SSF **(Standalone)** [W] | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game | | saturnjp | Sega Saturn [Japan] | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause,<br>Mednafen **(Standalone)**,<br>SSF **(Standalone)** [W] | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game |
| scummvm | ScummVM Game Engine | ScummVM | ScummVM **(Standalone)** | No | See the specific _ScummVM_ section elsewhere in this guide | | scummvm | ScummVM Game Engine | ScummVM | ScummVM **(Standalone)** | No | See the specific _ScummVM_ section elsewhere in this guide |
| scv | Epoch Super Cassette Vision | MAME **(Standalone)** | | Yes | Single archive or ROM file |
| sega32x | Sega Mega Drive 32X | PicoDrive | ares **(Standalone)** | No | Single archive or ROM file | | sega32x | Sega Mega Drive 32X | PicoDrive | ares **(Standalone)** | No | Single archive or ROM file |
| sega32xjp | Sega Super 32X [Japan] | PicoDrive | ares **(Standalone)** | No | Single archive or ROM file | | 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 | | sega32xna | Sega Genesis 32X [North America] | PicoDrive | ares **(Standalone)** | No | Single archive or ROM file |
@ -3255,10 +3261,10 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)**,<br>PrimeHack **(Standalone)** [UW] | No | | | wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)**,<br>PrimeHack **(Standalone)** [UW] | No | |
| wiiu | Nintendo Wii U | Cemu **(Standalone)** | | No | See the specific _Nintendo Wii U_ section elsewhere in this guide | | wiiu | Nintendo Wii U | Cemu **(Standalone)** | | No | See the specific _Nintendo Wii U_ section elsewhere in this guide |
| windows | Microsoft Windows | _Suspend ES-DE_ | _Keep ES-DE running_,<br>_AppImage (Suspend ES-DE)_ [U],<br>_AppImage (Keep ES-DE running)_ [U] | No | Shortcut (.desktop/.app/.lnk) file or script | | windows | Microsoft Windows | _Suspend ES-DE_ | _Keep ES-DE running_,<br>_AppImage (Suspend ES-DE)_ [U],<br>_AppImage (Keep ES-DE running)_ [U] | No | Shortcut (.desktop/.app/.lnk) file or script |
| wonderswan | Bandai WonderSwan | Beetle Cygne | Mednafen **(Standalone)**,<br>ares **(Standalone)** | No | | | wonderswan | Bandai WonderSwan | Beetle Cygne | Mednafen **(Standalone)**,<br>ares **(Standalone)**,<br>ares [Benesse Pocket Challenge V2] **(Standalone)** | No | Single archive or ROM file |
| wonderswancolor | Bandai WonderSwan Color | Beetle Cygne | Mednafen **(Standalone)**,<br>ares **(Standalone)** | No | | | wonderswancolor | Bandai WonderSwan Color | Beetle Cygne | Mednafen **(Standalone)**,<br>ares **(Standalone)** | No | Single archive or ROM file |
| x1 | Sharp X1 | x1 | | | Single archive or ROM file | | x1 | Sharp X1 | x1 | | | Single archive or ROM file |
| x68000 | Sharp X68000 | PX68k | | Yes | | | x68000 | Sharp X68000 | PX68k | MAME **(Standalone)** | Yes | |
| xbox | Microsoft Xbox | xemu **(Standalone)** | Cxbx-Reloaded **(Standalone)** [W] | Yes for xemu | Single .iso file for xemu or unpacked .iso directory for Cxbx-Reloaded | | xbox | Microsoft Xbox | xemu **(Standalone)** | Cxbx-Reloaded **(Standalone)** [W] | Yes for xemu | Single .iso file for xemu or unpacked .iso directory for Cxbx-Reloaded |
| xbox360 | Microsoft Xbox 360 | xenia **(Standalone)** [W] | | No | | | xbox360 | Microsoft Xbox 360 | xenia **(Standalone)** [W] | | No | |
| zmachine | Infocom Z-machine | Gargoyle **(Standalone)** | | No | | | zmachine | Infocom Z-machine | Gargoyle **(Standalone)** | | No | |