Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-22 14:15:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
ES-DE/README.md
Leon Styhre 79ff784721 Squashed 'external/rlottie/' changes from bf3d272df..875626965 
875626965 Check border of color table while generating gradient
d1636c7b4 Ignore animations with objects of unspecified type
f3eed9a33 add formal parameter void to lottie_init() and lottie_shutdown()
519bd08b0 Add lottie_init() and lottie_shutdown() c api.
447cb7dd1 replace unsigned int with uint32_t in Int()
d7cf0a5ab replace uint ushort and uchar typedefs with uint32 uint16 and uint8 -- added format script to run clang format on latest commit.
16beec845 lottiemodel: Improve opacity calculation for gradient stop
327fb7dba Reject reversed frames
625bc4c48 Finite loop in VBezier::tAtLength()
ddbc9dce7 rlottie/capi: Add missing multiply for Path
c0e16e571 Check Layer.mExtra and Transform.mExtra before dereferencing
9f78532c8 Avoid access to last element of empty mChildren vector
4e08acd8c remove RAPIDJSON_ASSERT() by placing the parser in error state
7affa78fe Fix dereferencing of null pointer in model::Layer::solidColor() getter
9d17ff8e6 Skip dash array of size one or zero
f379dfe15 add the /inc folder as an include path at build time
194b31736 Improve matte rendering performance for simple layer
7c5b40cbb CMake: fix MSVC warnings
fa44b753e fix compileing error
41f906480 On windows, stbi__fopen opens a path containing non-English characters or symbols will fail due to encoding problems, so the filename parameter is assumed to be utf-8 and converted to utf-16, and then call _wfopen_s or _wfopen
29b391b95 add lottie_configure_model_cache_size() c api
3cd00151c Fix comparison
bd4c4e1f8 MT and MTd
c593b57eb Remove link warnings on MSVC
132ca0a00 #include "fix" for rust-bindgen
c9780b46d Fix CMake build in subdirectory
1cb2021d6 Fix crash when path animation  data is empty
ad9beaec6 Added support for RoundedCornor objects.
a41bd7383 rlottie: draw line if width or height is 0
ed94baf14 resource: polish player png image.
9b4c4d2af resource: add rlottie_player image.
2d7b1fa2b Fixed build with GCC 11.
9cd9a6e95 vs2019: Add release build option
d733e953b updated AUTHORS
fc760ef92 updated AUTHORS
d92d4aaf6 wasm: Add extra functions for lottie animation to use them in rlottie viewer
09662b89d updated AUTHORS
71fbff5d5 example/win32Player: removed unnecessary files.
d25911e6c add app executables
538dfd9aa rename directory rlottiePlayer to win32Player
6fbb67d49 fix openJSONFileDialog
85856dff3 fix animation replace error
f86e97d65 fix animation bitmap size to be set dynamically
55815b2cb move function prototype to animation.h To prevent function prototype duplicate code in source.cpp.
9a71eeca9 add an example of win32 app that play rlottie animation by vs2019
619320cbb add rlottiePlayer Project
4884e0e9b Modify: Update .gitignore
3ebf0c7e3 Docs: Fix README typo
502cc3638 updated license in spec file.
e812ba9e9 Docs: Fix README typo
c98ec565d Update README.md
33295c22f Fixed README typo
073224e69 fixed readme typo
ff8ddfc49 ci: upgrade windows build chain to VS2017
10c1055a3 fixed sign extension warning
98ed2620a build: use shared_module instead of shared_library

git-subtree-dir: external/rlottie
git-subtree-split: 875626965959d8e269ca22175c8e1ad190696c43
2022-01-07 18:43:06 +01:00

113 lines
10 KiB
Markdown
Raw Blame History

# EmulationStation Desktop Edition (ES-DE)
EmulationStation Desktop Edition is a frontend for browsing and launching games from your multi-platform game collection.
Web site:\
[https://es-de.org](https://es-de.org)
YouTube channel with installation instruction videos:\
[https://www.youtube.com/channel/UCosLuC9yIMQPKFBJXgDpvVQ](https://www.youtube.com/channel/UCosLuC9yIMQPKFBJXgDpvVQ)
Discord server:\
[https://discord.gg/EVVX4DqWAP](https://discord.gg/EVVX4DqWAP)
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. Windows, macOS and Unix/Linux. 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 software comes preconfigured for use primarily with [RetroArch](https://www.retroarch.com), although this can be changed as all emulator settings are fully configurable, even on a per-game basis.
Two comprehensive theme sets, **rbsimple-DE** and **modern-DE** are bundled with the application.
The following operating systems have been tested (all for the x86 architecture unless otherwise stated):
* Windows 10
* Windows 8.1
* macOS 10.14 "Mojave" to 12 "Monterey" (the M1 processor is supported via Rosetta 2)
* macOS 10.11 "El Capitan" (legacy release)
* Ubuntu 20.04 to 21.10
* Linux Mint 20.2
* Manjaro 21.1
* Fedora 35 Workstation
* elementary OS 6
* Raspberry Pi OS 10 and 11 (armv7l and aarch64)
* FreeBSD 13.0
* NetBSD 9.1
* OpenBSD 6.8
If using a Mac with an M1 processor you need to install the x86 version of RetroArch and any other emulators, or you won't be able to launch any games. This will be fixed whenever a native macOS M1 build of ES-DE is released.
### Download
The latest version is 1.2.0 (released 2021-12-28)
| Package | Operating systems | Architecture | Download link |
| :------------------- | :------------------------------------------------------ | :----------- | :------------- |
| Windows installer | Windows 10 and 8.1 (probably Windows 11 as well) | x64 (x86) | [EmulationStation-DE-1.2.0-x64.exe](https://gitlab.com/leonstyhre/emulationstation-de/-/package_files/25023950/download)|
| macOS DMG installer | macOS 10.14 "Mojave" to 12 "Monterey" | x64 (x86) | [EmulationStation-DE-1.2.0-x64.dmg](https://gitlab.com/leonstyhre/emulationstation-de/-/package_files/25023939/download)|
| macOS DMG installer | Legacy macOS 10.11 "El Capitan" to 10.13 "High Sierra" | x64 (x86) | [EmulationStation-DE-1.2.0-x64_legacy.dmg](https://gitlab.com/leonstyhre/emulationstation-de/-/package_files/25023954/download)|
| Debian DEB package | Ubuntu 20.04 to 21.10, Linux Mint 20.2, possibly others | x64 (x86) | [emulationstation-de-1.2.0-x64.deb](https://gitlab.com/leonstyhre/emulationstation-de/-/package_files/25023934/download)|
| Fedora RPM package | Fedora Workstation 35, possibly others | x64 (x86) | [emulationstation-de-1.2.0-x64.rpm](https://gitlab.com/leonstyhre/emulationstation-de/-/package_files/25023958/download)|
| Arch User Repository | Arch Linux, Manjaro, possibly others | x64 (x86) | [https://aur.archlinux.org/packages/emulationstation-de](https://aur.archlinux.org/packages/emulationstation-de)|
| Linux AppImage | Most modern Linux distributions | x64 (x86) | [emulationstation-de-1.2.0-x64.AppImage](https://gitlab.com/leonstyhre/emulationstation-de/-/package_files/25023919/download)|
| Debian DEB package | Raspberry Pi OS (Raspian) | ARM 32-bit | [emulationstation-de-1.2.0-armv7l.deb](https://gitlab.com/leonstyhre/emulationstation-de/-/package_files/25023905/download)|
| Debian DEB package | Raspberry Pi OS (Raspian) | ARM 64-bit | [emulationstation-de-1.2.0-aarch64.deb](https://gitlab.com/leonstyhre/emulationstation-de/-/package_files/25023885/download)|
All previous releases can be downloaded from [here](https://gitlab.com/leonstyhre/emulationstation-de/-/packages).
Flatpak will not be supported on Linux as this packaging system is too restrictive with its sandbox approach, making ES-DE virtually useless as it can't freely locate and launch emulators on the system.
If using FreeBSD, NetBSD or OpenBSD you will need to build ES-DE from source code for the time being, as explained in [INSTALL.md](INSTALL.md).
Please refer to [CHANGELOG.md](CHANGELOG.md) for more information about the releases, including known issues.
### Contributing
If you would like to contribute to the development of ES-DE, then that's great! Please read how to participate [here](CONTRIBUTING.md) where you can also read about planned future releases and features.
# Additional information
[USERGUIDE.md](USERGUIDE.md) is a comprehensive guide on how to use ES-DE and it also contains a complete reference to all application settings.
[CHANGELOG.md](CHANGELOG.md) contains information about the current release as well as previous releases. This covers the features, improvements, bug fixes and known issues.
[INSTALL.md](INSTALL.md) provides details on how to build the application from source code, and also discusses some more advanced configuration topics.
[CREDITS.md](CREDITS.md) is an attempt to credit the individuals and projects which made ES-DE possible.
[THEMES.md](THEMES.md) is a guide on how theming works which is useful for those who would like to develop a new theme, or perhaps customize an existing theme.
# Some feature highlights
Here are some highlights of what ES-DE provides, displayed using the default theme set rbsimple-DE. There are of course many more features available, as covered in the [User guide](USERGUIDE.md).
![alt text](images/es-de_system_view.png "ES-DE System View")
_The **System view**, which is the default starting point for the application, it's here that you browse through your game systems._
![alt text](images/es-de_gamelist_view.png "ES-DE Gamelist View")
_The **Gamelist view**, it's here that you browse the actual games per system. Note the support for mixing files and folders, and as well that a few badges are displayed indicating that the selected game is a favorite, that it's suitable for children and that it's controlled using a joystick. There is a game counter to the upper right as well, displaying the total number of games and the number of favorite games for this system._
![alt text](images/es-de_folder_support.png "ES-DE Folder Support")
_Another example of the gamelist view, displaying advanced folder support. You can scrape folders for game info and game media, sort folders as you would files, mark them as favorites etc. In this example ES-DE has been configured to sort favorite games above non-favorites._
![alt text](images/es-de_custom_collections.png "ES-DE Custom Collections")
_Games can be grouped into your own custom collections, in this example they're defined as game genres but you can name them anything you like. All gamelist views including the custom collections support both game images or game videos. By default the rbsimple-DE theme will display the game image for a short moment before starting to play the video._
![alt text](images/es-de_scraper_running.png "ES-DE Scraper Running")
_This is a view of the built-in scraper which downloads game info and game media from either [screenscraper.fr](https://screenscraper.fr) or [thegamesdb.net](https://thegamesdb.net). It's possible to scrape a single game, or to run the multi-scraper which can scrape a complete game system or even your entire collection._
![alt text](images/es-de_scraper_settings.png "ES-DE Scraper Settings")
_There are many settings for the scraper including options to define which type of info and media to download. The above screenshot shows only a portion of these settings._
![alt text](images/es-de_metadata_editor.png "ES-DE Metadata Editor")
_In addition to the scraper there is a fully-featured metadata editor that can be used to modify information on a per-game basis. Here you can also toggle some additional flags which the scraper does not set, such as if the game is a favorite or if you have completed it. Most of these flags can also be filtered in the gamelist view, letting you for instance only display games that you have not played through._
![alt text](images/es-de_screensaver.png "ES-DE Screensaver")
_There are four types of built-in screensavers available, including a slideshow and the video screensaver shown in action above. These screensavers start after a configurable number of minutes of inactivity, and randomly display game media that you have previously scraped. If the corresponding option has been enabled, you can jump to the game from the screensaver, or even launch it directly. There is shader support in ES-DE to render scanlines and screen blur on top of the videos (for the slideshow screensaver, scanline rendering is provided)._
![alt text](images/es-de_ui_theme_support.png "ES-DE Theme Support")
_ES-DE is fully themeable, so if you prefer another look than what the default theme rbsimple-DE offers, it's possible to apply another theme set. The image above is of the modern-DE theme that is also bundled with the application. Note that although ES-DE is backward compatible with older RetroPie EmulationStation themes, some newer features which are specific to ES-DE will not work, at least not until the theme authors update their themes._
![alt text](images/es-de_ui_easy_setup.png "ES-DE Easy Setup")
_A lot of effort has been spent on making ES-DE easy to setup and use. The above screenshot shows the dialog if starting the application without any game files present in the default ROM directory. ES-DE also ships with a comprehensive game systems configuration file, so unless you really want to customize your setup, you should not need to tinker with the configuration._
Reference in a new issue View git blame Copy permalink