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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-05-08 14:45:05 +02:00
parent 29879e81bc
commit 167208f013
3 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
CHANGELOG.md
View file

@ -104,7 +104,6 @@
* Renamed GuiGameScraper.cpp to GuiScraperSingle.cpp * Renamed GuiGameScraper.cpp to GuiScraperSingle.cpp
* Renamed SystemScreensaver.cpp to Screensaver.cpp * Renamed SystemScreensaver.cpp to Screensaver.cpp
* Moved UIModeController.cpp from the es-app/views directory to es-app * Moved UIModeController.cpp from the es-app/views directory to es-app
* Updated the StringUtil::replace function as the old function was dangerous and could run into an endless loop
* Set the clang-format option SpaceBeforeCpp11BracedList to true and reformatted the codebase * Set the clang-format option SpaceBeforeCpp11BracedList to true and reformatted the codebase
* Removed some unnecessary typedefs and replaced the remaining ones with the more modern "using" keyword * Removed some unnecessary typedefs and replaced the remaining ones with the more modern "using" keyword
* Greatly simplified the video controls code (play/stop/pause etc.) * Greatly simplified the video controls code (play/stop/pause etc.)
@ -144,12 +143,21 @@
### Release overview ### Release overview
v1.2 maintenance release.
### Detailed list of changes ### Detailed list of changes
* Added AetherSX2 standalone as an alternative emulator for the ps2 system on macOS * Added AetherSX2 standalone as an alternative emulator for the ps2 system on macOS
* (macOS) Categorized the application as a game in Info.plist
* (Windows) Added an %ESCAPESPECIALS% variable that escapes the special characters &()^=;,
* Updated the StringUtil::replace function as the old function was dangerous and could run into an endless loop
### Bug fixes ### Bug fixes
* (Windows) Fixed an issue where symlinking game media directories would crash the application
* (Windows) Scripts and links executed using cmd.exe could not contain the special characters &()^=;,
* (Windows) ROM directories could not be created in the root of a device such as D:\ or E:\
## Version 1.2.3 ## Version 1.2.3
**Release date:** 2022-05-04 **Release date:** 2022-05-04
@ -727,7 +735,7 @@ Many bugs have been fixed, and numerous features that were only partially implem
* On Windows installing DS4Windows will break controller input in ES-DE for unknown reasons. Uninstalling this software should resolve the issue. On Windows 11 both DualShock 4 (PS4) and DualSense (PS5) controllers have been tested wired and via Bluetooth and both work fine in both ES-DE and RetroArch without any special drivers or configuration. * On Windows installing DS4Windows will break controller input in ES-DE for unknown reasons. Uninstalling this software should resolve the issue. On Windows 11 both DualShock 4 (PS4) and DualSense (PS5) controllers have been tested wired and via Bluetooth and both work fine in both ES-DE and RetroArch without any special drivers or configuration.
* On Windows ampersands (&) can't be used in filenames executed by cmd.exe (applicable for the desktop, epic, kodi, ports and steam systems). * On Windows the special characters &()^=;, can't be used in filenames executed by cmd.exe (applicable for the desktop, epic, kodi, ports and steam systems). This issue will be resolved with the 1.2.4 release.
* There could be problems with Chinese characters under some circumstances which may cause them to not get rendered properly in the gamelist view. This will hopefully be resolved with the 2.0 release. * There could be problems with Chinese characters under some circumstances which may cause them to not get rendered properly in the gamelist view. This will hopefully be resolved with the 2.0 release.

2
FAQ.md
View file

@ -34,7 +34,7 @@ On Windows ES-DE is shipped as a portable installation and as a regular installe
## I'm on Windows and ES-DE refuses to start, is the application broken? ## I'm on Windows and ES-DE refuses to start, is the application broken?
That's very unlikely, you're probably missing the OpenGL drivers required to run ES-DE. Try to download and install the latest drivers for your graphics card. If you have a really old GPU this may not work though, and you may have to go for OpenGL software rendering instead. How this is setup is described in the _Specific notes for Windows_ section of the [User guide](USERGUIDE.md#specific-notes-for-windows). You're probably missing the OpenGL drivers required to run ES-DE. Try to download and install the latest drivers for your graphics card. If you have a really old GPU this may not work though, and you may have to go for OpenGL software rendering instead. How this is setup is described in the _Specific notes for Windows_ section of the [User guide](USERGUIDE.md#specific-notes-for-windows).
## The emulators don't seem to be properly configured? ## The emulators don't seem to be properly configured?

7
INSTALL-DEV.md
View file

@ -1194,8 +1194,9 @@ Below is an overview of the file layout with various examples. For the command t
<command>%RUNINBACKGROUND% bash %ROM%</command> <command>%RUNINBACKGROUND% bash %ROM%</command>
<!-- The equivalent configuration as above, but for Windows. <!-- The equivalent configuration as above, but for Windows.
The optional %HIDEWINDOW% variable is used to hide the console window, which would otherwise be visible when launching games. --> The optional %HIDEWINDOW% variable is used to hide the console window which would otherwise be visible when launching games
<command>%HIDEWINDOW% %RUNINBACKGROUND% cmd.exe /C %ROM%</command> and %ESCAPESPECIALS% escapes the characters &()^=;, that cmd.exe can't otherwise handle. -->
<command>%HIDEWINDOW% %ESCAPESPECIALS% %RUNINBACKGROUND% cmd.exe /C %ROM%</command>
<!-- The platform(s) to use when scraping. You can see the full list of supported platforms in es-app/src/PlatformId.cpp. <!-- The platform(s) to use when scraping. You can see the full list of supported platforms in es-app/src/PlatformId.cpp.
The entry is case insensitive as it will be converted to lower case during startup. The entry is case insensitive as it will be converted to lower case during startup.
@ -1242,6 +1243,8 @@ The following variables are expanded for the `command` tag:
`%HIDEWINDOW%` - This variable is only available on Windows and is used primarily for hiding console windows when launching scripts (used for example by Steam games and source ports). If not defining this, the console window will be visible when launching games. The variable can be placed anywhere in the launch command. `%HIDEWINDOW%` - This variable is only available on Windows and is used primarily for hiding console windows when launching scripts (used for example by Steam games and source ports). If not defining this, the console window will be visible when launching games. The variable can be placed anywhere in the launch command.
`%ESCAPESPECIALS%` - This variable is only available on Windows and is used to escape the characters &()^=;, which would otherwise make binaries like cmd.exe fail when launching scripts or links. The variable can be placed anywhere in the launch command.
Here are some additional real world examples of system entries, the first one for Unix: Here are some additional real world examples of system entries, the first one for Unix:
```xml ```xml