Documentation update.

This commit is contained in:
Leon Styhre 2022-04-16 12:00:27 +02:00
parent b0b73f4819
commit b5ffd4a2c4
5 changed files with 14 additions and 8 deletions

View file

@ -141,6 +141,7 @@ v1.2 maintenance release.
* Added a scraper setting to convert underscores _ to spaces when searching * Added a scraper setting to convert underscores _ to spaces when searching
* Replaced the RetroArch core 4DO with Opera for the 3do system * Replaced the RetroArch core 4DO with Opera for the 3do system
* Added the .rom file extension to the atari800 system
* Added the .wud and .wux file extensions for the wiiu system on Windows * Added the .wud and .wux file extensions for the wiiu system on Windows
* Added --escape-exit command line option for the PPSSPP standalone emulator * Added --escape-exit command line option for the PPSSPP standalone emulator
* Added -batch command line option for the DuckStation standalone emulator * Added -batch command line option for the DuckStation standalone emulator
@ -148,6 +149,7 @@ v1.2 maintenance release.
* (Windows) Added an "Emulators" directory to all emulators for portable installations * (Windows) Added an "Emulators" directory to all emulators for portable installations
* Added missing scraper entries for samcoupe and zx81 for TheGamesDB and zmachine for ScreenScraper * Added missing scraper entries for samcoupe and zx81 for TheGamesDB and zmachine for ScreenScraper
* neogeocd is now scraped specifically as "Neo Geo CD" instead of the more generic "Neo Geo" * neogeocd is now scraped specifically as "Neo Geo CD" instead of the more generic "Neo Geo"
* (rbsimple-DE) Made the xbox console graphics slightly darker
### Bug fixes ### Bug fixes

View file

@ -6,12 +6,10 @@ Contributions are very much appreciated as there are many things that need to be
In addition to the information below about work on ES-DE itself, the project is currently looking for a developer to create a configuration utility for customizing systems (i.e. to avoid having to manually edit XML configuration files). For various reasons this should be a standalone application, and it needs to be cross-platform with support for Windows, macOS and Linux. Get in touch if you would be interested in working on this! In addition to the information below about work on ES-DE itself, the project is currently looking for a developer to create a configuration utility for customizing systems (i.e. to avoid having to manually edit XML configuration files). For various reasons this should be a standalone application, and it needs to be cross-platform with support for Windows, macOS and Linux. Get in touch if you would be interested in working on this!
Apart from the above there are basically four areas where help is needed: Apart from the above there are basically three areas where help is needed:
* Programming: If you are experienced with developing cross-platform client applications in C++ then ES-DE could be an interesting project! Although the application does not have a huge codebase, it is still fairly complex as it covers many different areas like OpenGL rendering, audio playback, video playback, controller input, network access, XML and JSON parsing etc. To work on the project you need to be able to test your code on Linux, macOS and Windows, but apart from that it should hopefully be fairly straightforward. * Programming: If you are experienced with developing cross-platform client applications in C++ then ES-DE could be an interesting project! Although the application does not have a huge codebase, it is still fairly complex as it covers many different areas like OpenGL rendering, audio playback, video playback, controller input, network access, XML and JSON parsing etc. To work on the project you need to be able to test your code on Linux, macOS and Windows, but apart from that it should hopefully be fairly straightforward.
* Graphics: There are a few different areas where help is needed, but primarily it would be to create game systems vector graphics for the default slate-DE theme as it's missing a lot of assets today. Check out [MISSING.md](themes/slate-DE/MISSING.md) for more details about this.
* Emulator configuration and testing: As one of the main goals of ES-DE is easy setup, the application needs to ship with all game systems preconfigured. This means that the es_systems.xml files have to be populated with both default and alternative emulators for all supported operating systems. There could also be a need to add additional platforms that ES-DE does not support today. Please refer to [USERGUIDE-DEV.md](USERGUIDE-DEV.md#supported-game-systems) for the current game systems status. You can also review the es_systems.xml files directly: [unix/es_systems.xml](resources/systems/unix/es_systems.xml), [macos/es_systems.xml](resources/systems/macos/es_systems.xml) and [windows/es_systems.xml](resources/systems/windows/es_systems.xml). * Emulator configuration and testing: As one of the main goals of ES-DE is easy setup, the application needs to ship with all game systems preconfigured. This means that the es_systems.xml files have to be populated with both default and alternative emulators for all supported operating systems. There could also be a need to add additional platforms that ES-DE does not support today. Please refer to [USERGUIDE-DEV.md](USERGUIDE-DEV.md#supported-game-systems) for the current game systems status. You can also review the es_systems.xml files directly: [unix/es_systems.xml](resources/systems/unix/es_systems.xml), [macos/es_systems.xml](resources/systems/macos/es_systems.xml) and [windows/es_systems.xml](resources/systems/windows/es_systems.xml).
* Theme creation. With ES-DE v2.0 a new theme engine will be introduced with improved capabilities compared to the current engine. Existing themes would need to be ported over to the new engine, potentially also from other frontends than RetroPie EmulationStation. Completely new themes would also be nice to showcase the new engine. * Theme creation. With ES-DE v2.0 a new theme engine will be introduced with improved capabilities compared to the current engine. Existing themes would need to be ported over to the new engine, potentially also from other frontends than RetroPie EmulationStation. Completely new themes would also be nice to showcase the new engine.

View file

@ -11,7 +11,6 @@ https://retropie.org.uk
Leon Styhre (Desktop Edition fork, based on the RetroPie version) \ Leon Styhre (Desktop Edition fork, based on the RetroPie version) \
https://gitlab.com/leonstyhre/emulationstation-de https://gitlab.com/leonstyhre/emulationstation-de
# UI Art & Design # UI Art & Design
Nils Bonenberger Nils Bonenberger
@ -112,6 +111,8 @@ https://wiki.mozilla.org/CA
# slate-DE theme set # slate-DE theme set
Original vector graphics by Matthew Stapleton
Recalbox Multi (slate-DE is based on this theme, using assets from before their change to a more restrictive license in 2018) \ Recalbox Multi (slate-DE is based on this theme, using assets from before their change to a more restrictive license in 2018) \
https://gitlab.com/recalbox/recalbox-themes https://gitlab.com/recalbox/recalbox-themes

View file

@ -1023,7 +1023,7 @@ Properties:
- `broken` - Will be shown when the game is marked as broken. - `broken` - Will be shown when the game is marked as broken.
- `controller` - Will be shown and overlaid by the corresponding controller icon if a controller type has been selected for the game (using the metadata editor or via scraping). - `controller` - Will be shown and overlaid by the corresponding controller icon if a controller type has been selected for the game (using the metadata editor or via scraping).
- `altemulator` - Will be shown when an alternative emulator is setup for the game. - `altemulator` - Will be shown when an alternative emulator is setup for the game.
- `all` - Including this value will enable all badges. If some badges have been added already they will be shown in the order they were defined and the remaining ones will be added at the end, in the order listed above. - `all` - Including this value will enable all badges. If some badges have been added already they will be shown in the order they were defined and the remaining ones will be added at the end, in the order listed above. Using the `all` value can be used as a way to future-proof the theme, because if additional badges are added in future ES-DE releases, no theme updates would be needed to accomodate them. Just make sure to include space for a few extra badges in the layout, and increase the `lines` and `itemsPerLine` accordingly.
* `controllerPos` - type: NORMALIZED_PAIR * `controllerPos` - type: NORMALIZED_PAIR
- The position of the controller icon relative to the parent `controller` badge. - The position of the controller icon relative to the parent `controller` badge.
- Minimum value per axis is `-1` and maximum value per axis is `2` - Minimum value per axis is `-1` and maximum value per axis is `2`

View file

@ -1,10 +1,15 @@
# EmulationStation Desktop Edition (ES-DE) - slate-DE Credits # EmulationStation Desktop Edition (ES-DE) - slate-DE credits
The theme set slate-DE is based on recalbox-multi by the Recalbox community. The theme set slate-DE is based on recalbox-multi by the Recalbox community.
Some graphics was also taken from the carbon theme by Rookervik. Some graphics was also taken from the carbon theme by Rookervik.
## recalbox-multi credits ## Original vector graphics for slate-DE
- Matthew Stapleton
- Leon Styhre
## recalbox-multi
- Supernature2k - Supernature2k
- Paradadf - Paradadf
@ -21,7 +26,7 @@ Some graphics was also taken from the carbon theme by Rookervik.
- Bigboo3000 - Bigboo3000
- Paradadf - Paradadf
## carbon credits ## carbon
- Rookervik - Rookervik
- Nils Bonenberger (original simple theme on which carbon is based) - Nils Bonenberger (original simple theme on which carbon is based)