mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-24 23:25:38 +00:00
Documentation update.
This commit is contained in:
Leon Styhre
parent
996f79134b
commit
6f8be7c6d3
|
|
@ -161,6 +161,9 @@ v1.2 maintenance release.
|
|||
* Added support for the PICO-8 (pico8) game system
|
||||
* Added support for the Capcom Play System (cps) game system
|
||||
* Added support for the Sega Model 2 and 3 (model2 and model3) game systems on Windows
|
||||
* Added configuration for the Tangerine Computer Systems Oric (oric) system on Unix and Windows
|
||||
* Added configuration for the Texas Instruments TI-99 (ti99) system on Unix and Windows
|
||||
* Added configuration for the Google Android (android) system on Windows
|
||||
* Added support for asterisks/wildcards for emulator name matching, usable both in es_find_rules.xml and es_systems.xml
|
||||
* (Linux) Changed to find rule wildcard matching for the AppImages for Dolphin, mGBA, Play!, RPCS3, Xemu and Yuzu
|
||||
* Added a ScreenScraper option to fallback to additional regions to allow scraping of country-specific games and unofficial releases
|
||||
|
|
@ -188,6 +191,7 @@ v1.2 maintenance release.
|
|||
* When entering the text edit field for the virtual keyboard, a navigation key repeat would sometimes continue to run
|
||||
* The menu scroll indicators and title sometimes overlapped (e.g. seen in the Alternative emulators interface)
|
||||
* There was a small rounding error that caused a minimal distortion when rendering menu titles
|
||||
* (macOS) The platform tag was missing for the NEC TurboGrafx-CD (tg-cd) system, leading to inaccurate scraping
|
||||
|
||||
## Version 1.2.4
|
||||
|
||||
|
|
|
|||
|
|
@ -213,7 +213,7 @@ For very specific situations such as when the ROM directory tree is shared with
|
|||
~/ROMs/nes/noload.txt
|
||||
```
|
||||
|
||||
Note that if the setting _Only show ROMs from gamelist.xml files_ has been enabled then this logic is completely bypassed as this option will make ES-DE load anything present in the gamelist.xml files, regardless of whether the files and directories actually exist. But this option (or the equivalent --gamelist-only command line option) is only intended for troubleshooting and debugging purposes and should not be enabled during normal application usage.
|
||||
Note that if the setting _Only show ROMs from gamelist.xml files_ has been enabled then the noload.txt logic is completely bypassed as this option will make ES-DE load anything present in the gamelist.xml files, regardless of whether the files and directories actually exist. But this option (or the equivalent --gamelist-only command line option) is only intended for troubleshooting and debugging purposes and should not be enabled during normal application usage.
|
||||
|
||||
## Placing games and other resources on network shares
|
||||
|
||||
|
|
@ -630,6 +630,7 @@ The following manually downloaded emulators are supported when using the bundled
|
|||
| :----------- | :------------ | :------------------------------ |
|
||||
| daphne | Hypseus Singe | hypseus-singe/hypseus.bin |
|
||||
| dreamcast | Redream | redream/redream |
|
||||
| oric | Oricutron | oricutron/Oricutron |
|
||||
| pico8 | PICO-8 | pico-8/pico8 |
|
||||
| switch | Ryujinx | publish/Ryujinx |
|
||||
|
||||
|
|
@ -844,19 +845,6 @@ Dir1=..\..\ROMs\arcade\Sega Model 2
|
|||
|
||||
The EMULATOR.INI file is found in the _Model 2 Emulator_ installation directory.
|
||||
|
||||
#### Vintage systems emulated using MAME
|
||||
|
||||
**Bally Astrocade:**
|
||||
|
||||
Place the ROMs in the astrocde directory, the files must have the short MAME names such as _astrobat.zip_ and _conan.zip_. If using MAME standalone then no further setup is required and the games should just launch. But if using the _MAME - Current_ RetroArch core, then a hash file must be added inside the RetroArch system directory at this location:
|
||||
|
||||
```
|
||||
mame/hash/astrocde.xml
|
||||
```
|
||||
|
||||
The hash file is available from the MAME GitHub repository: \
|
||||
https://raw.githubusercontent.com/mamedev/mame/master/hash/astrocde.xml
|
||||
|
||||
#### Nintendo Switch
|
||||
|
||||
The Nintendo Switch emulator Yuzu is distributed as a Snap package, Flatpak package or AppImage on Linux and as a regular installer on Windows. At the moment there is unfortunately no macOS release of this emulator and it's unclear if it can run on BSD Unix.
|
||||
|
|
@ -1381,6 +1369,52 @@ This is what the complete setup could look like:
|
|||
~/ROMs/pico8/xzero-3.p8.png
|
||||
```
|
||||
|
||||
#### Tangerine Computer Systems Oric
|
||||
|
||||
These games are executed using the Oricutron emulator which is readily available on Windows but quite problematic to get hold on for Unix and macOS.
|
||||
|
||||
Although there is a macOS build available at the Oricutron [download page](http://www.petergordon.org.uk/oricutron/) this seems to not work properly, or it's unclear how it should be used. As such this system is unsupported on macOS, but the configuration entries still exist in the bundled es_find_rules.xml and es_systems.xml files so if you manage to get the emulator to run, ES-DE should work with these games.
|
||||
|
||||
Likewise on Unix there seems to be no binaries available for download so you need to build the emulator yourself. As multiple files like images and roms are needed to run this emulator, it's easiest to download and extract the Windows version which contains all this data and then build from source code and simply copy over the `Oricutron` binary (example below using Ubuntu):
|
||||
|
||||
```
|
||||
mkdir -p ~/Applications/oricutron
|
||||
cp Oricutron_win32_v12.zip ~/Applications/oricutron
|
||||
cd ~/Applications/oricutron
|
||||
unzip Oricutron_win32_v12.zip
|
||||
sudo apt install libgtk-3-dev libsdl1.2-dev
|
||||
git clone https://github.com/pete-gordon/oricutron.git
|
||||
cd oricutron
|
||||
cmake .
|
||||
make -j
|
||||
cp Oricutron ..
|
||||
```
|
||||
|
||||
Once the emulator is up and running there is not really much else to consider, simply drop the games into the ~/ROMs/oric directory and launch them.
|
||||
|
||||
#### Bally Astrocade
|
||||
|
||||
Place the ROMs in the astrocde directory, the files must have the short MAME names such as _astrobat.zip_ and _conan.zip_. If using MAME standalone then no further setup is required and the games should just launch. But if using the _MAME - Current_ RetroArch core, then a hash file must be added inside the RetroArch system directory at this location:
|
||||
|
||||
```
|
||||
mame/hash/astrocde.xml
|
||||
```
|
||||
|
||||
The hash file is available from the MAME GitHub repository: \
|
||||
https://raw.githubusercontent.com/mamedev/mame/master/hash/astrocde.xml
|
||||
|
||||
#### Texas Instruments TI-99
|
||||
|
||||
The TI-99 is emulated via MAME, and only the standalone release of this emulator is supported. Unfortunately it seems as if the Homebrew build on macOS is broken as no TI-99 games can be launched. As such this system is unsupported on macOS, but the configuration entries still exist in the bundled es_find_rules.xml and es_systems.xml files so if you manage to get the emulator to run, ES-DE should work with these games.
|
||||
|
||||
Emulating the TI-99 can be quite confusing as games are available in various incompatible formats, and most emulators are particular when it comes to what file types they support. In ES-DE only cartridge-based games are supported, so you can't for instance play games distributed as floppy disk images. And only games packaged for MAME using the MAME short name standard can be used. This includes .7z and .zip files as well as .rpk cartridge images. It's strongly recommended to go for the MAME TI-99 ROM set that consists only of .zip files as these have the highest chance of working correctly.
|
||||
|
||||
In addition to the game files you need the `ti99_4a.zip` archive which contains the TI-99 system ROMs. This file has to be placed in the root of the ~/ROMs/ti99 directory.
|
||||
|
||||
Note that you may also need to reconfigure your exit key in MAME as the default _escape_ key is masked by the emulator as it's used by the emulated TI-99 computer.
|
||||
|
||||
Scraping can also be a bit challenging as MAME short names are used and neither ScreenScraper nor TheGamesDB can parse these names. So it's recommended to run the scraper in interactive mode and refine the searches for all games that are not properly identified.
|
||||
|
||||
## Scraping
|
||||
|
||||
Scraping means downloading metadata and game media files (images and videos) for the games in your collection.
|
||||
|
|
@ -2520,16 +2554,16 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| 3do | 3DO | Opera | | Yes | |
|
||||
| 64dd | Nintendo 64DD | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | ParaLLEl N64 [UW],<br>Mupen64Plus **(Standalone)** [UMW*],<br>sixtyforce **(Standalone)** [M] | | |
|
||||
| ags | Adventure Game Studio Game Engine | _Placeholder_ | | | |
|
||||
| amiga | Commodore Amiga | PUAE | PUAE 2021 | 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 | PUAE 2021 | 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 | PUAE 2021 | 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 |
|
||||
| amiga | Commodore Amiga | 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 |
|
||||
| amiga1200 | Commodore Amiga 1200 | PUAE | PUAE 2021 | Yes | See the specific _Commodore Amiga_ section elsewhere in this guide |
|
||||
| amigacd32 | Commodore Amiga CD32 | PUAE | PUAE 2021 | Yes | |
|
||||
| amstradcpc | Amstrad CPC | Caprice32 | CrocoDS | | |
|
||||
| android | Google Android | _Placeholder_ | | | |
|
||||
| android | Google Android | BlueStacks **(Standalone)** [W] | | No | Shortcut (.lnk) file in root folder |
|
||||
| apple2 | Apple II | _Placeholder_ | | | |
|
||||
| apple2gs | Apple IIGS | _Placeholder_ | | | |
|
||||
| arcade | Arcade | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FB Alpha 2012,<br>Flycast,<br>Flycast **(Standalone)** [UMW*],<br>Model 2 Emulator **(Standalone)** [W*],<br>Supermodel **(Standalone)** [W*] | Depends | Single archive file following MAME name standard in root folder |
|
||||
| astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** [UMW*] | | Single archive in root folder |
|
||||
| astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** [UMW*] | | See the specific _Bally Astrocade_ section elsewhere in this guide |
|
||||
| atari2600 | Atari 2600 | Stella | Stella 2014 | No | Single archive or ROM file in root folder |
|
||||
| atari5200 | Atari 5200 | a5200 | Atari800 | Yes | |
|
||||
| atari7800 | Atari 7800 ProSystem | ProSystem | | Yes | |
|
||||
|
|
@ -2551,9 +2585,9 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| colecovision | ColecoVision | blueMSX | Gearcoleco | | |
|
||||
| cps | Capcom Play System | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FB Alpha 2012,<br>FB Alpha 2012 CPS-1,<br>FB Alpha 2012 CPS-2,<br>FB Alpha 2012 CPS-3 | Depends | Single archive file following MAME name standard in root folder |
|
||||
| daphne | Daphne Arcade LaserDisc Emulator | Hypseus [Daphne] **(Standalone)** [UW*] | Hypseus [Singe] **(Standalone)** [UW*] | Yes (Daphne games) | See the specific _Hypseus Singe (Daphne)_ section elsewhere in this guide |
|
||||
| desktop | Desktop Applications | _Suspend ES-DE_ | _Keep ES-DE running_ | | Shortcut or script/batch file in root folder |
|
||||
| desktop | Desktop Applications | _Suspend ES-DE_ | _Keep ES-DE running_ | | See the specific _Ports and desktop applications_ section elsewhere in this guide |
|
||||
| doom | Doom | PrBoom | | | |
|
||||
| dos | DOS (PC) | DOSBox-Pure | DOSBox-Core,<br>DOSBox-SVN,<br>DOSBox-X **(Standalone)**,<br>DOSBox Staging **(Standalone)** [UMW*] | No | In separate folder (one folder per game with complete file structure retained) |
|
||||
| dos | DOS (PC) | DOSBox-Pure | DOSBox-Core,<br>DOSBox-SVN,<br>DOSBox-X **(Standalone)**,<br>DOSBox Staging **(Standalone)** [UMW*] | No | See the specific _DOS / PC_ section elsewhere in this guide |
|
||||
| dragon32 | Dragon 32 | _Placeholder_ | | | |
|
||||
| dreamcast | Sega Dreamcast | Flycast | Flycast **(Standalone)** [UMW*],<br>Redream **(Standalone)** [UMW*] | No | In separate folder |
|
||||
| epic | Epic Games Store | Epic Games Store application **(Standalone)** | | No | Shortcut in root folder |
|
||||
|
|
@ -2572,7 +2606,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| 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 | Shortcut in root folder |
|
||||
| lutris | Lutris Open Gaming Platform | Lutris application **(Standalone)** [U] | | No | Shell script in root folder |
|
||||
| lutris | Lutris Open Gaming Platform | Lutris application **(Standalone)** [U] | | No | See the specific _Lutris_ section elsewhere in this guide |
|
||||
| lutro | Lutro Game Engine | Lutro | | | |
|
||||
| macintosh | Apple Macintosh | _Placeholder_ | | | |
|
||||
| mame | Multiple Arcade Machine Emulator | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)** [UMW*],<br>FinalBurn Neo,<br>FB Alpha 2012,<br>Flycast,<br>Flycast **(Standalone)** [UMW*],<br>Model 2 Emulator **(Standalone)** [W*],<br>Supermodel **(Standalone)** [W*] | Depends | Single archive file following MAME name standard in root folder |
|
||||
|
|
@ -2605,9 +2639,9 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| ngpc | SNK Neo Geo Pocket Color | Beetle NeoPop | RACE | | |
|
||||
| odyssey2 | Magnavox Odyssey2 | O2EM | | | |
|
||||
| openbor | OpenBOR Game Engine | OpenBOR **(Standalone)** [UW] | | | See the specific _OpenBOR_ section elsewhere in this guide |
|
||||
| oric | Tangerine Computer Systems Oric | _Placeholder_ | | | |
|
||||
| oric | Tangerine Computer Systems Oric | Oricutron **(Standalone)** [UW*] | | | See the specific _Tangerine Computer Systems Oric_ section elsewhere in this guide |
|
||||
| palm | Palm OS | Mu | | | |
|
||||
| pc | IBM PC | DOSBox-Pure | DOSBox-Core,<br>DOSBox-SVN,<br>DOSBox-X **(Standalone)**,<br>DOSBox Staging **(Standalone)** [UMW*] | No | In separate folder (one folder per game with complete file structure retained) |
|
||||
| pc | IBM PC | DOSBox-Pure | DOSBox-Core,<br>DOSBox-SVN,<br>DOSBox-X **(Standalone)**,<br>DOSBox Staging **(Standalone)** [UMW*] | No | See the specific _DOS / PC_ section elsewhere in this guide |
|
||||
| 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 |
|
||||
|
|
@ -2615,7 +2649,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| pcfx | NEC PC-FX | Beetle PC-FX | | | |
|
||||
| pico8 | PICO-8 Fantasy Console | PICO-8 **(Standalone)** | PICO-8 Splore **(Standalone)** | No | See the specific _PICO-8_ section elsewhere in this guide |
|
||||
| pokemini | Nintendo Pokémon Mini | PokeMini | | No | |
|
||||
| ports | Ports | N/A | | No | Shortcut in root folder or shell/batch script in separate folder (possibly combined with game data) |
|
||||
| ports | Ports | _Various_ | | No | See the specific _Ports and desktop applications_ section elsewhere in this guide |
|
||||
| ps2 | Sony PlayStation 2 | PCSX2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 **(Standalone)** [UW],<br>PCSX2 Qt **(Standalone)** [W*],<br>PCSX2 wxWidgets **(Standalone)** [W*],<br>Play! **(Standalone)** [UMW*],<br>AetherSX2 **(Standalone)** [M] | Yes (No for Play!) | |
|
||||
| ps3 | Sony PlayStation 3 | RPCS3 Shortcut **(Standalone)** [UMW*] | RPCS3 Directory **(Standalone)** [UMW*] | Yes | See the specific _Sony PlayStation 3_ section elsewhere in this guide |
|
||||
| ps4 | Sony PlayStation 4 | _Placeholder_ | | | |
|
||||
|
|
@ -2626,7 +2660,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)** [UMW*],<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>bsnes **(Standalone)** [UW*],<br>Mesen-S | | |
|
||||
| saturn | Sega Saturn | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause | 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 | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game |
|
||||
| scummvm | ScummVM Game Engine | ScummVM | | No | In separate folder (one folder per game with complete file structure retained) and with a .scummvm file for launching the game |
|
||||
| scummvm | ScummVM Game Engine | ScummVM | | No | See the specific _ScummVM_ section elsewhere in this guide |
|
||||
| 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 |
|
||||
|
|
@ -2637,7 +2671,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| snesna | Nintendo SNES (Super Nintendo) [North America] | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)** [UMW*],<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>bsnes **(Standalone)** [UW*],<br>Beetle Supafaust [UW],<br>Mesen-S | No | Single archive or ROM file in root folder |
|
||||
| solarus | Solarus Game Engine | _Placeholder_ | | | |
|
||||
| spectravideo | Spectravideo | blueMSX | | | |
|
||||
| steam | Valve Steam | Steam application **(Standalone)** | | No | Shortcut in root folder |
|
||||
| steam | Valve Steam | Steam application **(Standalone)** | | No | See the specific _Steam_ section elsewhere in this guide |
|
||||
| stratagus | Stratagus Game Engine | _Placeholder_ | | | |
|
||||
| sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)** [UMW*],<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>bsnes **(Standalone)** [UW*] | | |
|
||||
| supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE | | |
|
||||
|
|
@ -2646,7 +2680,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| 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 | _Placeholder_ | | | |
|
||||
| ti99 | Texas Instruments TI-99 | MAME **(Standalone)** [UW*] | | Yes | See the specific _Texas Instruments TI-99_ section elsewhere in this guide |
|
||||
| tic80 | TIC-80 Game Engine | _Placeholder_ | | | |
|
||||
| to8 | Thomson TO8 | Theodore | | | |
|
||||
| trs-80 | Tandy TRS-80 | _Placeholder_ | | | |
|
||||
|
|
@ -2656,7 +2690,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| videopac | Philips Videopac G7000 | O2EM | | | |
|
||||
| virtualboy | Nintendo Virtual Boy | Beetle VB | | | |
|
||||
| wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)** [UMW*],<br>PrimeHack **(Standalone)** [U] | | |
|
||||
| wiiu | Nintendo Wii U | Cemu **(Standalone)** [W*] | | No | In separate folder |
|
||||
| wiiu | Nintendo Wii U | Cemu **(Standalone)** [W*] | | No | See the specific _Nintendo Wii U_ section elsewhere in this guide |
|
||||
| wonderswan | Bandai WonderSwan | Beetle Cygne | | No | |
|
||||
| wonderswancolor | Bandai WonderSwan Color | Beetle Cygne | | No | |
|
||||
| x1 | Sharp X1 | x1 | | | Single archive or ROM file in root folder |
|
||||
|
|
|
|||
Loading…
Reference in a new issue