From 12677f493b056e130399e73d1fcf741bde1edcab Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Sat, 20 Jan 2024 00:03:35 +0100 Subject: [PATCH] Documentation update --- CHANGELOG.md | 3 +++ USERGUIDE-DEV.md | 6 ++++++ 2 files changed, 9 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8728ba5c6..5d377b51c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,10 +10,12 @@ * Renamed the application from EmulationStation Desktop Edition to ES-DE * Renamed the application data directory from .emulationstation to ES-DE +* Updated the splash screen to reflect the new application name * Split the es_find_rules.xml and es_systems.xml files for Linux and BSD Unix into separate directories * Added support for defining font sizes from the theme configuration and selecting these from the UI settings menu * Added the theme font sizes count to the theme downloader interface * Added support for medium and large font sizes to the Slate and Modern themes +* Added an option to the Input device settings menu to swap the A/B and X/Y buttons * Added support for .webp, .svg and unanimated .gif files to the slideshow screensaver when using a custom image directory * Changed the default slideshow custom image directory from slideshow/custom_images to screensavers/custom_slideshow * Changed the custom slideshow image directory setting from ScreensaverSlideshowImageDir to ScreensaverSlideshowCustomDir @@ -32,6 +34,7 @@ * (Windows) Added the %RUNINBACKGROUND% variable for the epic system * (Windows) Removed support for building the application using MinGW * Added a "renderDuringTransitions" property to the image element +* Replaced the default d-pad helpsystem images to make them more legible when using smaller screen sizes * Placeholder entries in es_systems.xml are now skipped by default when creating the system directories and systeminfo.txt files * Added a CreatePlaceholderSystemDirectories option that can be manually set in es_settings.xml to still create placeholder directories * Changed the ScreenScraper URL from https://www.screenscraper.fr/api2 to https://api.screenscraper.fr/api2 diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index 94e952b8f..ac5080536 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -492,6 +492,8 @@ When editing text it's also possible to paste from the clipboard into ES-DE usin Default keyboard mappings are shown in brackets below. +It's assumed that the option _Swap A/B and X/Y buttons_ in the _Input device settings_ menu is disabled as some buttons will otherwise obviously be swapped. + **Up and down**\ _(Arrow up / Arrow down)_ @@ -3382,6 +3384,10 @@ The touch overlay applies a layer of virtual buttons on top of the ES-DE window. If enabling this option, only the first controller detected during startup will send its input to ES-DE (the keyboard input is unaffected by this setting and will be enabled regardless). This is a good way to limit potential chaos with multiple persons fighting over which games to play. Note that disconnecting and reconnecting controllers while ES-DE is running may change what is considered the first controller. This setting does not affect the emulators in any way, it's only applied to ES-DE. Another issue is that some wireless controllers have buggy drivers and will register as two devices, meaning all button presses will be registered twice inside ES-DE. Using this option is one solution to the problem, although it's also possible to blacklist the extra controller entry, as described [here](INSTALL-DEV.md#adding-custom-controller-profiles). +**Swap A/B and X/Y buttons** + +When enabling this setting the functions for the A/B and X/Y buttons will be swapped and the helpsystem will be updated accordingly. The primary purpose of this setting is for using controllers like Nintendo Switch Pro and some handhelds which have swapped the physical positions of these buttons. With this setting enabled you'll be able to rely on your muscle memory from using any other controller type with a normal button layout. Note that the button swap does not apply to the keyboard which leads to a slight inconsistency as the helpsystem will only match the controller and not the keyboard. + **Ignore keyboard input** If this setting is enabled then all keyboard input will be ignored, except the quit shortcut used to shut down the application. The main reason for ignoring keyboard input is if running Steam in parallel to ES-DE and you need to use the Steam Input's _Desktop Layout_ functionality to send keyboard input using the controller. In this case double or conflicting input will be sent to ES-DE as both the controller and keyboard events are read by the application. It's however generally a better idea to disable this functionality altogether in Steam and leave the ES-DE setting untouched. If you accidentally enable this setting when using a keyboard as input device, then you'll either need to plug in a controller to disable it again, or you'll need to modify the _InputIgnoreKeyboard_ entry in the ~/ES-DE/settings/es_settings.xml configuration file.