Documentation update.

This commit is contained in:
Leon Styhre 2022-03-31 19:29:41 +02:00
parent 810a53e324
commit 63d79d152b
3 changed files with 35 additions and 6 deletions

View file

@ -601,7 +601,7 @@ Many bugs have been fixed, and numerous features that were only partially implem
## Known issues ## Known issues
**The issues below are relevant for ES-DE v1.2.0** **The issues below are relevant for ES-DE v1.2.1**
* On Windows when using high DPI displays, if not running ES-DE on the primary monitor and the display where it runs does not have the same scaling percentage as the primary monitor, then the ES-DE resolution will not be properly set. The application will still work and if running in fullscreen mode it may not even be noticeable. This issue is probably caused by a bug in SDL where the primary display scaling is always used for calculating the display bounds. If using the same scaling percentage across all monitors, or if not using high DPI monitors at all, then this issue is not relevant. * On Windows when using high DPI displays, if not running ES-DE on the primary monitor and the display where it runs does not have the same scaling percentage as the primary monitor, then the ES-DE resolution will not be properly set. The application will still work and if running in fullscreen mode it may not even be noticeable. This issue is probably caused by a bug in SDL where the primary display scaling is always used for calculating the display bounds. If using the same scaling percentage across all monitors, or if not using high DPI monitors at all, then this issue is not relevant.

View file

@ -1715,6 +1715,7 @@ For this example, let's assume that the removable media has the device name `F:\
These are the steps to perform: These are the steps to perform:
* Install ES-DE
* Copy the EmulationStation-DE installation directory to F:\ * Copy the EmulationStation-DE installation directory to F:\
* Copy your emulator directories to F:\EmulationStation-DE\ * Copy your emulator directories to F:\EmulationStation-DE\
* Copy your ROMs directory to F:\EmulationStation-DE\ * Copy your ROMs directory to F:\EmulationStation-DE\

View file

@ -2001,6 +2001,7 @@ For this example, let's assume that the removable media has the device name `F:\
These are the steps to perform: These are the steps to perform:
* Install ES-DE
* Copy the EmulationStation-DE installation directory to F:\ * Copy the EmulationStation-DE installation directory to F:\
* Copy your emulator directories to F:\EmulationStation-DE\ * Copy your emulator directories to F:\EmulationStation-DE\
* Copy your ROMs directory to F:\EmulationStation-DE\ * Copy your ROMs directory to F:\EmulationStation-DE\
@ -2010,19 +2011,16 @@ You should end up with something like this:
``` ```
F:\EmulationStation-DE\ F:\EmulationStation-DE\
F:\EmulationStation-DE\dosbox-staging\ F:\EmulationStation-DE\dosbox-staging\
F:\EmulationStation-DE\PCSX2\
F:\EmulationStation-DE\RetroArch-Win64\ F:\EmulationStation-DE\RetroArch-Win64\
F:\EmulationStation-DE\ROMs\ F:\EmulationStation-DE\ROMs\
F:\EmulationStation-DE\RPCS3\ F:\EmulationStation-DE\RPCS3\
F:\EmulationStation-DE\xemu\ F:\EmulationStation-DE\xemu\
F:\EmulationStation-DE\xenia\
F:\EmulationStation-DE\yuzu\
F:\EmulationStation-DE\portable.txt F:\EmulationStation-DE\portable.txt
``` ```
This is just an example, you may not have all these emulators installed and as well there will of course be many more files and directories than those listed above inside the F:\EmulationStation-DE directory. This is just an example as you may of course not use these specific emulators. There are also many more emulators supported as described below. As well there will be many more files and directories than those listed above inside the F:\EmulationStation-DE directory.
How the portable setup works is that when ES-DE finds a file named portable.txt in its executable directory, it will by default locate the .emulationstation directory directly inside this folder. It's 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. How the portable setup works is that when ES-DE finds a file named portable.txt in its executable directory, it will by default locate the .emulationstation directory directly inside this folder. It's 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:\ for this example.
If the --home command line parameter is passed when starting ES-DE, that will override the portable.txt file. If the --home command line parameter is passed when starting ES-DE, that will override the portable.txt file.
@ -2031,17 +2029,47 @@ By default the emulators that will be automatically searched for by ES-DE are (r
``` ```
RetroArch-Win64\retroarch.exe RetroArch-Win64\retroarch.exe
RetroArch\retroarch.exe RetroArch\retroarch.exe
cemu\Cemu.exe
Citra\canary-mingw\citra.exe
Citra\nightly-mingw\citra.exe
Dolphin-x64\Dolphin.exe
dosbox-staging\dosbox.exe dosbox-staging\dosbox.exe
duckstation\duckstation-nogui-x64-ReleaseLTCG.exe
duckstation\duckstation-qt-x64-ReleaseLTCG.exe
flycast\flycast.exe
mame\mame.exe
melonDS\melonDS.exe
mGBA\mGBA.exe
mupen64plus\mupen64plus-ui-console.exe
PCSX2\pcsx2.exe PCSX2\pcsx2.exe
PPSSPP\PPSSPPWindows64.exe
redream\redream.exe
RPCS3\rpcs3.exe RPCS3\rpcs3.exe
ryujinx\Ryujinx.exe
VBA-M\visualboyadvance-m.exe
xemu\xemu.exe xemu\xemu.exe
xenia\xenia.exe xenia\xenia.exe
yuzu\yuzu-windows-msvc\yuzu.exe yuzu\yuzu-windows-msvc\yuzu.exe
..\RetroArch-Win64\retroarch.exe ..\RetroArch-Win64\retroarch.exe
..\RetroArch\retroarch.exe ..\RetroArch\retroarch.exe
..\cemu\Cemu.exe
..\Citra\canary-mingw\citra.exe
..\Citra\nightly-mingw\citra.exe
..\Dolphin-x64\Dolphin.exe
..\dosbox-staging\dosbox.exe ..\dosbox-staging\dosbox.exe
..\duckstation\duckstation-nogui-x64-ReleaseLTCG.exe
..\duckstation\duckstation-qt-x64-ReleaseLTCG.exe
..\flycast\flycast.exe
..\mame\mame.exe
..\melonDS\melonDS.exe
..\mGBA\mGBA.exe
..\mupen64plus\mupen64plus-ui-console.exe
..\PCSX2\pcsx2.exe ..\PCSX2\pcsx2.exe
..\PPSSPP\PPSSPPWindows64.exe
..\redream\redream.exe
..\RPCS3\rpcs3.exe ..\RPCS3\rpcs3.exe
..\ryujinx\Ryujinx.exe
..\VBA-M\visualboyadvance-m.exe
..\xemu\xemu.exe ..\xemu\xemu.exe
..\xenia\xenia.exe ..\xenia\xenia.exe
..\yuzu\yuzu-windows-msvc\yuzu.exe ..\yuzu\yuzu-windows-msvc\yuzu.exe