mirror of
https://github.com/RetroDECK/ES-DE.git
synced 2024-11-21 21:55:38 +00:00
Documentation update.
This commit is contained in:
Leon Styhre
parent
8fc5e27e5e
commit
f94ded595a
|
|
@ -149,6 +149,9 @@ v1.2 maintenance release.
|
|||
|
||||
* (Windows) Set %RUNINBACKGROUND% when launching MAME standalone as this emulator may otherwise hang on exit
|
||||
* Removed the --escape-exit command line option for the PPSSPP standalone emulator as it caused issues for some users
|
||||
* Changed the default emulator for the famicom, fds and nes systems from Nestopia UE to Mesen
|
||||
* Changed the default emulator for the dos and pc systems from DOSBox-Core to DOSBox-Pure
|
||||
* Added DOSBox-X standalone as an alternative emulator for the dos and pc systems
|
||||
* Added AetherSX2 standalone as an alternative emulator for the ps2 system on macOS
|
||||
* (macOS) Categorized the application as a game so it shows up in the Launchpad games section
|
||||
* (Windows) Added an %ESCAPESPECIALS% variable that escapes the special characters &()^=;,
|
||||
|
|
|
|||
|
|
@ -252,7 +252,7 @@ A minor annoyance is that macOS creates metadata files starting with ._ in the f
|
|||
|
||||
Another problem on macOS 11 Big Sur (and possibly older OS versions) is that when connecting a Sony DualShock 4 controller either via Bluetooth or using a USB cable, two separate controller devices are registered in parallel. This is a bug in either macOS or the DualShock driver and it makes it seem as if ES-DE is registering double button presses when actually two separate controller devices are generating identical input. A workaround if using Bluetooth mode is to plug in the USB cable just after connecting the controller, wait a second or two and then remove the cable again. This will remove the cabled device, leaving only the Bluetooth device active. Another workaround is to enable the setting _Only accept input from first controller_ in the ES-DE input device settings. The reason why this bug may not be visible in some other games and applications is that ES-DE enables and auto-configures all connected controllers. The issue appears to be resolved in macOS Monterey.
|
||||
|
||||
## Specific notes for Valve Steam Deck
|
||||
## Specific notes for Steam Deck
|
||||
|
||||
As the Steam Deck is essentially a Linux desktop computer with a custom user interface, there is really not much specifically to consider when running ES-DE compared to any other Linux-based operating system. There is a specific AppImage available for the Steam Deck though that is recommended to use, as a number of settings will be tuned for the best possible experience on this device.
|
||||
|
||||
|
|
@ -852,9 +852,37 @@ Advanced topics such as the need for the Amiga Kickstart ROMs to run Amiga games
|
|||
|
||||
#### DOS / PC
|
||||
|
||||
The DOS (and PC) platform uses the DOSBox emulator and the recommended approach here is to keep the directory structure intact, just as if running the game on a real DOS PC. So this means one folder per game in ES-DE. It's also recommended to set the metadata field _Count as game_ to off for all files but the actual file used to launch the game, i.e. the binary or the .bat batch file. This is done so that the game counter correctly reflects the number of games you have installed. It's also possible to mark files and subdirectories as hidden to avoid seeing them in ES-DE. Both of these fields can be set using the metadata editor.
|
||||
For this platform there are two basic approaches to how the setup could be done, either to present each game as a single entry inside ES-DE, or to retain each game's directory structure. The first alternative is more user-friendly, tidy and requires less setup but has some small adverse side effect as described below.
|
||||
|
||||
Apart from this, DOS games should work the same as any other system. The game folders can be scraped so that it looks nice when browsing the list of games, but make sure to also scrape the files used to launch the games or otherwise the entries in the collections _All games, Favorites_ and _Last played_ as well as any custom collections will miss the game metadata and game media. If you don't have these collections activated, then this can of course be skipped.
|
||||
To present the games as single entries there are two options, the first is to compress each game directory into a ZIP file with either the .zip or .dosz file extension. But be aware that only the DOSBox-Pure RetroArch core currently supports this setup. On game launch a menu will be displayed by DOSBox-Pure, asking which file inside the archive you would like to execute. This makes it possible to for example select the actual game file, or a setup utility like SETUP.EXE or INSTALL.EXE.
|
||||
|
||||
Here's an example of a .zip archive setup for use with DOSBox-Pure:
|
||||
```
|
||||
~/ROMs/dos/Dune 2 - The Building of a Dynasty.zip
|
||||
~/ROMs/dos/Quake.zip
|
||||
~/ROMs/dos/Tyrian.zip
|
||||
~/ROMs/dos/UFO Enemy Unknown.zip
|
||||
```
|
||||
|
||||
The second option is to use the _Directories interpreted as files_ functionality explained elsewhere in this guide. This makes it possible to use other DOSBox forks than DOSBox-Pure, but requires some additional setup. How this works is that you create a .bat file inside each game directory with the name of the game, and inside this .bat file you enter the game file you would like to launch. You then rename the game directory to the name of the .bat file including the file extension. Doing this will present the game as a single entry while still giving you the ability to use any DOSBox fork. The negative side effect of this setup is that there is no way to launch any configuration utilities like SETUP.EXE or INSTALL.EXE unless you first switch to DOSBox-Pure as this fork will present you with a menu of which game file to launch. On the other hand this is very easy to do in the rare instances where you want to change some game settings.
|
||||
|
||||
Here's an example of the _Directories interpreted as files_ setup for use with any DOSBox fork:
|
||||
|
||||
```
|
||||
~/ROMs/dos/Dune 2 - The Building of a Dynasty.bat/Dune 2 - The Building of a Dynasty.bat
|
||||
~/ROMs/dos/Quake.bat/Quake.bat
|
||||
~/ROMs/dos/Tyrian.bat/Tyrian.bat
|
||||
~/ROMs/dos/UFO Enemy Unknown.bat/UFO Enemy Unknown.bat
|
||||
```
|
||||
|
||||
For this example, the contents of Tyrian.bat could look like the following:
|
||||
```
|
||||
TYRIAN.EXE
|
||||
```
|
||||
|
||||
The second approach for DOS games is to keep the directory structure intact for each game, just as if running the game on a real DOS PC. If going for this approach it's recommended to set the metadata field _Count as game_ to off for all files except the actual file used to launch the game, i.e. the binary or the .bat batch file. This is done so that the game counter correctly reflects the number of games you have installed. It's also possible to mark files and subdirectories as hidden to avoid seeing them in ES-DE. Both of these fields can be set using the metadata editor. While this setup is a bit tedious and not as tidy, it can be used with all DOSBox forks while still being able to easily access all files inside the game directory, such as any game configuration utilities.
|
||||
|
||||
When going for this approach the game folders can be scraped so that it looks nice when browsing the gamelist, but make sure to also scrape the files used to launch the games or otherwise their entries in the collections _All games, Favorites_ and _Last played_ as well as any custom collections will miss the game metadata and game media. If you don't have these collections activated, then this can of course be skipped.
|
||||
|
||||
#### ScummVM
|
||||
|
||||
|
|
@ -2178,14 +2206,14 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| 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)** [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 Staging **(Standalone)** [UMW*],<br>DOSBox-X **(Standalone)** | No | In separate folder (one folder per game with complete file structure retained) |
|
||||
| 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 | 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 |
|
||||
| famicom | Nintendo Family Computer | Mesen | Nestopia UE,<br>FCEUmm,<br>QuickNES | No | Single archive or ROM file in root folder |
|
||||
| fba | FinalBurn Alpha | FB Alpha 2012 | FB Alpha 2012 Neo Geo,<br>FB Alpha 2012 CPS-1,<br>FB Alpha 2012 CPS-2,<br>FB Alpha 2012 CPS-3 | Yes | Single archive file following MAME name standard in root folder |
|
||||
| fbneo | FinalBurn Neo | FinalBurn Neo | | Yes | Single archive file following MAME name standard in root folder |
|
||||
| fds | Nintendo Famicom Disk System | Nestopia UE | FCEUmm,<br>Mesen | Yes | Single archive or ROM file in root folder |
|
||||
| fds | Nintendo Famicom Disk System | Mesen | Nestopia UE,<br>FCEUmm | Yes | Single archive or ROM file in root folder |
|
||||
| gameandwatch | Nintendo Game and Watch | GW | | | |
|
||||
| gamegear | Sega Game Gear | Gearsystem | SMS Plus GX,<br>Genesis Plus GX,<br>Genesis Plus GX Wide | | |
|
||||
| gb | Nintendo Game Boy | SameBoy | Gambatte,<br>Gearboy,<br>TGB Dual,<br>Mesen-S,<br>bsnes,<br>mGBA,<br>mGBA **(Standalone)**,<br>VBA-M,<br>VBA-M **(Standalone)** | No | Single archive or ROM file in root folder |
|
||||
|
|
@ -2223,14 +2251,14 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
|
|||
| neogeo | SNK Neo Geo | FinalBurn Neo | | Yes | Single archive file following MAME name standard in root folder |
|
||||
| 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 | Nestopia UE | FCEUmm,<br>Mesen,<br>QuickNES | No | Single archive or ROM file in root folder |
|
||||
| nes | Nintendo Entertainment System | Mesen | Nestopia UE,<br>FCEUmm,<br>QuickNES | No | Single archive or ROM file in root folder |
|
||||
| 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 | _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)** [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 Staging **(Standalone)** [UMW*],<br>DOSBox-X **(Standalone)** | 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 | | |
|
||||
| pcengine | NEC PC Engine | Beetle PCE | Beetle PCE FAST | No | Single archive or ROM file in root folder |
|
||||
|
|
|
|||
34
USERGUIDE.md
34
USERGUIDE.md
|
|
@ -250,7 +250,7 @@ A minor annoyance is that macOS creates metadata files starting with ._ in the f
|
|||
|
||||
Another problem on macOS 11 Big Sur (and possibly older OS versions) is that when connecting a Sony DualShock 4 controller either via Bluetooth or using a USB cable, two separate controller devices are registered in parallel. This is a bug in either macOS or the DualShock driver and it makes it seem as if ES-DE is registering double button presses when actually two separate controller devices are generating identical input. A workaround if using Bluetooth mode is to plug in the USB cable just after connecting the controller, wait a second or two and then remove the cable again. This will remove the cabled device, leaving only the Bluetooth device active. Another workaround is to enable the setting _Only accept input from first controller_ in the ES-DE input device settings. The reason why this bug may not be visible in some other games and applications is that ES-DE enables and auto-configures all connected controllers. The issue appears to be resolved in macOS Monterey.
|
||||
|
||||
## Specific notes for Valve Steam Deck
|
||||
## Specific notes for Steam Deck
|
||||
|
||||
As the Steam Deck is essentially a Linux desktop computer with a custom user interface, there is really not much specifically to consider when running ES-DE compared to any other Linux-based operating system. There is a specific AppImage available for the Steam Deck though that is recommended to use, as a number of settings will be tuned for the best possible experience on this device.
|
||||
|
||||
|
|
@ -868,9 +868,37 @@ Advanced topics such as the need for the Amiga Kickstart ROMs to run Amiga games
|
|||
|
||||
#### DOS / PC
|
||||
|
||||
The DOS (and PC) platform uses the DOSBox emulator and the recommended approach here is to keep the directory structure intact, just as if running the game on a real DOS PC. So this means one folder per game in ES-DE. It's also recommended to set the metadata field _Count as game_ to off for all files but the actual file used to launch the game, i.e. the binary or the .bat batch file. This is done so that the game counter correctly reflects the number of games you have installed. It's also possible to mark files and subdirectories as hidden to avoid seeing them in ES-DE. Both of these fields can be set using the metadata editor.
|
||||
For this platform there are two basic approaches to how the setup could be done, either to present each game as a single entry inside ES-DE, or to retain each game's directory structure. The first alternative is more user-friendly, tidy and requires less setup but has some small adverse side effect as described below.
|
||||
|
||||
Apart from this, DOS games should work the same as any other system. The game folders can be scraped so that it looks nice when browsing the list of games, but make sure to also scrape the files used to launch the games or otherwise the entries in the collections _All games, Favorites_ and _Last played_ as well as any custom collections will miss the game metadata and game media. If you don't have these collections activated, then this can of course be skipped.
|
||||
To present the games as single entries there are two options, the first is to compress each game directory into a ZIP file with either the .zip or .dosz file extension. But be aware that only the DOSBox-Pure RetroArch core currently supports this setup. On game launch a menu will be displayed by DOSBox-Pure, asking which file inside the archive you would like to execute. This makes it possible to for example select the actual game file, or a setup utility like SETUP.EXE or INSTALL.EXE.
|
||||
|
||||
Here's an example of a .zip archive setup for use with DOSBox-Pure:
|
||||
```
|
||||
~/ROMs/dos/Dune 2 - The Building of a Dynasty.zip
|
||||
~/ROMs/dos/Quake.zip
|
||||
~/ROMs/dos/Tyrian.zip
|
||||
~/ROMs/dos/UFO Enemy Unknown.zip
|
||||
```
|
||||
|
||||
The second option is to use the _Directories interpreted as files_ functionality explained elsewhere in this guide. This makes it possible to use other DOSBox forks than DOSBox-Pure, but requires some additional setup. How this works is that you create a .bat file inside each game directory with the name of the game, and inside this .bat file you enter the game file you would like to launch. You then rename the game directory to the name of the .bat file including the file extension. Doing this will present the game as a single entry while still giving you the ability to use any DOSBox fork. The negative side effect of this setup is that there is no way to launch any configuration utilities like SETUP.EXE or INSTALL.EXE unless you first switch to DOSBox-Pure as this fork will present you with a menu of which file to launch. On the other hand this is very easy to do in the rare instances where you want to change some game settings.
|
||||
|
||||
Here's an example of the _Directories interpreted as files_ setup for use with any DOSBox fork:
|
||||
|
||||
```
|
||||
~/ROMs/dos/Dune 2 - The Building of a Dynasty.bat/Dune 2 - The Building of a Dynasty.bat
|
||||
~/ROMs/dos/Quake.bat/Quake.bat
|
||||
~/ROMs/dos/Tyrian.bat/Tyrian.bat
|
||||
~/ROMs/dos/UFO Enemy Unknown.bat/UFO Enemy Unknown.bat
|
||||
```
|
||||
|
||||
For this example, the contents of Tyrian.bat could look like the following:
|
||||
```
|
||||
TYRIAN.EXE
|
||||
```
|
||||
|
||||
The second approach for DOS games is to keep the directory structure intact for each game, just as if running the game on a real DOS PC. If going for this approach it's recommended to set the metadata field _Count as game_ to off for all files except the actual file used to launch the game, i.e. the binary or the .bat batch file. This is done so that the game counter correctly reflects the number of games you have installed. It's also possible to mark files and subdirectories as hidden to avoid seeing them in ES-DE. Both of these fields can be set using the metadata editor. While this setup is a bit tedious and not as tidy, it can be used with all DOSBox forks while still being able to easily access all files inside the game directory, such as any game setup utilities.
|
||||
|
||||
When going for this approach the game folders can be scraped so that it looks nice when browsing the gamelist, but make sure to also scrape the files used to launch the games or otherwise their entries in the collections _All games, Favorites_ and _Last played_ as well as any custom collections will miss the game metadata and game media. If you don't have these collections activated, then this can of course be skipped.
|
||||
|
||||
#### ScummVM
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue