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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2021-07-14 19:27:39 +02:00
parent 977ab5e683
commit 5c0cf89ac1
2 changed files with 21 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
INSTALL-DEV.md
View file

@ -66,7 +66,7 @@ sudo pacman -S vlc
**Raspberry Pi OS (Raspian)** **Raspberry Pi OS (Raspian)**
Note: The Raspberry Pi 4 is the minimum recommended model to use with ES-DE. As this type of device is quite weak and because the FFmpeg video player currently lacks hardware decoding/acceleration it is strongly adviced to build with the VLC player, which is hardware accelerated. Note: The Raspberry Pi 4 is the minimum recommended model to use with ES-DE. As this type of device is quite weak and because the FFmpeg video player does not support hardware decoding on this platform, it's strongly adviced to build with the VLC player, which is hardware accelerated.
All of the required packages can be installed with apt-get: All of the required packages can be installed with apt-get:
``` ```
@ -792,7 +792,7 @@ In the descriptions below it's assumed that all build steps for MinGW/GCC will b
**Download the dependency packages:** **Download the dependency packages:**
FFmpeg (choose a package with win64-gpl-shared in the filename, the latest snapshot build should generally be fine to use) \ FFmpeg (choose the n4.4 package with win64-gpl-shared in the filename, the snapshot version will not work) \
[https://github.com/BtbN/FFmpeg-Builds/releases](https://github.com/BtbN/FFmpeg-Builds/releases) [https://github.com/BtbN/FFmpeg-Builds/releases](https://github.com/BtbN/FFmpeg-Builds/releases)
FreeImage (binary distribution) \ FreeImage (binary distribution) \
@ -937,18 +937,18 @@ Copy the files to the `emulationstation-de` build directory. Most of them will c
**Required files for MSVC:** **Required files for MSVC:**
``` ```
avcodec-59.dll avcodec-58.dll
avcodec.lib avcodec.lib
avfilter.lib avfilter.lib
avfilter-8.dll avfilter-7.dll
avformat-59.dll avformat-58.dll
avformat.lib avformat.lib
avutil-57.dll avutil-56.dll
avutil.lib avutil.lib
postproc-56.dll postproc-55.dll
swresample-4.dll swresample-3.dll
swresample.lib swresample.lib
swscale-6.dll swscale-5.dll
swscale.lib swscale.lib
FreeImage.dll FreeImage.dll
FreeImage.lib FreeImage.lib
@ -995,13 +995,13 @@ lib /def:libvlc.def /out:libvlc.lib /machine:x64
**Required files for MinGW:** **Required files for MinGW:**
``` ```
avcodec-59.dll avcodec-58.dll
avfilter-8.dll avfilter-7.dll
avformat-59.dll avformat-58.dll
avutil-57.dll avutil-56.dll
postproc-56.dll postproc-55.dll
swresample-4.dll swresample-3.dll
swscale-6.dll swscale-5.dll
FreeImage.dll FreeImage.dll
glew32.dll glew32.dll
libcrypto-1_1-x64.dll (from the OpenSSL package, located in Git MinGW/MSYS2 under \mingw64\bin) libcrypto-1_1-x64.dll (from the OpenSSL package, located in Git MinGW/MSYS2 under \mingw64\bin)

6
USERGUIDE-DEV.md
View file

@ -1180,6 +1180,10 @@ Enabling this option makes ES-DE continue to run while a game is launched. This
There is an issue with launching games on some Windows computers, seemingly on those with AMD and Intel GPUs. The emulator will start and work correctly, but the screen will be blank. Enabling this option is a workaround for that problem, with the drawback that the screen will become white instead of black when the emulator is loading. This option is enabled by default, so experiment with disabling it for a slightly better experience. If you're using an Nvidia GPU, chances are high that it will then work fine. An alternative workaround is to enable the _Run in background (while game is launched)_ option described above, so test which gives the best result. The two options can however not be enabled at the same time. Hopefully this whole game launching issue can be resolved completely in a future ES-DE release. There is an issue with launching games on some Windows computers, seemingly on those with AMD and Intel GPUs. The emulator will start and work correctly, but the screen will be blank. Enabling this option is a workaround for that problem, with the drawback that the screen will become white instead of black when the emulator is loading. This option is enabled by default, so experiment with disabling it for a slightly better experience. If you're using an Nvidia GPU, chances are high that it will then work fine. An alternative workaround is to enable the _Run in background (while game is launched)_ option described above, so test which gives the best result. The two options can however not be enabled at the same time. Hopefully this whole game launching issue can be resolved completely in a future ES-DE release.
**FFmpeg/Video hardware decoding (experimental)** _(All platforms except Raspberry Pi)_
Enabling this option offloads video decoding to the GPU. Whether this actually increases performance is another matter. As desktop-class CPUs are very capable of decoding the video streams directly, the performance may actually get worse as hardware decoding requires data to be passed back and forth between the CPU and GPU. This potential degradation is especially true for integrated GPUs, and even more so if the GPU is heavily utilized. In addition to this, most GPUs can only decode a subset of video codecs and profiles, meaning ES-DE will anyway have to fallback to software rendering when the GPU is unable to process the stream. With that said, there are still situations where hardware decoding can help, so experiment with the setting to see if it's useful for your configuration. Unfortunately hardware decoding for the FFmpeg video player is not supported on the Raspberry Pi, and it will probably stay this way unless FFmpeg starts to support the MMAL decoder internally. For this device, the VLC-based video player can be used instead, for which hardware decoding is available.
**Upscale video frame rate to 60 FPS (FFmpeg)** **Upscale video frame rate to 60 FPS (FFmpeg)**
With this option enabled, videos with lower frame rates than 60 FPS, such as 24 and 30 will get upscaled to 60 FPS. This results in slightly smoother playback for some videos. There is a small performance hit from this option, so on weaker machines it may be necessary to disable it for fluent video playback. This setting has no effect when using the VLC video player. If the VLC video player is not included in the ES-DE build, the "(FFmpeg)" text is omitted from the setting name. With this option enabled, videos with lower frame rates than 60 FPS, such as 24 and 30 will get upscaled to 60 FPS. This results in slightly smoother playback for some videos. There is a small performance hit from this option, so on weaker machines it may be necessary to disable it for fluent video playback. This setting has no effect when using the VLC video player. If the VLC video player is not included in the ES-DE build, the "(FFmpeg)" text is omitted from the setting name.
@ -1622,7 +1626,7 @@ Consider the table below a work in progress as it's obvioulsy not fully populate
| apple2gs | Apple IIGS | | | | apple2gs | Apple IIGS | | |
| arcade | Arcade | RetroArch (MAME - Current)* | Single archive file following MAME name standard in root folder | | arcade | Arcade | RetroArch (MAME - Current)* | Single archive file following MAME name standard in root folder |
| astrocade | Bally Astrocade | | | | astrocade | Bally Astrocade | | |
| atari2600 | Atari 2600 | RetroArch (Stella) | Single archive or ROM file in root folder | | atari2600 | Atari 2600 | RetroArch (Stella on macOS and Windows, Stella 2014 on Unix) | Single archive or ROM file in root folder |
| atari5200 | Atari 5200 | | | | atari5200 | Atari 5200 | | |
| atari7800 | Atari 7800 ProSystem | | | | atari7800 | Atari 7800 ProSystem | | |
| atari800 | Atari 800 | | | | atari800 | Atari 800 | | |