Documentation update.

This commit is contained in:
Leon Styhre 2021-03-10 18:32:28 +01:00
parent 2432e118a7
commit 9e7d59953a
3 changed files with 33 additions and 6 deletions

View file

@ -22,6 +22,7 @@ Many bugs have been fixed, and numerous features that were only partially implem
* 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 support for generating the ROM directory structure from within the application based on information in es_systems.cfg
* 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
* Improved input device configuration and default keyboard mappings are now applied if the keyboard has not been configured by the user * Improved input device configuration and default keyboard mappings are now applied if the keyboard has not been configured by the user
@ -69,6 +70,8 @@ Many bugs have been fixed, and numerous features that were only partially implem
* Replaced the main application font with Fontfabric Akrobat * Replaced the main application font with Fontfabric Akrobat
* 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
* Changed the application icons and splash screen color theme from blue to red
* Improved the menu interface on 4:3 aspect ratio displays
* 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 * 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
@ -117,6 +120,7 @@ Many bugs have been fixed, and numerous features that were only partially implem
* The controller D-PAD could not be used for entering the UI mode change passkey * The controller D-PAD could not be used for entering the UI mode change passkey
* Filters were not applied when leaving folders using the back button * Filters were not applied when leaving folders using the back button
* Editing long text entries made the cursor jump outside the editing field * Editing long text entries made the cursor jump outside the editing field
* Long words would sometimes render partly outside the designated text area instead of being abbreviated
* Fixed an annoying gamelist issue that caused the game images and data to be updated and rendered up to six times every time the list was scrolled * Fixed an annoying gamelist issue that caused the game images and data to be updated and rendered up to six times every time the list was scrolled
* Not all input events were logged when running with debug logging activated * Not all input events were logged when running with debug logging activated
* Unknown command line options were silently accepted instead of generating an error and notifying the user * Unknown command line options were silently accepted instead of generating an error and notifying the user

View file

@ -11,10 +11,11 @@ Table of contents:
If you just want to get started as quickly as possible, simply follow these steps: If you just want to get started as quickly as possible, simply follow these steps:
1) Install ES-DE 1) Install ES-DE
2) Install and configure [RetroArch](https://www.retroarch.com) 2) Start the application and press the _Create directories_ button to generate the ROMs directory structure
3) Put your game ROMs in the directories created by the previous step, or see [here](USERGUIDE.md#supported-game-systems) for additional details
4) Install and configure [RetroArch](https://www.retroarch.com)
3) _Windows only: add the RetroArch directory to your system path environmental variable_ 3) _Windows only: add the RetroArch directory to your system path environmental variable_
4) Start RetroArch and install the emulator cores you want to use, see the [end](USERGUIDE.md#supported-game-systems) of this guide which ones are used by default by ES-DE 4) Start RetroArch and install the required emulator cores - to see which ones you need look in the systeminfo.txt files in the directories created by step 2, or again see [here](USERGUIDE.md#supported-game-systems)
5) Put your game ROMs in separate directories per game system under ~/ROMs, again see the end of this guide which directory names should be used
6) Start ES-DE and follow the on-screen instructions to configure your controller 6) Start ES-DE and follow the on-screen instructions to configure your controller
7) Scrape game media for your collection and play some games! 7) Scrape game media for your collection and play some games!
@ -79,13 +80,35 @@ On Unix this means /home/\<username\>/.emulationstation/, on macOS /Users/\<user
On first startup the configuration file `es_settings.cfg` will be generated in the ES-DE home directory, containing all the default settings. A file named `es_systems.cfg` will also be copied from the program resource folder. This file contains the game ROM paths and emulator settings and can be modified if needed. For information on how to do this, refer to the [INSTALL.md](INSTALL.md#es_systemscfg) document. On first startup the configuration file `es_settings.cfg` will be generated in the ES-DE home directory, containing all the default settings. A file named `es_systems.cfg` will also be copied from the program resource folder. This file contains the game ROM paths and emulator settings and can be modified if needed. For information on how to do this, refer to the [INSTALL.md](INSTALL.md#es_systemscfg) document.
There's a log file in the ES-DE home directory named `es_log.txt`, please refer to this in case of any issues as it should hopefully provide information on what went wrong. Starting ES-DE with the --debug flag provides even more detailed information. There's a log file in the ES-DE home directory named `es_log.txt`, please refer to this in case of any issues as it should hopefully provide information on what went wrong. Starting ES-DE with the --debug flag provides even more detailed information.
After ES-DE finds at least one game file, it will populate that game system and the application will start. If there are no game files, an error messsage will be shown, explaining that you need to install your game files into your ROM directory. You will also be given a choice to change the ROM directory if you don't want to use the default one. After ES-DE finds at least one game file, it will populate that game system and the application will start. If there are no game files, a dialog will be shown explaining that you need to install your game files into your ROM directory, and you will also be given a choice to change that ROM directory if you don't want to use the default one. As well you have the option to generate the complete game systems directory structure based on information from es_systems.cfg.
When generating the directory structure, a file named systeminfo.txt will be created in each game system folder which will provide you with some information about the system such as the supported file extensions. Here's an example for the _gc_ system as seen on macOS:
```
System name:
gc
Full system name:
Nintendo GameCube
Supported file extensions:
.gcm .GCM .iso .ISO .wbfs .WBFS .ciso .CISO .gcz .GCZ .elf .ELF .dol .DOL .dff .DFF .tgc .TGC .wad .WAD .7z .7Z .zip .ZIP
Launch command:
/Applications/RetroArch.app/Contents/MacOS/RetroArch -L %EMUPATH%/../Resources/cores/dolphin_libretro.dylib %ROM%
Platform (for scraping):
gc
Theme folder:
gc
```
Be aware that there will be a lot of directories created if using the template es_systems.cfg files bundled with the installation, so it may be a good idea to delete the ones you don't need. Deleting the unnecessary directories also leads to a slightly faster application startup.
![alt text](images/current/es-de_ui_easy_setup.png "ES-DE Easy Setup") ![alt text](images/current/es-de_ui_easy_setup.png "ES-DE Easy Setup")
_This is the error dialog shown if no game files were found. It also lets you configure the ROM directory if you don't want to use the default one. Note that the directory is the real physical path, and that your operating system may present this as a localized path if you are using a language other than English._ _This is the dialog shown if no game files were found. It lets you configure the ROM directory if you don't want to use the default one, and you can also generate the game systems directory structure. Note that the directory is the real physical path, and that your operating system may present this as a localized path if you are using a language other than English._
## Migrating from other EmulationStation forks ## Migrating from other EmulationStation forks

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 64 KiB