diff --git a/wiki-rtd/docs/wiki_emulationStation_de/esde-guide.md b/wiki-rtd/docs/wiki_emulationStation_de/esde-guide.md new file mode 100644 index 00000000..56b11500 --- /dev/null +++ b/wiki-rtd/docs/wiki_emulationStation_de/esde-guide.md @@ -0,0 +1,99 @@ +# EmulationStation Desktop Edition: User Guide + +RetroDECK uses EmulationStation Desktop Edition (ES-DE) as frontend. + +The official EmulationStation Desktop Edition user guide is over at their gitlab.
+[EmulationStation Desktop Edition user guide](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md) + +Note that the guide is written in a general way for the application and not how RetroDECK handles certain configurations. Also note that RetroDECK is currently not shipped with all the emulators ES-DE supports in the user guide. + +_EmulationStation Desktop Edition (ES-DE) and it's guide is written by [Leon Styhre](https://gitlab.com/leonstyhre)
+ Published under the MIT-Licence._ + +What follows is a list of recommended sections of the User Guide with links. + +## General Interface & navigation +What follows are links to parts of the EmulationStation DE user guide that talks about general settings and navigation. + +### Navigation + +#### General navigation +These are the buttons mappings automatically applied by ES-DE.
+[General navigation](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#general-navigation) +If you are using the Steam Deck look at RetroDECKs hotkeys: +[Steam Deck: Hotkeys ](https://github.com/XargonWan/RetroDECK/wiki/Steam-Deck:-Hotkeys) + +### Settings + +#### General UI Settings +Various settings that affect the user interface.
+[UI Settings](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#ui-settings) + +#### Other UI settings +These are mostly technical settings.
+[Other UI settings](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#other-settings) + +#### General Sound Settings +Various sound settings.
+[Sound settings](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#sound-settings) + +### Game settings and filters + +#### Game options men +Various navigation for the game options menu.
+[Game options menu](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#game-options-menu) + +#### Game collections +ES-DE provides two types of collections, Automatic collections and Custom collections, the latter being defined by the user. Collections are as the name implies only collections of games already present in your actual game systems, so they're basically grouping of games into convenient views.
+[Game collections](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#game-collections) + +#### Set alternative emulator. +ES-DE allows you to change emulators for systems that has many different emulators.
+[Set alternative emulator](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#other-settings-1) + +## Scraper + +What follows are links to parts of the EmulationStation DE user guide that talks about scraping and editing metadata. + +### Emulation Station DE: User Guide on themes +Contains the various options for the scraper, which is used to download metadata, images and videos for your games.
+[Scraper guide](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#scraping) + +### Scraper account settings +Setup of ScreenScraper account.
+[Scraper account settings](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#account-settings) + +### Content Settings +Describes the content types to include in the scraping.
+[Content settings](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#content-settings) + +### How to: Manually copy custom media files (images, videos etc..) +How to add custom media files to the ES-DE interface. For example you want other images then those on screenscraper or the game you add don't exists.
+[How to: Manually copy custom media files](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#manually-copying-game-media-files) + +### Miximage settings +These are the settings for the miximage generator, which can either be run from the scraper (single-game scraper or multi-scraper) or from the offline generator. The miximage combines the screenshot, marquee, box/cover and physical media images to make a composite picture that is displayed in the gamelist view. There are various settings for the generator.
+ +[Miximage settings](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#miximage-settings) + +### Various other scraping settings.
+[Other scraper settings](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#other-settings) + +## Metadata editor +In the metadata editor, you can modify the metadata, scrape for game info and media files, clear the entry which will delete all metadata and game media files, or delete the entire game which also removes its file on the filesystem.
+[Metadata editor](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#metadata-editor) + + +## Video and Media + +### Video screensaver settings +Options specific to the video screensaver.
+[Video screensaver settings](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#video-screensaver-settings) + +### Media viewer settings +Settings for the media viewer that is accessible from the gamelist views.
+[Media viewer settings](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#media-viewer-settings) + +### Slideshow screensaver settings +Options specific to the slideshow screensaver.
+[Slideshow screensaver settings](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#slideshow-screensaver-settings) diff --git a/wiki-rtd/docs/wiki_emulationStation_de/esde-themes.md b/wiki-rtd/docs/wiki_emulationStation_de/esde-themes.md new file mode 100644 index 00000000..77442479 --- /dev/null +++ b/wiki-rtd/docs/wiki_emulationStation_de/esde-themes.md @@ -0,0 +1,44 @@ +# EmulationStation Desktop Edition: Themes + +This section in the ES-DE User guide tells you how to use themes.
+[Theme settings](https://gitlab.com/es-de/emulationstation-de/-/blob/master/USERGUIDE.md#themes) + +What follows is a short summery. + +## How to switch between themes? +Go into `Main Menu` - `UI Settings` - `Theme Set` to select the theme you want to use. + +## ES-DE Theme List +Look over at the [Theme List](https://gitlab.com/es-de/themes/themes-list) and find themes you like. + +## How do I add additional themes? + +RetroDECK uses [ES-DE](https://www.es-de.org) for its interface so any theme that is compatible with ES-DE can also be used with RetroDECK + +### From the Theme Downloader + +Go into `Main Menu` - `UI Settings` - `Theme Downloader` from there you can download a wide array of themes. + +### From the Internet +If you find a theme you would like to use that is not in the `Theme Downloader` please download it and place it in `~/retrodeck/themes` (make sure the theme has its own folder in that directory). + +## FAQs: Frequently asked questions on Themes + +["Why does the theme I am using not work?" or "Why does the layout look broken?" (black screen with blue text)](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#why-does-the-theme-i-am-using-not-work-or-why-does-the-layout-look-broken-black-screen-with-blue-text) + +[Why does the theme layout look squished?](https://github.com/XargonWan/RetroDECK/wiki/FAQs:-Frequently-asked-questions#why-does-the-theme-layout-look-squished) + +# RetroDECK: Included Theme + +## Art Book Next + +| System View | Gamelist View | +|----|----| +| ![rd-theme-ArtBookNext-SystemView](https://user-images.githubusercontent.com/1454947/193457029-9a7a1207-fe05-4cd1-8b18-eb4112e903e9.jpeg)| ![rd-theme-ArtBookNext-GamelistView](https://user-images.githubusercontent.com/1454947/193457123-505ccd23-6477-43d8-baaa-1360ed3c250e.jpeg) | + +**Description:**
+Art Book Next is a theme that tries to emulate the feeling of flipping trough your game library as if they where pages of a coffee table book. + +Source: [Art Book Next on Github](https://github.com/anthonycaccese/art-book-next-retropie)
+Created by: [anthonycaccese](https://github.com/anthonycaccese) + diff --git a/wiki-rtd/mkdocs.yml b/wiki-rtd/mkdocs.yml index 472e7406..39f0f757 100644 --- a/wiki-rtd/mkdocs.yml +++ b/wiki-rtd/mkdocs.yml @@ -26,6 +26,10 @@ nav: - Linux Desktop - Installation and Updates: wiki_devices/linux_desktop/linux-install.md - Linux Desktop - Software Recommendations: wiki_devices/linux_desktop/linux-software.md + - EmulationStation-DE Guides: + - ES-DE User Guide: wiki_emulationStation_de/esde-guide.md + - ES-DE Themes: wiki_emulationStation_de/esde-themes.md + - Emulator Guides: - RPCS3: wiki_emulator_guides/rpcs3-guide.md - Yuzu: wiki_emulator_guides/yuzu-guide.md