diff --git a/CHANGELOG.md b/CHANGELOG.md index 41eb51ff1..b5ba47183 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -36,7 +36,8 @@ Apart from this, many small improvements and bug fixes are part of the release, * Increased the max allowed size for images when scraping, which should now only downscale files which really need it * Changed the resampling algorithm for image downscaling for the scraper from bilinear to Lanczos which results in noticeably sharper images * Added a configurable option to automatically retry scraping up to eight times in case of ScreenScraper TLS errors -* Changed the button for jumping to a random system or game and added a setting for disabling the functionality altogether +* Changed the button for jumping to a random system or game and added a setting for enabling or disabling the functionality altogether +* The help text for the "A" button now shows "Enter" instead of "Launch" in the grouped custom collections view * Added navigation sounds for some actions where it was missing, such as when attempting to add folders, placeholders or systems to custom collections * Changed the custom collection "Jump to" navigation sound to the select sound instead of the scroll sound * A notification is now displayed in the grouped custom collections view if a filter is applied to the collection @@ -149,7 +150,7 @@ Many bugs have been fixed, and numerous features that were only partially implem * Added metadata entry to mark games as broken/not working (e.g. useful for MAME games) * Added metadata entry to indicate whether the file should be counted as a game (e.g. useful to exclude setup files and similar for DOS games) * Added metadata entry to hide the metadata values from the gamelist views (useful for general folders, DOS game configuration utilities etc.) -* Added a 'clear' button to the metadata editor to delete the media files and gamelist.xml entry for a game or folder while still retaining the game file +* Added a "Clear" button to the metadata editor to delete the media files and gamelist.xml entry for a game or folder while still retaining the game file * Added a system view counter for favorite games in addition to the total number of games * Added a gamelist info text field displaying the game count, any applied filters as well as an icon if a folder has been entered (requires theme support) * Properly implemented the option to show or hide hidden files and folders @@ -247,12 +248,12 @@ Many bugs have been fixed, and numerous features that were only partially implem ## Known issues -**The issues below are relevant for ES-DE v1.0.1** +**The issues below are relevant for ES-DE v1.1.0** -* The input configuration can be a bit glitchy on some devices, most notably the setup of trigger buttons for Xbox and PlayStation controllers. Once configured everything should work fine though. This configuration issue will be resolved in ES-DE v1.1 with the move to the SDL2 GameController API. +* 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 this bug may not be visible in other games and applications is that ES-DE auto-configures and enables all connected controllers while for example RetroArch requires you to manually setup each controller. This issue does not seem to be present on older macOS versions such as El Capitan. -* Some screen tearing can be seen in the upper part of the screen when using the slide transitions with certain graphics drivers and resolutions. The issue is apparently more prevalent when running ES-DE at a lower resolution on 4K displays by using the --resolution command line option (which is only available on Unix). This problem will hopefully be resolved in ES-DE v1.2 when moving to the GLM library. +* Some screen tearing can be seen in the upper part of the screen when using the slide transitions with certain graphics drivers and resolutions. This problem will hopefully be resolved in ES-DE v1.2 when moving to the GLM library. -* The launching of games can freeze ES-DE on some Windows installations. It probably only occurs on Windows 8.1 but that's not confirmed. The setting 'Run in background (while game is launched)' can be enabled to get around this problem, but this causes some other issues so it should only be used as a last resort. It's unclear if this problem can or will be resolved. If it's confirmed to only affect older Windows versions, then it's probably not worthwhile fixing it. +* The launching of games can freeze ES-DE on some Windows installations. It probably only occurs on Windows 8.1 but that's not confirmed. The setting "Run in background (while game is launched)" can be enabled to get around this problem, but this causes some other issues so it should only be used as a last resort. It's unclear if this problem can or will be resolved. If it's confirmed to only affect older Windows versions, then it's probably not worthwhile fixing it. * 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 caused by a bug in SDL where the primary display scaling is always used for calculating the display bounds and as such it needs to be fixed in that library. If using the same scaling percentage across all monitors, or if not using high DPI monitors at all, then this issue will not occur. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cfb2adc74..ce04d3967 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,7 +48,7 @@ This plan is under constant review so expect it to change from time to time. Sti #### v1.3 * Localization/multi-language support -* Checksum support for the scraper to verify each file before accepting/saving it +* Checksum support for the scraper for exact searches and for determining when to overwrite files * Complete overhaul of the grid view style * A nice and useful grid view implementation in rbsimple-DE * Improved text and font functions, e.g. faster and cleaner line wrapping diff --git a/INSTALL-DEV.md b/INSTALL-DEV.md index ecf12bd91..b8a442539 100644 --- a/INSTALL-DEV.md +++ b/INSTALL-DEV.md @@ -434,6 +434,7 @@ git clone https://github.com/FFmpeg/FFmpeg.git cd FFmpeg git checkout n4.4 ./configure --prefix=/usr/local --enable-gpl --enable-nonfree --enable-shared --enable-libfdk-aac --enable-libvpx +make sudo make install ``` @@ -546,6 +547,11 @@ All except the VLC libraries should be located in /usr/local/lib. The VLC librar Note that the filenames could be slightly different depending on what versions you have installed on your system. +After copying the libraries to the build directory, set the permissions to writable: +``` +chmod 755 ./*.dylib +``` + There are some secondary internal dependencies between some of these library files, and these are baked into the files as absolut paths. As such we need to rewrite these to rpaths (relative paths) which is done using the install_name_tool command. A script is available to automate this: `tools/macOS_change_dylib_rpaths.sh` @@ -1170,7 +1176,7 @@ The contents of f:\ should now look something like this: EmulationStation-DE\ ES-DE_Home\ RetroArch-Win64\ -yuzu\ (if you're using this Nintendo Switch emulator) +yuzu\ (optional Nintendo Switch emulator) Start_ES-DE.bat ``` @@ -1899,4 +1905,4 @@ After creating the two scripts, you should have something like this on the files ~/.emulationstation/scripts/game-end/set_resolution_4K.sh ``` -Don't forget to make the scripts executable (e.g. 'chmod 755 ./set_resolution_1080p.sh'). +Don't forget to make the scripts executable (e.g. "chmod 755 ./set_resolution_1080p.sh"). diff --git a/README.md b/README.md index 2767f52a7..d92bce09f 100644 --- a/README.md +++ b/README.md @@ -11,21 +11,17 @@ YouTube channel with installation instruction videos:\ Although there are multiple forks of EmulationStation in existence, the goal of this edition is to make the software as easy as possible to install and use as a standalone application, and to support the major desktop operating systems, i.e. Unix/Linux, macOS and Windows. Since it's intended to be used as a desktop application rather than as the primary interface for the computer, there are no plans to provide system administration utilities or control over emulator settings from within ES-DE. -The current version 1.0 has been tested on the following operating systems (all for the x86 architecture unless otherwise stated): +The following operating systems have been tested with ES-DE (all for the x86 architecture unless otherwise stated): -* Ubuntu 20.04 LTS -* Ubuntu 20.10 -* Ubuntu 21.04 +* Ubuntu 20.04 to 21.04 * Linux Mint 20 -* Manjaro +* Manjaro 21 * Fedora 33 Workstation * FreeBSD 12.2 * NetBSD 9.1 * OpenBSD 6.8 -* macOS 11 "Big Sur" (x86 and ARM via Rosetta 2) -* macOS 10.15 "Catalina" -* macOS 10.14 "Mojave" -* macOS 10.11 "El Capitan" +* macOS 10.14 "Mojave" to 11 "Big Sur" (ARM via Rosetta 2 is supported) +* macOS 10.11 "El Capitan" (v1.0 release only) * Windows 10 * Windows 8.1 diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index 4ccb3ba0b..27df93b32 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -30,21 +30,17 @@ There are also installation videos available at the ES-DE YouTube channel:\ Getting started with ES-DE is easy, just make sure to install the software properly, either manually as built from source code or using one of the supplied packages. On Windows and macOS you'll use the installer instead of a package. -The following operating systems have been tested (all for the x86 architecture unless otherwise stated): +The following operating systems have been tested with ES-DE (all for the x86 architecture unless otherwise stated): -* Ubuntu 20.04 LTS -* Ubuntu 20.10 -* Ubuntu 21.04 +* Ubuntu 20.04 to 21.04 * Linux Mint 20 -* Manjaro +* Manjaro 21 * Fedora 33 Workstation * FreeBSD 12.2 * NetBSD 9.1 * OpenBSD 6.8 -* macOS 11 "Big Sur" (x86 and ARM via Rosetta 2) -* macOS 10.15 "Catalina" -* macOS 10.14 "Mojave" -* macOS 10.11 "El Capitan" +* macOS 10.14 "Mojave" to 11 "Big Sur" (ARM via Rosetta 2 is supported) +* macOS 10.11 "El Capitan" (v1.0 release only) * Windows 10 * Windows 8.1 @@ -162,6 +158,8 @@ Note that custom button mappings will not change the help prompts. If you have issues with your input configuration, as a last resort you can reset all the mappings by deleting or renaming the file ~/.emulationstation/es_input.xml. +**Note:** If you experience double button presses with your DualShock 4 controller on macOS, please read about the workaround for this issue in the [Known issues](CHANGELOG.md#known-issues) section of the changelog. + ## System view (main screen) When starting EmulationStation with the default settings, you will see the main screen first. From here you can navigate your game systems and enter their respective gamelists. @@ -254,7 +252,7 @@ Jumps to the first and last entry of the gamelists, menus and text edit dialogs. **Left and right thumbstick click**\ _(F2 / F3)_ -Jumps to a random game or system depending on whether pressed when in the system view or gamelist view. +Jumps to a random game or system depending on whether pressed when in the system view or gamelist view. This functionality can be enabled or disabled via a menu option. **A button**\ _(Enter)_ @@ -274,7 +272,7 @@ Starts the game media viewer (which is accessible from the gamelist views). Used **Y button**\ _(Insert on Unix and Windows, F13 on macOS)_ -Marks games as favorites in the gamelist views. Used by some other minor functions as explained by the help system and/or this guide. +Marks games as favorites in the gamelist view (this functionality can be enabled or disabled via a menu option). Used by some other minor functions as explained by the help system and/or this guide. **F4 (keyboard only)** @@ -679,9 +677,9 @@ Must have corresponding filenames for its media files in this fashion: JPG and PNG file formats and file extensions are supported for images, and AVI, MKV, MOV, MP4 and WMV are supported for videos. -Remember that on Unix files are case sensitive, and as well the file extensions must be in lower case, such as .png instead of .PNG or .Png or the file won't be found. +Remember that on Unix filenames are case sensitive, and as well the file extensions must be in lower case, such as .png instead of .PNG or .Png or the file won't be found. -It's possible to change the game media directory from within ES-DE, for this see the option **Game media directory**. +It's possible to change the game media directory location from within ES-DE, for this see the option **Game media directory**. ## Main menu diff --git a/USERGUIDE.md b/USERGUIDE.md index 6fcac2dd3..313c51e51 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -32,21 +32,17 @@ There are also installation videos available at the ES-DE YouTube channel:\ Getting started with ES-DE is easy, just make sure to install the software properly, either manually as built from source code or using one of the supplied packages. On Windows and macOS you'll use the installer instead of a package. -The following operating systems have been tested (all for the x86 architecture unless otherwise stated): +The following operating systems have been tested with ES-DE (all for the x86 architecture unless otherwise stated): -* Ubuntu 20.04 LTS -* Ubuntu 20.10 -* Ubuntu 21.04 +* Ubuntu 20.04 to 21.04 * Linux Mint 20 -* Manjaro +* Manjaro 21 * Fedora 33 Workstation * FreeBSD 12.2 * NetBSD 9.1 * OpenBSD 6.8 -* macOS 11 "Big Sur" (x86 and ARM via Rosetta 2) -* macOS 10.15 "Catalina" -* macOS 10.14 "Mojave" -* macOS 10.11 "El Capitan" +* macOS 10.14 "Mojave" to 11 "Big Sur" (ARM via Rosetta 2 is supported) +* macOS 10.11 "El Capitan" (v1.0 release only) * Windows 10 * Windows 8.1