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

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2024-03-10 18:10:41 +01:00
parent 8a91c558db
commit c75e0aaaba
5 changed files with 35 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CHANGELOG.md
View file

@ -18,15 +18,20 @@
* Added the .neo file extension to the arcade, mame and neogeo systems
* Added the .chd file extension to the sega32x, sega32xjp and sega32xna systems
* (Android) Changed the required filename for the Fake-08 RetroArch core from libfake08-arm64.so to fake08_libretro_android.so
* Improved the layout for the miximage generator interface for some unusual display resolutions and aspect ratios
* (Android) Increased the maximum waiting time for the storage mount retry loop from 3 to 4 seconds
* Improved resilience to empty gamelist.xml files (they can now be updated instead of generating an error)
* (Linux and Unix) Made it possible to change the application data directory using the ESDE_APPDATA_DIR environment variable
* (Android) Removed symlink support
* Removed the "v" before the version number from the version printout on application startup and from the main menu
* Updated SDL to 2.30.1 on Android, Windows, macOS and the Linux AppImage builds
* Eliminated some deprecation warnings when building against FFmpeg 6.1 or higher
### Bug fixes
* (Android) The supergrafx system had the Beetle SuperGrafx and Beetle PCE RetroArch cores mixed up
* (Windows) The MAME standalone emulator entry for the atari7800 system had the wrong machine type defined
* The Orphaned data cleanup interface didn't display the complete description text at some unusual display resolutions
* (linear-es-de) Creating custom collections named "now-playing" or "completed" could lead to them being unthemed
## Version 3.0.0-17 (Android intermediate)

14
INSTALL-DEV.md
View file

@ -1065,6 +1065,20 @@ As well, passing the option --ignore-gamelist will disable the ParseGamelistOnly
The --ignore-gamelist option is only active during the program session and is not saved to es_settings.xml. But --gamelist-only is however saved, so in order to return to the normal operation of parsing the gamelist.xml files after starting ES-DE with the --gamelist-only option, you will need to disable the setting _Only show games from gamelist.xml files_ in the _Other settings_ menu (or manually change the ParseGamelistOnly entry in es_settings.xml).
## Changing the application data directory
On all platforms except Android and Windows it's possible to change the application data directory to something else than ~/ES-DE if you prefer that. This is accomplished using the ESDE_APPDATA_DIR environment variable, for example like the following:
```
ESDE_APPDATA_DIR=~/.config/ES-DE ./ES-DE_x64.AppImage
```
Or like this:
```
export ESDE_APPDATA_DIR=~/.config/ES-DE
./ES-DE_x64.AppImage
```
## Settings not configurable via the GUI
There are some settings which are not configurable via the GUI as modifying these should normally not be required. To still change these, edit the es_settings.xml file directly.

14
INSTALL.md
View file

@ -1063,6 +1063,20 @@ As well, passing the option --ignore-gamelist will disable the ParseGamelistOnly
The --ignore-gamelist option is only active during the program session and is not saved to es_settings.xml. But --gamelist-only is however saved, so in order to return to the normal operation of parsing the gamelist.xml files after starting ES-DE with the --gamelist-only option, you will need to disable the setting _Only show games from gamelist.xml files_ in the _Other settings_ menu (or manually change the ParseGamelistOnly entry in es_settings.xml).
## Changing the application data directory
On all platforms except Android and Windows it's possible to change the application data directory to something else than ~/ES-DE if you prefer that. This is accomplished using the ESDE_APPDATA_DIR environment variable, for example like the following:
```
ESDE_APPDATA_DIR=~/.config/ES-DE ./ES-DE_x64.AppImage
```
Or like this:
```
export ESDE_APPDATA_DIR=~/.config/ES-DE
./ES-DE_x64.AppImage
```
## Settings not configurable via the GUI
There are some settings which are not configurable via the GUI as modifying these should normally not be required. To still change these, edit the es_settings.xml file directly.

2
THEMES-DEV.md
View file

@ -22,7 +22,7 @@ To test whether your theme includes support for all ES-DE systems, download one
[ROMs_ALL_macOS.zip](tools/system-dirs-dummy-files/ROMs_ALL_macOS.zip)\
[ROMs_ALL_Windows.zip](tools/system-dirs-dummy-files/ROMs_ALL_Windows.zip)
If you unzip and temporarily replace your ROMs directory with one of these, every system will be enabled on startup.
If you unzip and temporarily replace your ROMs directory with one of these, every system will be enabled on startup. Just make sure to use 7-Zip if you are using Windows as there is a bug in the built-in compression utility which leads to extensionless files not getting unpacked.
It's recommended to use a proper code editor for theme development, such as [VSCode](https://code.visualstudio.com) with the [Red Hat XML extension](https://github.com/redhat-developer/vscode-xml).

2
THEMES.md
View file

@ -20,7 +20,7 @@ To test whether your theme includes support for all ES-DE systems, download one
[ROMs_ALL_macOS.zip](tools/system-dirs-dummy-files/ROMs_ALL_macOS.zip)\
[ROMs_ALL_Windows.zip](tools/system-dirs-dummy-files/ROMs_ALL_Windows.zip)
If you unzip and temporarily replace your ROMs directory with one of these, every system will be enabled on startup.
If you unzip and temporarily replace your ROMs directory with one of these, every system will be enabled on startup. Just make sure to use 7-Zip if you are using Windows as there is a bug in the built-in compression utility which leads to extensionless files not getting unpacked.
It's recommended to use a proper code editor for theme development, such as [VSCode](https://code.visualstudio.com) with the [Red Hat XML extension](https://github.com/redhat-developer/vscode-xml).