Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-22 06:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small documentation update.

Browse source
This commit is contained in:
Leon Styhre 2021-06-30 18:49:04 +02:00
parent b41c2d68f5
commit 9d107a7a9d
2 changed files with 58 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -256,7 +256,7 @@ Many bugs have been fixed, and numerous features that were only partially implem
**The issues below are relevant for ES-DE v1.1.0** **The issues below are relevant for ES-DE v1.1.0**
* There is an issue with launching games on Windows when using AMD and Intel GPUs. This causes the emulator to just output a blank screen. There is a workaround available for this which is enabled by default and that can be disabled via the menu option "AMD and Intel GPU game launch workaround". The drawback of this workaround is that a white instead of a black screen will displayed when launching games. If using an Nvidia GPU, it should be safe to disable this option for a slightly better user experience. An alternative workaround is to enable the option "Run in background (while game is launched)". * There is an issue with launching games on Windows when using AMD and Intel GPUs. This causes the emulator to just output a blank screen. There is a workaround available for this which is enabled by default and that can be disabled via the menu option "AMD and Intel GPU game launch workaround". The drawback of this workaround is that a white instead of a black screen will be displayed when launching games. If using an Nvidia GPU, it should be safe to disable this option for a slightly better user experience. An alternative workaround is to enable the option "Run in background (while game is launched)".
* On macOS Big Sur (and possibly other OS versions) when connecting a 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. * On macOS Big Sur (and possibly other OS versions) when connecting a 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.

113
INSTALL-DEV.md
View file

@ -1139,62 +1139,6 @@ The theme is not mandatory to start the application, but ES-DE will be basically
So the home directory will always take precedence, and any resources or themes located there will override the ones in the path of the ES-DE executable. So the home directory will always take precedence, and any resources or themes located there will override the ones in the path of the ES-DE executable.
## Portable installation on Windows
It's possible to easily create a portable installation of ES-DE for Windows, for example to place on a USB memory stick.
For the sake of this example, let's assume that the removable media has the device name `f:\`
These are the steps to perform:
* Copy the EmulationStation-DE installation directory to f:\
* Copy your emulator directories to f:\EmulationStation-DE\
* Copy your ROMs directory to f:\EmulationStation-DE\
* Create an empty file named portable.txt in f:\EmulationStation-DE\
You should end up with something like this:
```
f:\EmulationStation-DE\
f:\EmulationStation-DE\RetroArch-Win64\
f:\EmulationStation-DE\yuzu\
f:\EmulationStation-DE\ROMs\
f:\EmulationStation-DE\portable.txt
```
(Yuzu is an optional Nintendo Switch emulator.)
Of course there will be many more files and directories from the normal installation than those listed above.
How this works is that when ES-DE finds a file named portable.txt in its executable directory, it will locate the .emulationstation directory directly in this folder. It's however also possible to modify portable.txt with a path relative to the ES-DE executable directory. For instance if two dots `..` are placed inside the portable.txt file, then the .emulationstation directory will be located in the parent folder, which would be directly under f:\ in this example.
If the --home command line parameter is passed when starting ES-DE, that will override the portable.txt file.
The emulators that will be automatically searched for by ES-DE are (relative to the EmulationStation-DE directory):
```
RetroArch-Win64\retroarch.exe
RetroArch\retroarch.exe
yuzu\yuzu-windows-msvc\yuzu.exe
..\RetroArch-Win64\retroarch.exe
..\RetroArch\retroarch.exe
..\yuzu\yuzu-windows-msvc\yuzu.exe
```
If you want to place your emulators elsewhere, you need to create a customized es_find_rules.xml file, which is explained later in this document.
Start ES-DE from the f:\ device and check that everything works as expected.
Following this, optionally copy any existing gamelist.xml files, game media files etc. to the removable media. For example:
```
f:\EmulationStation-DE\.emulationstation\gamelists\
f:\EmulationStation-DE\.emulationstation\downloaded_media\
```
You now have a fully functional portable retro gaming installation!
The portable installation works exactly as a normal installation, i.e. you can use the built-in scraper, edit metadata etc.
## CA certificates and MAME ROM information ## CA certificates and MAME ROM information
@ -1823,6 +1767,63 @@ This will draw a semi-transparent blue frame around all text elements.
This will reload either a single gamelist or all gamelists depending on where you're located when entering the key combination (go to the system view to make a complete reload). Very useful for theme development as any changes to the theme files will be activated without requiring an application restart. Note that the menu needs to be closed for this key combination to have any effect. This will reload either a single gamelist or all gamelists depending on where you're located when entering the key combination (go to the system view to make a complete reload). Very useful for theme development as any changes to the theme files will be activated without requiring an application restart. Note that the menu needs to be closed for this key combination to have any effect.
## Portable installation on Windows
It's possible to easily create a portable installation of ES-DE for Windows, for example to place on a USB memory stick.
For the sake of this example, let's assume that the removable media has the device name `f:\`
These are the steps to perform:
* Copy the EmulationStation-DE installation directory to f:\
* Copy your emulator directories to f:\EmulationStation-DE\
* Copy your ROMs directory to f:\EmulationStation-DE\
* Create an empty file named portable.txt in f:\EmulationStation-DE\
You should end up with something like this:
```
f:\EmulationStation-DE\
f:\EmulationStation-DE\RetroArch-Win64\
f:\EmulationStation-DE\yuzu\
f:\EmulationStation-DE\ROMs\
f:\EmulationStation-DE\portable.txt
```
(Yuzu is an optional Nintendo Switch emulator.)
Of course there will be many more files and directories from the normal installation than those listed above.
How this works is that when ES-DE finds a file named portable.txt in its executable directory, it will locate the .emulationstation directory directly in this folder. It's however also possible to modify portable.txt with a path relative to the ES-DE executable directory. For instance if two dots `..` are placed inside the portable.txt file, then the .emulationstation directory will be located in the parent folder, which would be directly under f:\ in this example.
If the --home command line parameter is passed when starting ES-DE, that will override the portable.txt file.
The emulators that will be automatically searched for by ES-DE are (relative to the EmulationStation-DE directory):
```
RetroArch-Win64\retroarch.exe
RetroArch\retroarch.exe
yuzu\yuzu-windows-msvc\yuzu.exe
..\RetroArch-Win64\retroarch.exe
..\RetroArch\retroarch.exe
..\yuzu\yuzu-windows-msvc\yuzu.exe
```
If you want to place your emulators elsewhere, you need to create a customized es_find_rules.xml file, which is explained later in this document.
Start ES-DE from the f:\ device and check that everything works as expected.
Following this, optionally copy any existing gamelist.xml files, game media files etc. to the removable media. For example:
```
f:\EmulationStation-DE\.emulationstation\gamelists\
f:\EmulationStation-DE\.emulationstation\downloaded_media\
```
You now have a fully functional portable retro gaming installation!
The portable installation works exactly as a normal installation, i.e. you can use the built-in scraper, edit metadata etc.
## Custom event scripts ## Custom event scripts
There are numerous locations throughout ES-DE where custom scripts will be executed if the option to do so has been enabled in the settings. You'll find the option on the Main menu under `Other settings`. By default it's deactivated so be sure to enable it to use this feature. There are numerous locations throughout ES-DE where custom scripts will be executed if the option to do so has been enabled in the settings. You'll find the option on the Main menu under `Other settings`. By default it's deactivated so be sure to enable it to use this feature.