Documentation update

This commit is contained in:
Leon Styhre 2023-09-18 18:10:15 +02:00
parent 6cc7054aa8
commit 3cafa030a7
2 changed files with 11 additions and 3 deletions

View file

@ -24,6 +24,9 @@
* Enabled the setting "Only show ROMs from gamelist.xml files" to be changed without requiring an application restart * Enabled the setting "Only show ROMs from gamelist.xml files" to be changed without requiring an application restart
* Renamed the setting "Only show ROMs from gamelist.xml files" to "Only show games from gamelist.xml files * Renamed the setting "Only show ROMs from gamelist.xml files" to "Only show games from gamelist.xml files
* Added support for deleting installed themes from the theme downloader interface * Added support for deleting installed themes from the theme downloader interface
* Added support for the Acorn Archimedes (archimedes) game system
* Added support for the Bit Corporation Gamate (gamate) game system
* Added support for the Commodore Plus/4 (plus4) game system
* Added support for the Microsoft Windows 3.x (windows3x) game system * Added support for the Microsoft Windows 3.x (windows3x) game system
* Added support for the Microsoft Windows 9x (windows9x) game system * Added support for the Microsoft Windows 9x (windows9x) game system
* Removed support for the MAME4ALL (mame-mame4all) system * Removed support for the MAME4ALL (mame-mame4all) system
@ -50,6 +53,7 @@
* (Windows) Added the .url file extension to the epic system * (Windows) Added the .url file extension to the epic system
* (Windows) Added the .lnk file extension to the steam system * (Windows) Added the .lnk file extension to the steam system
* Removed atarijaguarcd as an extra platform for the atarijaguar system as it actually made scraping worse * Removed atarijaguarcd as an extra platform for the atarijaguar system as it actually made scraping worse
* (modern-es-de) Replaced the carousel images for the c64 and dos systems
* Changed the screensaver to never show the same game again until all games have been cycled through * Changed the screensaver to never show the same game again until all games have been cycled through
* Reduced the slideshow screensaver fade-in time * Reduced the slideshow screensaver fade-in time
* Removed the annoying warning message when selecting the video screensaver from the UI settings menu * Removed the annoying warning message when selecting the video screensaver from the UI settings menu
@ -85,6 +89,7 @@
* Changed the application updater to not use the scraper's transfer and connection timeout settings * Changed the application updater to not use the scraper's transfer and connection timeout settings
* Added support to MathUtil::md5Hash() for streaming files in chunks * Added support to MathUtil::md5Hash() for streaming files in chunks
* Replaced a number of homecooked functions in FileSystemUtil with those from the C++ standard library * Replaced a number of homecooked functions in FileSystemUtil with those from the C++ standard library
* Added support for defining an explicit back button function for GuiMsgBox
* Added support for fragment shader clipping to Font and TextComponent instead of using glScissor * Added support for fragment shader clipping to Font and TextComponent instead of using glScissor
* Added horizontal text scrolling functionality to TextComponent * Added horizontal text scrolling functionality to TextComponent
* Removed all horizontal text scrolling code from ComponentList and TextListComponent * Removed all horizontal text scrolling code from ComponentList and TextListComponent

View file

@ -1502,7 +1502,7 @@ As an alternative you can add Lutris games to the Ports system using the procedu
### Microsoft Windows 3.x and 9x ### Microsoft Windows 3.x and 9x
There are multiple ways to run Windows 3.x and Windows 9x games and ES-DE provides support for two main options. The first approach is to run these games inside a complete operating system emulated via DOSBox and the second approach is to use shortcuts, scripts or AppImages to run the games separately via applications like Wine or Lutris or by using source ports and similar. There are multiple ways to run Windows 3.x and Windows 9x games and two different approaches are covered here. The first option is to run these games inside a complete operating system emulated via DOSBox and the second option is to use shortcuts, scripts or AppImages to run the games separately via applications like Wine or Lutris or by using source ports and similar. It may also be possible to run these games as zip files via DOSBox-Pure (which is available as an alternative emulator for these systems), but it's not covered here.
The second approach is very flexible but does not lead to the most authentic experience in many cases. It will also not be covered in detail here. As long as you have a script, shortcut or AppImage that can be launched outside ES-DE you should be able to place it into the `~/ROMs/windows3x` or `~/ROMs/windows9x` directories and launch it inside ES-DE as well (assuming you have selected the correct alternative emulator entry). If you've named the files appropriately it should also be possible to scrape them. The second approach is very flexible but does not lead to the most authentic experience in many cases. It will also not be covered in detail here. As long as you have a script, shortcut or AppImage that can be launched outside ES-DE you should be able to place it into the `~/ROMs/windows3x` or `~/ROMs/windows9x` directories and launch it inside ES-DE as well (assuming you have selected the correct alternative emulator entry). If you've named the files appropriately it should also be possible to scrape them.
@ -3474,6 +3474,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| 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 |
| arcade | Arcade | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)**,<br>FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [UW],<br>FB Alpha 2012,<br>Flycast,<br>Flycast **(Standalone)**,<br>Kronos [UW],<br>Model 2 Emulator **(Standalone)** [W],<br>Model 2 Emulator [Suspend ES-DE] **(Standalone)** [W],<br>Supermodel **(Standalone)** [UW],<br>Supermodel [Fullscreen] **(Standalone)** [UW],<br>_Shortcut or script_ | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | | arcade | Arcade | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)**,<br>FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [UW],<br>FB Alpha 2012,<br>Flycast,<br>Flycast **(Standalone)**,<br>Kronos [UW],<br>Model 2 Emulator **(Standalone)** [W],<br>Model 2 Emulator [Suspend ES-DE] **(Standalone)** [W],<br>Supermodel **(Standalone)** [UW],<br>Supermodel [Fullscreen] **(Standalone)** [UW],<br>_Shortcut or script_ | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| arcadia | Emerson Arcadia 2001 | MAME **(Standalone)** | | No | Single archive or ROM file | | arcadia | Emerson Arcadia 2001 | MAME **(Standalone)** | | No | Single archive or ROM file |
| archimedes | Acorn Archimedes | MAME **(Standalone)** [Model A440/1] | MAME **(Standalone)** [Model A3000],<br>MAME **(Standalone)** [Model A310],<br>MAME **(Standalone)** [Model A540] | Yes | |
| arduboy | Arduboy Miniature Game System | Arduous | | No | Single archive or .hex file | | arduboy | Arduboy Miniature Game System | Arduous | | No | Single archive or .hex file |
| astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** | Yes | See the specific _Bally Astrocade_ section elsewhere in this guide | | astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** | Yes | See the specific _Bally Astrocade_ section elsewhere in this guide |
| atari2600 | Atari 2600 | Stella | Stella 2014,<br>Stella **(Standalone)**,<br>Gopher2600 **(Standalone)** [UW],<br>ares **(Standalone)** | No | Single archive or ROM file | | atari2600 | Atari 2600 | Stella | Stella 2014,<br>Stella **(Standalone)**,<br>Gopher2600 **(Standalone)** [UW],<br>ares **(Standalone)** | No | Single archive or ROM file |
@ -3516,6 +3517,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| flash | Adobe Flash | Ruffle **(Standalone)** | Lightspark **(Standalone)** [U],<br>ArcadeFlashWeb **(Standalone)** [W] | No | Single .swf file | | flash | Adobe Flash | Ruffle **(Standalone)** | Lightspark **(Standalone)** [U],<br>ArcadeFlashWeb **(Standalone)** [W] | No | Single .swf file |
| fmtowns | Fujitsu FM Towns | Tsugaru **(Standalone)** [UW] | | Yes | See the specific _Fujitsu FM Towns_ section elsewhere in this guide | | fmtowns | Fujitsu FM Towns | Tsugaru **(Standalone)** [UW] | | Yes | See the specific _Fujitsu FM Towns_ section elsewhere in this guide |
| fpinball | Future Pinball | Future Pinball **(Standalone)** [W] | | No | | | fpinball | Future Pinball | Future Pinball **(Standalone)** [W] | | No | |
| gamate | Bit Corporation Gamate | MAME **(Standalone)** | | Yes | Single archive or ROM file |
| gameandwatch | Nintendo Game and Watch | MAME Local Artwork **(Standalone)** | MAME **(Standalone)**,<br>Handheld Electronic (GW) | No | See the specific _LCD handheld games_ section elsewhere in this guide | | gameandwatch | Nintendo Game and Watch | MAME Local Artwork **(Standalone)** | MAME **(Standalone)**,<br>Handheld Electronic (GW) | No | See the specific _LCD handheld games_ section elsewhere in this guide |
| gamecom | Tiger Electronics Game.com | MAME **(Standalone)** | | Yes | Single archive or ROM file | | gamecom | Tiger Electronics Game.com | MAME **(Standalone)** | | Yes | Single archive or ROM file |
| gamegear | Sega Game Gear | Genesis Plus GX | Genesis Plus GX Wide,<br>Gearsystem,<br>SMS Plus GX,<br>PicoDrive,<br>Mednafen **(Standalone)**,<br>ares **(Standalone)** | No | Single archive or ROM file | | gamegear | Sega Game Gear | Genesis Plus GX | Genesis Plus GX Wide,<br>Gearsystem,<br>SMS Plus GX,<br>PicoDrive,<br>Mednafen **(Standalone)**,<br>ares **(Standalone)** | No | Single archive or ROM file |
@ -3576,6 +3578,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [UW],<br>ares **(Standalone)** | Yes | | | pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST,<br>Mednafen **(Standalone)**,<br>Mesen **(Standalone)** [UW],<br>ares **(Standalone)** | Yes | |
| pcfx | NEC PC-FX | Beetle PC-FX | Mednafen **(Standalone)** | Yes | | | pcfx | NEC PC-FX | Beetle PC-FX | Mednafen **(Standalone)** | Yes | |
| pico8 | PICO-8 Fantasy Console | PICO-8 **(Standalone)** | PICO-8 Splore **(Standalone)** | No | See the specific _PICO-8_ section elsewhere in this guide | | pico8 | PICO-8 Fantasy Console | PICO-8 **(Standalone)** | PICO-8 Splore **(Standalone)** | No | See the specific _PICO-8_ section elsewhere in this guide |
| plus4 | Commodore Plus/4 | VICE xplus4 | VICE xplus4 **(Standalone)** | No | Single archive or image file for tape, cartridge or single-diskette games, .m3u playlist for multi-diskette games |
| pokemini | Nintendo Pokémon Mini | PokeMini | | No | | | pokemini | Nintendo Pokémon Mini | PokeMini | | No | |
| ports | Ports | _Shortcut or script_ | _AppImage_ [U] | No | See the specific _Ports and desktop applications_ section elsewhere in this guide | | ports | Ports | _Shortcut or script_ | _AppImage_ [U] | No | See the specific _Ports and desktop applications_ section elsewhere in this guide |
| ps2 | Sony PlayStation 2 | LRPS2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 [UW] @,<br>PCSX2 **(Standalone)** [UW],<br>PCSX2 Legacy **(Standalone)** @,<br>Play! **(Standalone)**,<br>AetherSX2 **(Standalone)** [M] | Yes except for Play! | | | ps2 | Sony PlayStation 2 | LRPS2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 [UW] @,<br>PCSX2 **(Standalone)** [UW],<br>PCSX2 Legacy **(Standalone)** @,<br>Play! **(Standalone)**,<br>AetherSX2 **(Standalone)** [M] | Yes except for Play! | |
@ -3628,8 +3631,8 @@ 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, script or AppImage | | 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, script or AppImage |
| windows3x | Microsoft Windows 3.x | DOSBox-X **(Standalone)** | _Shortcut or script (Suspend ES-DE)_,<br>_Shortcut or script (Keep ES-DE running)_,<br>_AppImage (Suspend ES-DE)_ [U],<br>_AppImage (Keep ES-DE running)_ [U] | No | See the specific _Microsoft Windows 3.x and 9x_ section elsewhere in this guide | | windows3x | Microsoft Windows 3.x | DOSBox-X **(Standalone)** | DOSBox-Pure,<br>_Shortcut or script (Suspend ES-DE)_,<br>_Shortcut or script (Keep ES-DE running)_,<br>_AppImage (Suspend ES-DE)_ [U],<br>_AppImage (Keep ES-DE running)_ [U] | No | See the specific _Microsoft Windows 3.x and 9x_ section elsewhere in this guide |
| windows9x | Microsoft Windows 9x | DOSBox-X **(Standalone)** | _Shortcut or script (Suspend ES-DE)_,<br>_Shortcut or script (Keep ES-DE running)_,<br>_AppImage (Suspend ES-DE)_ [U],<br>_AppImage (Keep ES-DE running)_ [U] | No | See the specific _Microsoft Windows 3.x and 9x_ section elsewhere in this guide | | windows9x | Microsoft Windows 9x | DOSBox-X **(Standalone)** | DOSBox-Pure,<br>_Shortcut or script (Suspend ES-DE)_,<br>_Shortcut or script (Keep ES-DE running)_,<br>_AppImage (Suspend ES-DE)_ [U],<br>_AppImage (Keep ES-DE running)_ [U] | No | See the specific _Microsoft Windows 3.x and 9x_ section elsewhere in this guide |
| wonderswan | Bandai WonderSwan | Beetle Cygne | Mednafen **(Standalone)**,<br>ares **(Standalone)**,<br>ares [Benesse Pocket Challenge V2] **(Standalone)** | No | Single archive or ROM file | | 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 | Single archive or ROM file | | 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 |