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 2021-03-05 19:49:31 +01:00
parent 20d616217f
commit 6cacd22858
3 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
CHANGELOG.md
View file

@ -12,7 +12,7 @@ Full navigation sound support has been implemented, and the metadata editor has
OpenGL GLSL shader support has been added (not for the OpenGL ES renderer though) and there are multiple effects implemented such as scanlines for videos, blurred background when opening menus etc. OpenGL GLSL shader support has been added (not for the OpenGL ES renderer though) and there are multiple effects implemented such as scanlines for videos, blurred background when opening menus etc.
A new default theme rbsimple-DE (based on Recalbox Multi) is bundled with the application and is part of the installation package/installer. However themes created for other EmulationStation forks should still work correctly. A new default theme rbsimple-DE (based on Recalbox Multi) is bundled with the application and is part of the installation package/installer. Themes created for the RetroPie EmulationStation fork will still work correctly.
Many bugs have been fixed, and numerous features that were only partially implemented or broken have been updated to a fully working state. The application runs much faster as well due to lots of optimizations. Many bugs have been fixed, and numerous features that were only partially implemented or broken have been updated to a fully working state. The application runs much faster as well due to lots of optimizations.
@ -20,7 +20,7 @@ Many bugs have been fixed, and numerous features that were only partially implem
* Initial version, fork from RetroPie EmulationStation 2.10.0rp-dev (master) * Initial version, fork from RetroPie EmulationStation 2.10.0rp-dev (master)
* Added support for Windows, macOS, FreeBSD, NetBSD and OpenBSD * Added support for Windows, macOS, FreeBSD, NetBSD and OpenBSD
* New default theme rbsimple-DE bundled with the software (this theme is largely based on recalbox-multi by the Recalbox community) * New default theme rbsimple-DE bundled with the software (this theme is largely based on Recalbox Multi by the Recalbox community)
* Added extensive es_systems.cfg templates for Unix, macOS and Windows that are automatically installed on first application startup * Added extensive es_systems.cfg templates for Unix, macOS and Windows that are automatically installed on first application startup
* Added full navigation sound support, configurable per theme with a fallback to the built-in sounds if there is no theme support * Added full navigation sound support, configurable per theme with a fallback to the built-in sounds if there is no theme support
* Added multi-monitor support by giving the option to define on which display to run ES-DE * Added multi-monitor support by giving the option to define on which display to run ES-DE
@ -43,7 +43,7 @@ Many bugs have been fixed, and numerous features that were only partially implem
* Added ability to delete custom collections from the GUI menu * Added ability to delete custom collections from the GUI menu
* Help system updated and expanded to the complete application (previously it was only partially implemented) * Help system updated and expanded to the complete application (previously it was only partially implemented)
* Game systems are now sorted by full names which makes much more sense from a user perspective * Game systems are now sorted by full names which makes much more sense from a user perspective
* In the metadata editor, any values updated by the single-game scraper or by the user are now highlighted using a different font color * In the metadata editor, any values updated by the single-game scraper or by the user are now highlighted using different font colors
* Expanded the metadata for folders and made it possible to mark them as favorites * Expanded the metadata for folders and made it possible to mark them as favorites
* Added metadata entry to mark games as broken/not working (e.g. useful for MAME games) * 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 indicate whether the file should be counted as a game (e.g. useful to exclude setup files and similar for DOS games)
@ -57,10 +57,10 @@ Many bugs have been fixed, and numerous features that were only partially implem
* Added the ability to display pillarboxing and letterboxing for videos with non-standard aspect ratios * Added the ability to display pillarboxing and letterboxing for videos with non-standard aspect ratios
* Custom event scripts can now be enabled or disabled with a menu option * Custom event scripts can now be enabled or disabled with a menu option
* Gamelist sorting is now working as expected and is persistent throughout the application session * Gamelist sorting is now working as expected and is persistent throughout the application session
* Expanded the gamelist filter functionality to include completed and broken games as well as the ability to filter on game names (via a free text entry) * Expanded the gamelist filter functionality to include completed and broken games and added the ability to filter game names via a free text entry
* Added functionality to remember cursor positions inside folders and grouped custom collections * Added functionality to remember cursor positions inside folders and grouped custom collections
* Per-game launch command override, so that different cores or emulators can be used on a per-game basis (saved to gamelist.xml) * Per-game launch command override, so that different cores or emulators can be used on a per-game basis (saved to gamelist.xml)
* The emulator core location can be defined relative to the emulator binary using the %EMUPATH% variable in es_systems.cfg (mostly useful on Windows) * The emulator core location can now be defined relative to the emulator binary using the %EMUPATH% variable in es_systems.cfg (used extensively on macOS and Windows)
* Core locations can be searched from a configurable list of directories if defined in the es_systems.cfg file using the %COREPATH% variable (mostly useful on Unix where there are no standardized core directories) * Core locations can be searched from a configurable list of directories if defined in the es_systems.cfg file using the %COREPATH% variable (mostly useful on Unix where there are no standardized core directories)
* Clear notifications and logging have been added for missing emulator binaries and cores when attempting to launch games * Clear notifications and logging have been added for missing emulator binaries and cores when attempting to launch games
* Overhaul of the screensaver (the game info overlay now works correctly for instance) * Overhaul of the screensaver (the game info overlay now works correctly for instance)
@ -70,9 +70,10 @@ Many bugs have been fixed, and numerous features that were only partially implem
* Replaced the on and off button icons with new graphics * Replaced the on and off button icons with new graphics
* Replaced the checked checkmark icon with new graphics * Replaced the checked checkmark icon with new graphics
* Made ScrollableContainer (used for the gamelist game descriptions) fade in as the text position is reset * Made ScrollableContainer (used for the gamelist game descriptions) fade in as the text position is reset
* Made the ScrollableContainer scroll speed adaptive depending on the font size and width of the text container
* Moved all resources to a subdirectory structure and enabled the CMake install prefix variable to generate the resources search path * Moved all resources to a subdirectory structure and enabled the CMake install prefix variable to generate the resources search path
* Changed theme directory to the install prefix (e.g. /usr/local/share/emulationstation/themes) with themes in the home directory taking precedence * Changed theme directory to the install prefix (e.g. /usr/local/share/emulationstation/themes) with themes in the home directory taking precedence
* No more attempts to open files directly under /etc, instead only the install prefix directory and the home directory are used * No more attempts to open files directly under /etc, instead only the install prefix directory, the ES-DE executable directory and the home directory are used
* Added proper error handling for missing resource files and improved overall logging * Added proper error handling for missing resource files and improved overall logging
* Refactoring, cleanup and documentation of the source code, removal of deprecated files etc. * Refactoring, cleanup and documentation of the source code, removal of deprecated files etc.
* Speed improvements and optimizations, the application now starts faster and feels more responsive * Speed improvements and optimizations, the application now starts faster and feels more responsive
@ -90,7 +91,7 @@ Many bugs have been fixed, and numerous features that were only partially implem
* Updated the CMake/CPack install and package configuration files to work as expected (can now generate DEB, RPM, DMG and NSIS installation packages with correct dependencies) * Updated the CMake/CPack install and package configuration files to work as expected (can now generate DEB, RPM, DMG and NSIS installation packages with correct dependencies)
* Added support for Clang/LLVM, made the application build with no errors or warnings using this compiler (Unix and macOS only) * Added support for Clang/LLVM, made the application build with no errors or warnings using this compiler (Unix and macOS only)
* Added support for both MSVC and MinGW (GCC) on Windows * Added support for both MSVC and MinGW (GCC) on Windows
* License files included for all the libraries and resources that are bundled with the application * License files are now included for all the libraries and resources that are bundled with the application
* Updated the MAME ROM index files to include ROMs up to MAME version 0.226 and created scripts to easily generate these index files in the future * Updated the MAME ROM index files to include ROMs up to MAME version 0.226 and created scripts to easily generate these index files in the future
* Greatly expanded the application documentation (which is hosted in the ES-DE repository on GitLab) * Greatly expanded the application documentation (which is hosted in the ES-DE repository on GitLab)

3
README.md
View file

@ -2,6 +2,9 @@
EmulationStation Desktop Edition is a front-end for browsing and launching games from your multi-platform game collection. EmulationStation Desktop Edition is a front-end for browsing and launching games from your multi-platform game collection.
Web site: [https://es-de.org](https://es-de.org)
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. 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): The current version 1.0 has been tested on the following operating systems (all for the x86 architecture):

2
themes/rbsimple-DE/MISSING.md
View file

@ -8,7 +8,7 @@ None at the moment.
* 64dd : Nintendo 64DD - consolegame.svg, console.svg, game.svg * 64dd : Nintendo 64DD - consolegame.svg, console.svg, game.svg
* ags: Adventure Game Studio - system info, customized colors, consolegame.svg, console.svg, controller.svg * ags: Adventure Game Studio - system info, customized colors, consolegame.svg, console.svg, controller.svg
* amiga: Amiga (general) - system info (needs improvement) * amiga: Amiga (general) - system info (needs improvement), consolegame.svg/console.svg (picture of an Amiga 500 instead of the 1200 model)
* amigacd32: Amiga CD32 - consolegame.svg, console.svg, controller.svg, game.svg * amigacd32: Amiga CD32 - consolegame.svg, console.svg, controller.svg, game.svg
* apple2gs: Apple IIGS - consolegame.svg, console.svg, controller.svg, game.svg * apple2gs: Apple IIGS - consolegame.svg, console.svg, controller.svg, game.svg
* astrocade: Bally Astrocade - system info, customized colors, consolegame.svg, console.svg, controller.svg, game.svg * astrocade: Bally Astrocade - system info, customized colors, consolegame.svg, console.svg, controller.svg, game.svg