mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-28 09:05:38 +00:00
Documentation update.
This commit is contained in:
Leon Styhre
parent
7097c44004
commit
b19f1657be
16
CHANGELOG.md
16
CHANGELOG.md
|
|
@ -148,7 +148,7 @@
|
|||
|
||||
### Release overview
|
||||
|
||||
v1.2 maintenance release.
|
||||
v1.2 maintenance release. Shortcut support has been added on Unix and macOS which greatly simplifies setup of applications as well as games for platforms like ports, steam, lutris and ps3. A couple of new systems have been added, most notably PICO-8, and RetroPie EmulationStation theme compatibility has been improved. As well the default keyboard quit shortcut has been changed from F4 to the operating system defaults (Alt + F4 on Unix and Windows and Command + Q on macOS). Some bugs were also fixed and some missing graphic assets were added to the default rbsimple-DE theme set.
|
||||
|
||||
### Detailed list of changes
|
||||
|
||||
|
|
@ -164,8 +164,11 @@ v1.2 maintenance release.
|
|||
* 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
|
||||
* (Windows) Changed the emulator directory for Model 2 Emulator from Model2 to m2emulator
|
||||
* (Windows) Changed the emulator find rule name for the Model 2 Emulator from MODEL2 to M2EMULATOR
|
||||
* Added support for asterisks/wildcards for emulator name matching, usable in both 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
|
||||
* (Windows) Changed to find rule wildcard matching for the PCSX2-QT and PCSX2-WXWIDGETS entries to support the AVX2 releases of PCSX2
|
||||
* Added a ScreenScraper option to fall back to additional regions to allow scraping of country-specific games and unofficial releases
|
||||
* Changed the sorting in the Alternative emulators interface to use short system names instead of full system names
|
||||
* Added scraper support for the ti99 platform
|
||||
|
|
@ -181,13 +184,16 @@ v1.2 maintenance release.
|
|||
* Added size restrictions to the "size" and "maxSize" theme properties for the image and video elements
|
||||
* Changed to a new API key for TheGamesDB
|
||||
* (Linux) Changed the manually downloaded Redream emulator location from ~/Applications/redream to ~/Applications/redream/redream
|
||||
* (rbsimple-DE) Added console and controller graphics for the wiiu system
|
||||
* (rbsimple-DE) Added controller graphics for the saturn, saturnjp and xbox systems
|
||||
* (modern-DE) Replaced the carousel image for the desktop system
|
||||
|
||||
### Bug fixes
|
||||
|
||||
* When running ES-DE in the background, quitting a game or application using Alt + F4 sometimes made ES-DE quit as well
|
||||
* Thumbnails were not included in theme sets that used them for the Detailed view style
|
||||
* Game images were not included in theme sets that used them for the Video view style
|
||||
* Themes with large pixelated fonts sometimes displayed too many textlist rows
|
||||
* Thumbnails were not included in theme sets that used them for the Detailed view style (affected RetroPie ES compatibility)
|
||||
* Game images were not included in theme sets that used them for the Video view style (affected RetroPie ES compatibility)
|
||||
* Themes with large pixelated fonts sometimes displayed too many textlist rows (affected RetroPie ES compatibility)
|
||||
* 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
|
||||
|
|
|
|||
|
|
@ -1267,7 +1267,7 @@ The following variables are expanded for the `command` tag:
|
|||
|
||||
`%ESCAPESPECIALS%` - This variable is only available on Windows and is used to escape the characters &()^=;, for the %ROM% variable, which would otherwise make binaries like cmd.exe fail when launching scripts or links. The variable can be placed anywhere in the launch command.
|
||||
|
||||
`%ENABLESHORTCUTS%` - This variable is only available on Unix and macOS and is used to enable shortcuts to games and applications. On Unix these come in the form of .desktop files and ES-DE has a simple parser which essentially extracts the command defined in the Exec key and then executes it. Although some basic file structure checks are performed, the actual command listed with the Exec key is blindly executed. In addition to this the variables %F, %f, %U and %u are removed from the Exec key entry. On macOS shortcuts in the form of .app directories and alias files are executed using the `open -a` command. This makes it possible to launch both shortcuts from emulators and applications like Steam as well as aliases for any applications. However the latter need to be renamed to the .app file extension or it won't work. When a file is matching the .desktop or .app extension respectively, the emulator command defined using the %EMULATOR% variable will be stripped. An %EMULATOR% entry is however still required for the %ENABLESHORTCUTS% variable to work, the intention is to combine shortcuts with the ability to launch shell scripts without having to setup alternative emulators. The %ROM% variable is expanded to the command to execute when using %ENABLESHORTCUTS%, which also means that this variable has to be used, and for example %ROMRAW% will not work.
|
||||
`%ENABLESHORTCUTS%` - This variable is only available on Unix and macOS and is used to enable shortcuts to games and applications. On Unix these come in the form of .desktop files and ES-DE has a simple parser which essentially extracts the command defined in the Exec key and then executes it. Although some basic file structure checks are performed, the actual command listed with the Exec key is blindly executed. In addition to this the variables %F, %f, %U and %u are removed from the Exec key entry. On macOS shortcuts in the form of .app directories and alias files are executed using the `open -W -a` command. This makes it possible to launch shortcuts to emulators and applications like Steam as well as aliases for any application. However the latter need to be renamed to the .app file extension or it won't work. When a file is matching the .desktop or .app extension respectively, the emulator command defined using the %EMULATOR% variable will be stripped. An %EMULATOR% entry is however still required for the %ENABLESHORTCUTS% variable to work as the intention is to combine shortcuts with the ability to launch shell scripts without having to setup alternative emulators. The %ROM% variable is expanded to the command to execute when using %ENABLESHORTCUTS%, which also means that this variable has to be used, and for example %ROMRAW% will not work.
|
||||
|
||||
Here are some additional real world examples of system entries, the first one for Unix:
|
||||
|
||||
|
|
@ -1566,10 +1566,10 @@ For reference, here are also example es_find_rules.xml files for macOS and Windo
|
|||
<entry>C:\Program Files\Steam\steamapps\common\RetroArch\retroarch.exe</entry>
|
||||
<entry>D:\Program Files\Steam\steamapps\common\RetroArch\retroarch.exe</entry>
|
||||
<!-- Portable installation -->
|
||||
<entry>%ESPATH%\RetroArch-Win64\retroarch.exe</entry>
|
||||
<entry>%ESPATH%\RetroArch\retroarch.exe</entry>
|
||||
<entry>%ESPATH%\Emulators\RetroArch-Win64\retroarch.exe</entry>
|
||||
<entry>%ESPATH%\Emulators\RetroArch\retroarch.exe</entry>
|
||||
<entry>%ESPATH%\RetroArch-Win64\retroarch.exe</entry>
|
||||
<entry>%ESPATH%\RetroArch\retroarch.exe</entry>
|
||||
<entry>%ESPATH%\..\RetroArch-Win64\retroarch.exe</entry>
|
||||
<entry>%ESPATH%\..\RetroArch\retroarch.exe</entry>
|
||||
</rule>
|
||||
|
|
@ -1590,8 +1590,8 @@ For reference, here are also example es_find_rules.xml files for macOS and Windo
|
|||
<rule type="staticpath">
|
||||
<entry>C:\Program Files (x86)\PCSX2\pcsx2.exe</entry>
|
||||
<entry>D:\Program Files (x86)\PCSX2\pcsx2.exe</entry>
|
||||
<entry>%ESPATH%\PCSX2\pcsx2.exe</entry>
|
||||
<entry>%ESPATH%\Emulators\PCSX2\pcsx2.exe</entry>
|
||||
<entry>%ESPATH%\PCSX2\pcsx2.exe</entry>
|
||||
<entry>%ESPATH%\..\PCSX2\pcsx2.exe</entry>
|
||||
</rule>
|
||||
</emulator>
|
||||
|
|
@ -1602,8 +1602,8 @@ For reference, here are also example es_find_rules.xml files for macOS and Windo
|
|||
</rule>
|
||||
<rule type="staticpath">
|
||||
<entry>~\AppData\Local\yuzu\yuzu-windows-msvc\yuzu.exe</entry>
|
||||
<entry>%ESPATH%\yuzu\yuzu-windows-msvc\yuzu.exe</entry>
|
||||
<entry>%ESPATH%\Emulators\yuzu\yuzu-windows-msvc\yuzu.exe</entry>
|
||||
<entry>%ESPATH%\yuzu\yuzu-windows-msvc\yuzu.exe</entry>
|
||||
<entry>%ESPATH%\..\yuzu\yuzu-windows-msvc\yuzu.exe</entry>
|
||||
</rule>
|
||||
</emulator>
|
||||
|
|
|
|||
|
|
@ -217,7 +217,7 @@ Note that if the setting _Only show ROMs from gamelist.xml files_ has been enabl
|
|||
|
||||
## Placing games and other resources on network shares
|
||||
|
||||
Although ES-DE does support placing game ROMs, the `.emulationstation` home directory and the `downloaded_media` directory on network shares, this can lead to serious performance problems in some instances. Especially problematic is the Microsoft SMB protocol as it offers abysmal performance for some disk operations on which ES-DE relies heavily. For small game libraries this can still be acceptable, but for libraries with hundreds or thousands of games the application startup time and overall usage will be very painful or even unusable.
|
||||
Although ES-DE does support placing game ROMs, the `.emulationstation` home directory and the `downloaded_media` directory on network shares, this can lead to serious performance problems in some instances. Especially problematic is the Microsoft SMB protocol as it offers abysmal performance for some disk operations on which ES-DE relies heavily. For small game libraries this can still be acceptable, but for libraries with hundreds or thousands of games the application startup time and overall usage will be very painful or even unusable. Similar issues could occur when using file hosting services like Google Drive.
|
||||
|
||||
A general recommendation is to place all game files and other data on drives connected directly to the machine where ES-DE is running. Even using low speed technology like USB thumb drives, SD cards etc. is generally fine and leads to acceptable performance in most instances.
|
||||
|
||||
|
|
@ -566,7 +566,7 @@ Unfortunately on Linux it's at the moment not possible to run the Steam release
|
|||
|
||||
## Using emulators in AppImage format on Linux
|
||||
|
||||
AppImages are a great way to package emulators on Linux as they work across many different distributions, and launching and running them introduces virtually no overhead. There is one small problem though in that there is no standardized directory for storing these files, meaning ES-DE could have issues locating them.
|
||||
AppImages is a great way to package emulators on Linux as they work across many different distributions, and launching and running them introduces virtually no overhead. There is one small problem though in that there is no standardized directory for storing these files, meaning ES-DE could have issues locating them.
|
||||
|
||||
Therefore all bundled emulator configuration entries that support AppImages will look for these files in the following directories:
|
||||
|
||||
|
|
@ -1055,11 +1055,11 @@ And here's an example on Unix:
|
|||
~/ROMs/desktop/spotify.desktop
|
||||
```
|
||||
|
||||
On macOS there are two ways to create shortcuts to applications, the first option is .app folders which can be directly executed by ES-DE and the second option is aliases. To create an alias for an appliction, right click on it in Finder, then select _Make Alias_. Following this move the alias file to the `ports` or `desktop` ROMs directory. As a final step you need to add the .app extension to the file.
|
||||
On macOS there are two ways to create shortcuts to applications, the first option is .app folders which can be directly executed by ES-DE and the second option is aliases. The easiest way to create an alias is to open two Finder windows, one for your Applications folder and one for your ~/ROMs/desktop folder. Then you can simply drag an application over to the desktop folder which will automatically create an alias file. Alternatively you can right click on an application and select _Make Alias_ and then copy the file over. As a final step you need to add the .app extension to the alias file so that ES-DE can find it on startup. Note that this extension will not be visible in Finder, but if you right click on the file and select _Get Info_ you will see the .app extension in the info window.
|
||||
|
||||
Here's an example using alias files on macOS:
|
||||
```
|
||||
~/ROMs/desktop/Chess.app
|
||||
~/ROMs/desktop/RetroArch.app
|
||||
~/ROMs/desktop/System Preferences.app
|
||||
```
|
||||
|
||||
|
|
@ -1761,7 +1761,7 @@ With this option enabled underscores _ in game names are converted to spaces whe
|
|||
|
||||
**Enable fallback to additional regions** _(ScreenScraper only)_
|
||||
|
||||
When a certain game media file does not exist for the selected region, ES-DE automatically performs a fallback to the regions _world_, _USA_, _Japan_, _EU_, and _custom_ in this specific order. If this setting is enabled then an additional fallback is performed to all other country-specific regions. This makes it possible to scrape media for some games only released in specific countries like Brazil or South Korea. It may also make it possible to scrape some game media that has been uploaded to ScreenScraper using the wrong region. The special _ss/ScreenScraper_ region is also enabled via this option, and among other things it contains media for games that never had official releases. This is relevant for instance for OpenBOR and PICO-8 games where 3D boxes and other images may become available. The drawback of this setting is that you may get inaccurate data such as box art in the wrong language or unofficial box art for arcade games, so you may want to experiment with this option on a per-system basis.
|
||||
When a certain game media file does not exist for the selected region, ES-DE automatically performs a fallback to the regions _world_, _USA_, _Japan_, _EU_, and _custom_ in this specific order. If this setting is enabled then an additional fallback is performed to all other country-specific regions. This makes it possible to scrape media for some games only released in specific countries like Brazil or South Korea. It may also make it possible to scrape some game media that have been uploaded to ScreenScraper using the wrong region. The special _ss/ScreenScraper_ region is also enabled via this option, and among other things it contains media for games that never had official releases. This is relevant for instance for OpenBOR and PICO-8 games where 3D boxes and other images may become available. The drawback of this setting is that you may get inaccurate data such as box art in the wrong language or unofficial box art for arcade games, so you may want to experiment with this option on a per-system basis.
|
||||
|
||||
**Auto-retry on peer verification errors** _(ScreenScraper only)_
|
||||
|
||||
|
|
@ -2562,7 +2562,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| 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 |
|
||||
| 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 | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
|
||||
| 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 | |
|
||||
|
|
@ -2583,7 +2583,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| channelf | Fairchild Channel F | FreeChaF | | | |
|
||||
| coco | Tandy Color Computer | _Placeholder_ | | | |
|
||||
| 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 |
|
||||
| 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 | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
|
||||
| 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_ | | See the specific _Ports and desktop applications_ section elsewhere in this guide |
|
||||
| doom | Doom | PrBoom | | | |
|
||||
|
|
@ -2609,16 +2609,16 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| 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 |
|
||||
| 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 |
|
||||
| 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 | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
|
||||
| mame-advmame | AdvanceMAME | _Placeholder_ | | Depends | |
|
||||
| mame-mame4all | MAME4ALL | _Placeholder_ | | Depends | |
|
||||
| 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,<br>BlastEm **(Standalone)** [U] | No | Single archive or ROM file in root folder |
|
||||
| mess | Multi Emulator Super System | MESS 2015 | | | |
|
||||
| model2 | Sega Model 2 | Model 2 Emulator **(Standalone)** [W*] | | | Single archive file following MAME name standard in root folder |
|
||||
| model3 | Sega Model 3 | Supermodel **(Standalone)** [W*] | | | Single archive file following MAME name standard in root folder |
|
||||
| model2 | Sega Model 2 | Model 2 Emulator **(Standalone)** [W*] | | | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
|
||||
| model3 | Sega Model 3 | Supermodel **(Standalone)** [W*] | | | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
|
||||
| moonlight | Moonlight Game Streaming | _Placeholder_ | | | |
|
||||
| moto | Thomson MO/TO Series | Theodore | | | |
|
||||
| msx | MSX | blueMSX | fMSX | | |
|
||||
|
|
@ -2631,7 +2631,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| 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] | ParaLLEl N64 [UW],<br>Mupen64Plus **(Standalone)** [UMW*],<br>sixtyforce **(Standalone)** [M] | No | Single archive or ROM file in root folder |
|
||||
| nds | Nintendo DS | DeSmuME | DeSmuME 2015,<br>DeSmuME **(Standalone)** [U],<br>melonDS,<br>melonDS **(Standalone)** [UMW*] | No | |
|
||||
| neogeo | SNK Neo Geo | FinalBurn Neo | | Yes | Single archive file following MAME name standard in root folder |
|
||||
| neogeo | SNK Neo Geo | FinalBurn Neo | | Yes | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
|
||||
| neogeocd | SNK Neo Geo CD | NeoCD | | Yes | Single archive in root folder (which includes the CD image and ripped audio) |
|
||||
| neogeocdjp | SNK Neo Geo CD [Japan] | NeoCD | | Yes | Single archive in root folder (which includes the CD image and ripped audio) |
|
||||
| nes | Nintendo Entertainment System | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>QuickNES | No | Single archive or ROM file in root folder |
|
||||
|
|
|
|||
Loading…
Reference in a new issue