mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-21 13:45:38 +00:00
Documentation update.
This commit is contained in:
Leon Styhre
parent
817d76190a
commit
9b312881a2
|
|
@ -34,7 +34,7 @@ Apart from all the above, a huge amount of work has gone into fixing bugs, refac
|
|||
* Added size options (small/medium/large) for the boxes/covers and physical media images when generating miximages
|
||||
* Added support for the Raspberry Pi 4 (Raspberry Pi OS 32-bit/armv7l and 64-bit/aarch64)
|
||||
* Bundled the new alternative theme "modern-DE" which supports all the latest features from this release
|
||||
* Changed the Unix fullscreen mode to SDL_WINDOW_FULLSCREEN_DESKTOP and removed the --windowed, --fullscreen-normal and --fullscreen-borderless command line options
|
||||
* Changed the Unix fullscreen mode and removed the --windowed, --fullscreen-normal and --fullscreen-borderless command line options
|
||||
* Removed the Unix-specific menu option "Fullscreen mode (requires restart)"
|
||||
* Added the ability to make complementary game system customizations without having to replace the entire bundled es_systems.xml file
|
||||
* Added support for an optional \<systemsortname\> tag for es_systems.xml that can be used to override the default \<fullname\> systems sorting
|
||||
|
|
@ -117,7 +117,7 @@ Apart from all the above, a huge amount of work has gone into fixing bugs, refac
|
|||
* Increased the minimal required compiler version to 5.0.0 for Clang/LLVM and 7.1 for GCC
|
||||
* Added CMake options to build with AddressSanitizer, ThreadSanitizer and UndefinedBehaviorSanitizer
|
||||
* Changed two clang-format rules related to braced lists and reformatted the codebase
|
||||
* Replaced the bundled SDL version 2.0.14 with 2.0.18 for the Windows release
|
||||
* Upgraded the bundled SDL version 2.0.14 to 2.0.18 for Windows and macOS
|
||||
* Bundled the October 2021 release of the Mozilla TLS/SSL certificates
|
||||
* Updated the MAME index files to include ROMs up to MAME version 0.237
|
||||
* rbsimple-DE: Added some missing graphics for the xbox360 and residualvm systems
|
||||
|
|
@ -159,6 +159,7 @@ Apart from all the above, a huge amount of work has gone into fixing bugs, refac
|
|||
* Under some circumstances and at some screen resolutions, the last menu separator line would not get rendered (still an issue at extreme resolutions like 320x240)
|
||||
* When scrolling in menus, pressing other buttons than "Up" or "Down" did not stop the scrolling which caused all sorts of weird behavior
|
||||
* With the menu scale-up effect enabled and entering a submenu before the parent menu was completely scaled up, the parent would get stuck at a semi-scaled size
|
||||
* The launch screen text had ugly scaling artifacts if the menu opening effect was set to "Scale-up"
|
||||
* The custom collection deletion screen had incorrect row heights when running at lower resolutions such as 1280x720
|
||||
* If there was an abbreviated full system name for the "Gamelist on startup" option, that abbreviation would also get displayed when opening the selector window
|
||||
* Really long theme set names would not get abbreviated in the UI settings menu, leading to a garbled "Theme set" setting row
|
||||
|
|
|
|||
|
|
@ -51,6 +51,8 @@ If using a Mac with an M1 processor you need to install the x86 version of Retro
|
|||
|
||||
If using macOS Monterey, there has been a quite serious OpenGL bug introduced by Apple which causes problems for ES-DE. A workaround for this issue is discussed [below](USERGUIDE-DEV.md#specific-notes-for-macos).
|
||||
|
||||
Additional known issues are detailed in [CHANGELOG.md](CHANGELOG.md#known-issues).
|
||||
|
||||
As for display resolutions, the minimum pixel value is 224 and the maximum is 7680. This means that you can run ES-DE at for instance 320x224 all the way up to 7680x4320 (8K UHD). Vertical screen orientation is also supported, as well as ultra-wide resolutions like 3840x1440. Note that there could be some minor visual glitches when running in vertical orientation (this will be fixed in future ES-DE releases) and for the best experience you will probably need to use a customized theme set when running at extreme or unusual resolutions.
|
||||
|
||||
The installation procedure is just covered briefly here and may differ a bit for your specific operating system, so in case of problems refer to your system documentation.
|
||||
|
|
@ -1813,7 +1815,7 @@ Sometimes the name of the console is (more or less) the same for multiple region
|
|||
|
||||
For the **Full name** column, text inside square brackets [] are comments and not part of the actual system name.
|
||||
|
||||
The **Default emulator** column lists the primary emulator as configured in es_systems.xml. If this differs between Unix, macOS and Windows then it's specified in square brackets, such as [UW] for Unix and Windows and [M] for macOS. If not all of the three platforms are specified it means that the system is not available on the missing platforms. For example Lutris which is only avaialable on Unix is marked with only a _[U]_. Unless explicitly marked as **(Standalone)**, each emulator is a RetroArch core.
|
||||
The **Default emulator** column lists the primary emulator as configured in es_systems.xml. If this differs between Unix, macOS and Windows then it's specified in square brackets, such as [UW] for Unix and Windows and [M] for macOS. If one or more of the platforms are not specified it means that the system is not available on those platforms. For example Lutris which only exists on Unix is marked with only a _[U]_. Unless explicitly marked as **(Standalone)**, each emulator is a RetroArch core. A number of systems are marked as _Placeholder_ which means that although there is a configuration entry present, the actual emulator is not preconfigured. If you want to use such a system, you need to add a custom configuration yourself. The long term goal is to have these placeholders replaced with proper emulator configuration so all systems can be used without requiring manual setup.
|
||||
|
||||
The **Alternative emulators** column lists additional emulators configured in es_systems.xml that can be selected per system and per game, as explained earlier in this guide. This does not necessarily include everything in existence, as for some platforms there are a lot of emulators to choose from. In those cases the included emulators is a curated selection. In the same manner as the _Default emulator_ column, differences between Unix, macOS and Windows are marked using square brackets. Unless explicitly marked as **(Standalone)**, each emulator is a RetroArch core.
|
||||
|
||||
|
|
@ -1842,17 +1844,17 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
|
|||
| :-------------------- | :--------------------------------------------- | :-------------------------------- | :-------------------------------- | :----------- | :----------------------------------- |
|
||||
| 3do | 3DO | 4DO | | | |
|
||||
| 64dd | Nintendo 64DD | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | ParaLLEl N64 [UW] | | |
|
||||
| ags | Adventure Game Studio game engine | | | | |
|
||||
| ags | Adventure Game Studio Game Engine | _Placeholder_ | | | |
|
||||
| amiga | Commodore Amiga | PUAE | | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc |
|
||||
| amiga600 | Commodore Amiga 600 | PUAE | | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc |
|
||||
| amiga1200 | Commodore Amiga 1200 | PUAE | | Yes | WHDLoad hard disk image in .hdf or .hdz format in root folder, or diskette image in .adf format in root folder if single-disc, or in separate folder with .m3u playlist if multi-disc |
|
||||
| amigacd32 | Commodore Amiga CD32 | PUAE | | | |
|
||||
| amstradcpc | Amstrad CPC | Caprice32 | CrocoDS | | |
|
||||
| android | Google Android | | | | |
|
||||
| apple2 | Apple II | | | | |
|
||||
| apple2gs | Apple IIGS | | | | |
|
||||
| android | Google Android | _Placeholder_ | | | |
|
||||
| apple2 | Apple II | _Placeholder_ | | | |
|
||||
| apple2gs | Apple IIGS | _Placeholder_ | | | |
|
||||
| arcade | Arcade | MAME - Current | MAME 2000,<br>MAME 2003-Plus,<br>MAME 2010,<br>FinalBurn Neo,<br>FB Alpha 2012 | Depends | Single archive file following MAME name standard in root folder |
|
||||
| astrocade | Bally Astrocade | | | | |
|
||||
| astrocade | Bally Astrocade | _Placeholder_ | | | |
|
||||
| atari2600 | Atari 2600 | Stella | Stella 2014 | No | Single archive or ROM file in root folder |
|
||||
| atari5200 | Atari 5200 | Atari800 | | | |
|
||||
| atari7800 | Atari 7800 ProSystem | ProSystem | | | |
|
||||
|
|
@ -1863,20 +1865,20 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
|
|||
| atarist | Atari ST [also STE and Falcon] | Hatari | | | |
|
||||
| atarixe | Atari XE | Atari800 | | | |
|
||||
| atomiswave | Atomiswave | Flycast | | | |
|
||||
| bbcmicro | BBC Micro | | | | |
|
||||
| bbcmicro | BBC Micro | _Placeholder_ | | | |
|
||||
| c64 | Commodore 64 | VICE x64sc Accurate | VICE x64 Fast,<br>VICE x64 SuperCPU,<br>VICE x128,<br>Frodo | No | Single disk, tape or cartridge image in root folder and/or multi-disc images in separate folder |
|
||||
| cavestory | Cave Story (NXEngine) | NXEngine | | | |
|
||||
| cdimono1 | Philips CD-i | | | | |
|
||||
| cdtv | Commodore CDTV | | | | |
|
||||
| chailove | ChaiLove game engine | ChaiLove | | | |
|
||||
| cdimono1 | Philips CD-i | _Placeholder_ | | | |
|
||||
| cdtv | Commodore CDTV | _Placeholder_ | | | |
|
||||
| chailove | ChaiLove Game Engine | ChaiLove | | | |
|
||||
| channelf | Fairchild Channel F | FreeChaF | | | |
|
||||
| coco | Tandy Color Computer | | | | |
|
||||
| coco | Tandy Color Computer | _Placeholder_ | | | |
|
||||
| colecovision | ColecoVision | blueMSX | | | |
|
||||
| daphne | Daphne Arcade Laserdisc Emulator | | | | |
|
||||
| desktop | Desktop applications | N/A | | No | |
|
||||
| daphne | Daphne Arcade LaserDisc Emulator | _Placeholder_ | | | |
|
||||
| desktop | Desktop Applications | N/A | | No | |
|
||||
| doom | Doom | PrBoom | | | |
|
||||
| dos | DOS (PC) | DOSBox-Core | DOSBox-Pure,<br>DOSBox-SVN,<br>DOSBox Staging **(Standalone)** [U] | No | In separate folder (one folder per game, with complete file structure retained) |
|
||||
| dragon32 | Dragon 32 | | | | |
|
||||
| dragon32 | Dragon 32 | _Placeholder_ | | | |
|
||||
| dreamcast | Sega Dreamcast | Flycast | | | |
|
||||
| epic | Epic Games Store | Epic Games Store application **(Standalone)** | | No | Shell script/batch file in root folder |
|
||||
| famicom | Nintendo Family Computer | Nestopia UE | FCEUmm,<br>Mesen,<br>QuickNES | No | Single archive or ROM file in root folder |
|
||||
|
|
@ -1890,23 +1892,23 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
|
|||
| gbc | Nintendo Game Boy Color | SameBoy | Gambatte,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes | | |
|
||||
| gc | Nintendo GameCube | Dolphin | | | |
|
||||
| genesis | Sega Genesis | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive,<br>BlastEm | No | Single archive or ROM file in root folder |
|
||||
| gx4000 | Amstrad GX4000 | | | | |
|
||||
| gx4000 | Amstrad GX4000 | _Placeholder_ | | | |
|
||||
| intellivision | Mattel Electronics Intellivision | FreeIntv | | | |
|
||||
| j2me | Java 2 Micro Edition (J2ME) | SquirrelJME | | Yes | Single JAR file in root folder |
|
||||
| kodi | Kodi home theatre software | N/A | | No | |
|
||||
| lutris | Lutris open gaming platform | Lutris application **(Standalone)** [U] | | No | Shell script in root folder |
|
||||
| lutro | Lutro game engine | Lutro | | | |
|
||||
| macintosh | Apple Macintosh | | | | |
|
||||
| kodi | Kodi Home Theatre Software | N/A | | No | |
|
||||
| lutris | Lutris Open Gaming Platform | Lutris application **(Standalone)** [U] | | No | Shell script in root folder |
|
||||
| lutro | Lutro Game Engine | Lutro | | | |
|
||||
| macintosh | Apple Macintosh | _Placeholder_ | | | |
|
||||
| mame | Multiple Arcade Machine Emulator | MAME 2003-Plus | MAME 2000,<br>MAME 2010,<br>MAME - Current,<br>FinalBurn Neo,<br>FB Alpha 2012 | Depends | Single archive file following MAME name standard in root folder |
|
||||
| mame-advmame | AdvanceMAME | | | Depends | Single archive file following MAME name standard in root folder |
|
||||
| mame-mame4all | MAME4ALL | | | Depends | Single archive file following MAME name standard in root folder |
|
||||
| mame-advmame | AdvanceMAME | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder |
|
||||
| mame-mame4all | MAME4ALL | _Placeholder_ | | Depends | Single archive file following MAME name standard in root folder |
|
||||
| mastersystem | Sega Master System | Genesis Plus GX | Genesis Plus GX Wide,<br>SMS Plus GX,<br>Gearsystem,<br>PicoDrive | No | Single archive or ROM file in root folder |
|
||||
| megacd | Sega Mega-CD | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive | | |
|
||||
| megacdjp | Sega Mega-CD [Japan] | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive | | |
|
||||
| megadrive | Sega Mega Drive | Genesis Plus GX | Genesis Plus GX Wide,<br>PicoDrive,<br>BlastEm | No | Single archive or ROM file in root folder |
|
||||
| mess | Multi Emulator Super System | MESS 2015 | | | |
|
||||
| moonlight | Moonlight game streaming | | | | |
|
||||
| moto | Thomson MO/TO series | Theodore | | | |
|
||||
| moonlight | Moonlight Game Streaming | _Placeholder_ | | | |
|
||||
| moto | Thomson MO/TO Series | Theodore | | | |
|
||||
| msx | MSX | blueMSX | fMSX | | |
|
||||
| msx1 | MSX1 | blueMSX | fMSX | | |
|
||||
| msx2 | MSX2 | blueMSX | fMSX | | |
|
||||
|
|
@ -1924,29 +1926,29 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
|
|||
| ngp | SNK Neo Geo Pocket | Beetle NeoPop | RACE | | |
|
||||
| ngpc | SNK Neo Geo Pocket Color | Beetle NeoPop | RACE | | |
|
||||
| odyssey2 | Magnavox Odyssey2 | O2EM | | | |
|
||||
| openbor | OpenBOR game engine | | | | |
|
||||
| oric | Tangerine Computer Systems Oric | | | | |
|
||||
| openbor | OpenBOR Game Engine | _Placeholder_ | | | |
|
||||
| oric | Tangerine Computer Systems Oric | _Placeholder_ | | | |
|
||||
| palm | Palm OS | Mu | | | |
|
||||
| pc | IBM PC | DOSBox-Core | DOSBox-Pure,<br>DOSBox-SVN,<br>DOSBox Staging **(Standalone)** [U] | No | In separate folder (one folder per game, with complete file structure retained) |
|
||||
| pc88 | NEC PC-8800 series | QUASI88 | | | |
|
||||
| pc98 | NEC PC-9800 series | Neko Project II Kai | Neko Project II | | |
|
||||
| pc88 | NEC PC-8800 Series | QUASI88 | | | |
|
||||
| pc98 | NEC PC-9800 Series | Neko Project II Kai | Neko Project II | | |
|
||||
| pcengine | NEC PC Engine | Beetle PCE | Beetle PCE FAST | No | Single archive or ROM file in root folder |
|
||||
| pcenginecd | NEC PC Engine CD | Beetle PCE | Beetle PCE FAST | Yes | |
|
||||
| pcfx | NEC PC-FX | Beetle PC-FX | | | |
|
||||
| pokemini | Nintendo Pokémon Mini | PokeMini | | No | |
|
||||
| ports | Ports | N/A | | No | Shell/batch script in separate folder (possibly combined with game data) |
|
||||
| ps2 | Sony PlayStation 2 | PCSX2 [UW] | | | |
|
||||
| ps3 | Sony PlayStation 3 | | | | |
|
||||
| ps4 | Sony PlayStation 4 | | | | |
|
||||
| ps3 | Sony PlayStation 3 | _Placeholder_ | | | |
|
||||
| ps4 | Sony PlayStation 4 | _Placeholder_ | | | |
|
||||
| psp | Sony PlayStation Portable | PPSSPP | | | |
|
||||
| psvita | Sony PlayStation Vita | | | | |
|
||||
| psvita | Sony PlayStation Vita | _Placeholder_ | | | |
|
||||
| psx | Sony PlayStation | Beetle PSX | Beetle PSX HW,<br>PCSX ReARMed,<br>DuckStation | Yes | .chd file in root folder for single-disc games, .m3u playlist in root folder for multi-disc games |
|
||||
| residualvm | ResidualVM game engine | | | | |
|
||||
| residualvm | ResidualVM Game Engine | _Placeholder_ | | | |
|
||||
| samcoupe | SAM Coupé | SimCoupe | | | |
|
||||
| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-mercury Accuracy,<br>Mesen-S | | |
|
||||
| saturn | Sega Saturn | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause | | |
|
||||
| saturnjp | Sega Saturn [Japan] | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause | | |
|
||||
| scummvm | ScummVM game engine | ScummVM | | No | In separate folder (one folder per game, with complete file structure retained) |
|
||||
| scummvm | ScummVM Game Engine | ScummVM | | No | In separate folder (one folder per game, with complete file structure retained) |
|
||||
| sega32x | Sega Mega Drive 32X | PicoDrive | | No | Single archive or ROM file in root folder |
|
||||
| sega32xjp | Sega Super 32X [Japan] | PicoDrive | | No | Single archive or ROM file in root folder |
|
||||
| sega32xna | Sega Genesis 32X [North America] | PicoDrive | | No | Single archive or ROM file in root folder |
|
||||
|
|
@ -1954,34 +1956,34 @@ All emulators are RetroArch cores unless marked as **(Standalone**)
|
|||
| sg-1000 | Sega SG-1000 | Gearsystem | Genesis Plus GX,<br>Genesis Plus GX Wide,<br>blueMSX | | |
|
||||
| snes | Nintendo SNES (Super Nintendo) | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-mercury Accuracy,<br>Beetle Supafaust [UW],<br>Mesen-S | No | Single archive or ROM file in root folder |
|
||||
| snesna | Nintendo SNES (Super Nintendo) [North America] | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-mercury Accuracy,<br>Beetle Supafaust [UW],<br>Mesen-S | No | Single archive or ROM file in root folder |
|
||||
| solarus | Solarus game engine | | | | |
|
||||
| solarus | Solarus Game Engine | _Placeholder_ | | | |
|
||||
| spectravideo | Spectravideo | blueMSX | | | |
|
||||
| steam | Valve Steam | Steam application **(Standalone)** | | No | Shell script/batch file in root folder |
|
||||
| stratagus | Stratagus game engine | | | | |
|
||||
| stratagus | Stratagus Game Engine | _Placeholder_ | | | |
|
||||
| sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,<br>bsnes,<br>bsnes-mercury Accuracy | | |
|
||||
| supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE | | |
|
||||
| switch | Nintendo Switch | Yuzu **(Standalone)** [UW] | | Yes | |
|
||||
| symbian | Symbian | | | | |
|
||||
| tanodragon | Tano Dragon | | | | |
|
||||
| symbian | Symbian | _Placeholder_ | | | |
|
||||
| tanodragon | Tano Dragon | _Placeholder_ | | | |
|
||||
| tg16 | NEC TurboGrafx-16 | Beetle PCE | Beetle PCE FAST | No | Single archive or ROM file in root folder |
|
||||
| tg-cd | NEC TurboGrafx-CD | Beetle PCE | Beetle PCE FAST | Yes | |
|
||||
| ti99 | Texas Instruments TI-99 | | | | |
|
||||
| tic80 | TIC-80 game engine | | | | |
|
||||
| ti99 | Texas Instruments TI-99 | _Placeholder_ | | | |
|
||||
| tic80 | TIC-80 Game Engine | _Placeholder_ | | | |
|
||||
| to8 | Thomson TO8 | Theodore | | | |
|
||||
| trs-80 | Tandy TRS-80 | | | | |
|
||||
| trs-80 | Tandy TRS-80 | _Placeholder_ | | | |
|
||||
| uzebox | Uzebox | Uzem | | | |
|
||||
| vectrex | Vectrex | vecx | | | |
|
||||
| vic20 | Commodore VIC-20 | VICE xvic | | | Single disk, tape or cartridge image in root folder |
|
||||
| videopac | Philips Videopac G7000 | O2EM | | | |
|
||||
| virtualboy | Nintendo Virtual Boy | Beetle VB | | | |
|
||||
| wii | Nintendo Wii | Dolphin | | | |
|
||||
| wiiu | Nintendo Wii U | | | | |
|
||||
| wiiu | Nintendo Wii U | _Placeholder_ | | | |
|
||||
| wonderswan | Bandai WonderSwan | Beetle Cygne | | | |
|
||||
| wonderswancolor | Bandai WonderSwan Color | Beetle Cygne | | | |
|
||||
| x1 | Sharp X1 | x1 | | | Single archive or ROM file in root folder |
|
||||
| x68000 | Sharp X68000 | PX68k | | | |
|
||||
| xbox | Microsoft Xbox | | | | |
|
||||
| xbox360 | Microsoft Xbox 360 | | | | |
|
||||
| zmachine | Infocom Z-machine | | | | |
|
||||
| xbox | Microsoft Xbox | _Placeholder_ | | | |
|
||||
| xbox360 | Microsoft Xbox 360 | _Placeholder_ | | | |
|
||||
| zmachine | Infocom Z-machine | _Placeholder_ | | | |
|
||||
| zx81 | Sinclair ZX81 | EightyOne | | | |
|
||||
| zxspectrum | Sinclair ZX Spectrum | Fuse | | | |
|
||||
|
|
|
|||
Loading…
Reference in a new issue