ES-DE/README.md

81 lines
4.9 KiB
Markdown
Raw Normal View History

2020-12-16 18:27:51 +00:00
# EmulationStation Desktop Edition (ES-DE)
2012-07-18 21:28:26 +00:00
EmulationStation Desktop Edition is a frontend for browsing and launching games from your multi-platform game collection.
2023-04-02 20:33:30 +00:00
Website:\
[https://es-de.org](https://es-de.org)
Discord server:\
[https://discord.gg/EVVX4DqWAP](https://discord.gg/EVVX4DqWAP)
2021-03-05 18:49:31 +00:00
2022-05-15 20:31:51 +00:00
Reddit (r/EmulationStation_DE):\
[https://www.reddit.com/r/EmulationStation_DE](https://www.reddit.com/r/EmulationStation_DE)
2023-02-27 17:17:01 +00:00
YouTube channel with installation instruction videos:\
[https://www.youtube.com/channel/UCosLuC9yIMQPKFBJXgDpvVQ](https://www.youtube.com/channel/UCosLuC9yIMQPKFBJXgDpvVQ)
2023-02-27 17:17:01 +00:00
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.
2023-02-27 17:17:01 +00:00
It comes preconfigured for use with [RetroArch](https://www.retroarch.com) and a large selection of standalone emulators. It's also fully customizable so you can easily expand it to include emulators or applications not covered by the bundled configuration.
2023-02-27 17:17:01 +00:00
You can find the complete list of supported systems and emulators [here](USERGUIDE.md#supported-game-systems).
2023-02-27 17:17:01 +00:00
Two theme sets (Slate and Modern) are bundled with the application, and additional themes can be found on the [official themes list](https://gitlab.com/es-de/themes/themes-list).
2023-02-28 17:39:49 +00:00
## Download
The latest stable version is **2.0.1** (released 2023-04-23)
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.
2021-11-27 10:57:14 +00:00
2023-02-27 17:17:01 +00:00
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).
2023-02-28 17:39:49 +00:00
## Additional information
2020-12-26 15:22:33 +00:00
2023-02-27 17:17:01 +00:00
[FAQ.md](FAQ.md) - Frequently Asked Questions
2022-05-06 17:35:31 +00:00
2023-02-27 17:17:01 +00:00
[USERGUIDE.md](USERGUIDE.md) / [USERGUIDE-DEV.md](USERGUIDE-DEV.md) - Comprehensive guide and reference for all application settings
2023-02-27 17:17:01 +00:00
[INSTALL.md](INSTALL.md) / [INSTALL-DEV.md](INSTALL-DEV.md) - Building from source code and advanced configuration topics
2023-02-27 17:17:01 +00:00
[THEMES.md](THEMES.md) / [THEMES-DEV.md](THEMES-DEV.md) - Guide and reference for theme development
2023-02-27 17:17:01 +00:00
[CHANGELOG.md](CHANGELOG.md) - Detailed list of changes per release
2023-02-27 17:17:01 +00:00
[ROADMAP.md](ROADMAP.md) - High level release plan
2023-02-27 17:17:01 +00:00
[CONTRIBUTING.md](CONTRIBUTING.md) - Information on how to contribute to the project
2023-02-27 17:17:01 +00:00
[CREDITS.md](CREDITS.md) - An attempt to credit the individuals and projects which made ES-DE possible
2023-02-28 17:39:49 +00:00
## Some feature highlights
2020-11-19 16:16:23 +00:00
2023-02-27 17:17:01 +00:00
Here are some highlights, displayed using the default Slate theme set.
2020-11-19 16:16:23 +00:00
![alt text](images/es-de_system_view.png "ES-DE System View")
2020-12-26 15:22:33 +00:00
_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")
2023-02-27 17:17:01 +00:00
_The **Gamelist view**, it's here that you browse the actual games per system._
![alt text](images/es-de_folder_support.png "ES-DE Folder Support")
2023-02-27 17:17:01 +00:00
_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._
![alt text](images/es-de_custom_collections.png "ES-DE Custom Collections")
2023-02-27 17:17:01 +00:00
_Games can be grouped into your own custom collections, in this example they're defined as genres._
![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")
2020-12-26 15:22:33 +00:00
_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")
2023-02-27 17:17:01 +00:00
_In addition to the scraper there is a fully-featured metadata editor that can be used to modify information on a per-game basis._
![alt text](images/es-de_screensaver.png "ES-DE Screensaver")
2023-02-28 17:39:49 +00:00
_There are four built-in screensavers, including a slideshow and a video screensaver that display random games from your collection._
![alt text](images/es-de_ui_theme_support.png "ES-DE Theme Support")
2023-03-01 20:13:18 +00:00
_ES-DE is fully themeable, in case you prefer another look than what the default theme Slate offers. The screenshot above shows the Modern theme that is also bundled with the application._