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 2023-07-29 12:57:17 +02:00
parent 1f4d55d046
commit f7c6fc1fbb
5 changed files with 14 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
CHANGELOG.md
View file

@ -1,25 +1,32 @@
# EmulationStation Desktop Edition (ES-DE) - Changelog # EmulationStation Desktop Edition (ES-DE) - Changelog
## Version 2.1.2 (in development) ## Version 2.2.0 (in development)
**Release date:** TBD **Release date:** TBD
### Release overview ### Release overview
2.1 maintenance release.
### Detailed list of changes ### Detailed list of changes
* Added support for pasting text into the application (when a text input field is focused) * Added support for pasting text into the application (when a text input field is focused)
* Added support for using most characters (including multi-byte Unicode characters) in custom collection names
* Added a new Utilities menu to the main menu * Added a new Utilities menu to the main menu
* Added an entry to the Utilities menu for rescanning the ROM directory * Added an entry to the Utilities menu for rescanning the ROM directory
* Added a utility for removing orphaned data (game media, gamelist entries and custom collection entries) * Added a utility for removing orphaned data (game media, gamelist entries and custom collection entries)
* Added ares standalone as an alternative emulator for the gamegear, gb, gba, gbc and satellaview systems * Added ares standalone as an alternative emulator for the gamegear, gb, gba, gbc and satellaview systems
* When editing custom collections with really long names, the "Y" helpsystem text now gets abbreviated
* Removed Linux DEB package support from ApplicationUpdater as these packages are no longer provided
* Changed ComponentList to fixed row heights which fixed many alignment issues
* Improved the layout for the scraper and theme downloader to look more consistent across different display aspect ratios
* Made the miximage offline generator GUI sizing more consistent across different display aspect ratios * Made the miximage offline generator GUI sizing more consistent across different display aspect ratios
* Added theme support for the "manual" metadata type for the text element * Added theme support for the "manual" metadata type for the text element
* Updated LunaSVG to 2.3.6
### Bug fixes ### Bug fixes
* (Windows) Wide string conversions were not done correctly which caused issues when filenames contained 4-byte Unicode characters
* (Windows) Attempting to capitalize multi-byte Unicode strings crashed the application if built using the MSVC compiler
* The camera offset in ComponentList was not correctly calculated when reaching the bottom of a list
* The textlist properties selectedBackgroundColor and selectedSecondaryBackgroundColor were not offset by selectorVerticalOffset * The textlist properties selectedBackgroundColor and selectedSecondaryBackgroundColor were not offset by selectorVerticalOffset
* SDL_StartTextInput() was sometimes set when not actually inputting any text * SDL_StartTextInput() was sometimes set when not actually inputting any text

2
FAQ.md
View file

@ -110,7 +110,7 @@ ES-DE uses mostly the same system names as these other frontends, but there are
## Can ES-DE update itself automatically when a new release becomes available? ## Can ES-DE update itself automatically when a new release becomes available?
As of ES-DE 2.1.0 there is a built-in application updater that works with the Linux AppImage releases. And if using the AUR release then updates are handled via the operating system's package manager. Likewise if using RetroDECK, then ES-DE is updated as part of the overall RetroDECK Flatpak. For other package formats and operating systems only a version check and a notification window has been implemented, meaning the new release needs to be manually downloaded from the ES-DE website. The process to manually upgrade ES-DE is covered in the _Upgrading to a newer release_ section of the [User guide](USERGUIDE.md#upgrading-to-a-newer-release). If you find the update notification messages annoying you can change the frequency of update checks between _Always_, _Daily_, _Weekly_, _Monthly_ or _Never_ from the _Other Settings_ menu. There is a built-in application updater that works with the Linux AppImage releases. And if using the AUR release then updates are handled via the operating system's package manager. Likewise if using RetroDECK, then ES-DE is updated as part of the overall RetroDECK Flatpak. For Windows and macOS only a version check and a notification window has been implemented, meaning the new release needs to be manually downloaded from the ES-DE website. The process to manually upgrade ES-DE is covered in the _Upgrading to a newer release_ section of the [User guide](USERGUIDE.md#upgrading-to-a-newer-release). If you find the update notification messages annoying you can change the frequency of update checks between _Always_, _Daily_, _Weekly_, _Monthly_ or _Never_ from the _Other Settings_ menu.
## I can't find any game media links in the gamelist.xml files, where is this data stored? ## I can't find any game media links in the gamelist.xml files, where is this data stored?

2
README.md
View file

@ -18,8 +18,6 @@ Two theme sets (Slate and Modern) are bundled with the application, and addition
## Download ## Download
The latest stable version is **2.1.1** (released 2023-07-16)
Visit https://es-de.org/ to download ES-DE or go to the [package registry](https://gitlab.com/es-de/emulationstation-de/-/packages) where you can also find all previous releases. Visit https://es-de.org/ to download ES-DE or go to the [package registry](https://gitlab.com/es-de/emulationstation-de/-/packages) where you can also find all previous releases.
If you're using a Raspberry Pi or if you run FreeBSD, NetBSD or OpenBSD then you need to compile from source code as no prebuilt packages are provided for these platforms. A detailed build guide is available in [INSTALL.md](INSTALL.md). If you're using a Raspberry Pi or if you run FreeBSD, NetBSD or OpenBSD then you need to compile from source code as no prebuilt packages are provided for these platforms. A detailed build guide is available in [INSTALL.md](INSTALL.md).

12
USERGUIDE-DEV.md
View file

@ -34,14 +34,6 @@ As for display resolutions, the minimum pixel value is 224 and the maximum is 76
The installation procedure is just covered briefly here and may differ a bit for your specific operating system, so in case of problems refer to your system documentation. The installation procedure is just covered briefly here and may differ a bit for your specific operating system, so in case of problems refer to your system documentation.
**Installing the Linux .deb package**
The .deb package is intended for Ubuntu but may work on other Debian-based distributions like Linux Mint and vanilla Debian. Your distribution should include a graphical package installer, but if you prefer to use the command line, run the following which will install ES-DE and resolve any dependencies:
```
sudo apt install ./emulationstation-de-2.1.0-x64.deb
```
**Running the Linux AppImage** **Running the Linux AppImage**
The AppImage release should be usable on most modern x86 64-bit Linux distributions. After download you may have to set the file as executable, such as this: The AppImage release should be usable on most modern x86 64-bit Linux distributions. After download you may have to set the file as executable, such as this:
@ -2681,7 +2673,7 @@ If the theme set in use provides themes for custom collections, then this entry
**Create new custom collection** **Create new custom collection**
This lets you create a completely custom collection with a name of your choice. If the selected name collides with an existing name, a sequence number inside brackets will be appended to the collection name, such as _fighting (1)_ if a _fighting_ collection already existed. Note that custom collection names are always converted to lowercase. This lets you create a completely custom collection with a name of your choice. If the selected name collides with an existing name, a sequence number inside brackets will be appended to the collection name, such as _fighting (1)_ if a _fighting_ collection already existed. Note that the following characters can not be used and will be automatically removed from the collection name: `*",./:;<>\|`
**Delete custom collection** **Delete custom collection**
@ -3101,6 +3093,8 @@ To create a custom collection, go to **Game collection settings** from the main
Choose a name and press enter, let's use the name _Platform_ for this example. Choose a name and press enter, let's use the name _Platform_ for this example.
The following characters can not be used and will be automatically removed from the collection name: `*",./:;<>\|`
The collection will now be created and the collection edit mode will be entered. You can now add games to the collection by navigating to any gamelist and pressing the _Y_ button. Any number of games from any of your game systems can be added. A game can also be part of multiple collections, there is no real limit for this. The collection will now be created and the collection edit mode will be entered. You can now add games to the collection by navigating to any gamelist and pressing the _Y_ button. Any number of games from any of your game systems can be added. A game can also be part of multiple collections, there is no real limit for this.
Removing games works the same way, just press _Y_ to remove it if it's already present in your collection. You can do this either from the gamelist where the game was added, or from the collection itself. Removing games works the same way, just press _Y_ to remove it if it's already present in your collection. You can do this either from the gamelist where the game was added, or from the collection itself.

8
USERGUIDE.md
View file

@ -32,14 +32,6 @@ As for display resolutions, the minimum pixel value is 224 and the maximum is 76
The installation procedure is just covered briefly here and may differ a bit for your specific operating system, so in case of problems refer to your system documentation. The installation procedure is just covered briefly here and may differ a bit for your specific operating system, so in case of problems refer to your system documentation.
**Installing the Linux .deb package**
The .deb package is intended for Ubuntu but may work on other Debian-based distributions like Linux Mint and vanilla Debian. Your distribution should include a graphical package installer, but if you prefer to use the command line, run the following which will install ES-DE and resolve any dependencies:
```
sudo apt install ./emulationstation-de-2.1.0-x64.deb
```
**Running the Linux AppImage** **Running the Linux AppImage**
The AppImage release should be usable on most modern x86 64-bit Linux distributions. After download you may have to set the file as executable, such as this: The AppImage release should be usable on most modern x86 64-bit Linux distributions. After download you may have to set the file as executable, such as this: