Xargon/ES-DE
1
0
Fork 0
mirror of https://github.com/RetroDECK/ES-DE.git synced 2024-11-21 13:45:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation update

Browse source
This commit is contained in:
Leon Styhre 2023-05-19 20:49:08 +02:00
parent 67e09478dc
commit e2c9da9891
3 changed files with 42 additions and 89 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
FAQ.md
View file

@ -132,7 +132,7 @@ The second reason for double input is buggy controller drivers. This seems to on
## I'm missing a feature, how can I make a request to have it added?
First check the project [Kanban](https://gitlab.com/es-de/emulationstation-de/-/boards/1823720) board which contains an overview of planned future features and changes and search for the functionality you would like to see added. Chances are there is already a card on the board describing precisely what you intended to request. You can also check the [Release roadmap](ROADMAP.md) which includes the planned implementation of major features. If you can't find the feature you're looking for, you can request it either via adding an issue directly to the Kanban board, or by asking for it in our [Discord](https://discord.gg/EVVX4DqWAP) server.
First check the project [Kanban](https://gitlab.com/es-de/emulationstation-de/-/boards/1823720) board which contains an overview of planned future features and search for the functionality you would like to see added. Chances are there is already a card on the board describing what you intended to request. You can also check the [Roadmap](ROADMAP.md) document which contains a list of planned major features. If you can't find the feature you're looking for, you can request it either via adding an issue directly to the Kanban board, or by asking for it in our [Discord](https://discord.gg/EVVX4DqWAP) server.
## I want to setup a gaming appliance based on the Raspberry Pi, can I use ES-DE for this?

6
README.md
View file

@ -5,7 +5,7 @@ EmulationStation Desktop Edition is a frontend for browsing and launching games
Website:\
[https://es-de.org](https://es-de.org)
Discord server:\
Discord:\
[https://discord.gg/EVVX4DqWAP](https://discord.gg/EVVX4DqWAP)
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.
@ -34,9 +34,9 @@ If you're using a Raspberry Pi or if you run FreeBSD, NetBSD or OpenBSD then you
[THEMES.md](THEMES.md) / [THEMES-DEV.md](THEMES-DEV.md) - Guide and reference for theme development
[CHANGELOG.md](CHANGELOG.md) - Detailed list of changes per release
[CHANGELOG.md](CHANGELOG.md) - Detailed list of changes for all past releases and the in-development version
[ROADMAP.md](ROADMAP.md) - High level release plan
[ROADMAP.md](ROADMAP.md) - List of major features planned to be added in the future
[CONTRIBUTING.md](CONTRIBUTING.md) - Information on how to contribute to the project

123
ROADMAP.md
View file

@ -1,94 +1,47 @@
# EmulationStation Desktop Edition (ES-DE) - Release roadmap
# EmulationStation Desktop Edition (ES-DE) - Feature roadmap
This roadmap is under constant review so expect it to change from time to time.
ES-DE is developed using an agile methodology so which features to include per release is reviewed and adjusted continuously. As such this document is basically a list of the main features that are planned to be added eventually.
A more detailed breakdown can be found on the [Kanban](https://gitlab.com/es-de/emulationstation-de/-/boards) board, and for previous releases the [Changelog](CHANGELOG.md) contains all relevant details.
#### _v1.0_
* _New gamelist sorting and media handling logic_
* _Overhaul of the menu system_
* _Scraping of additional image types as well as videos_
* _OpenGL shader support for blurred backgrounds, scanline rendering etc._
* _Navigation sound support_
* _A comprehensive theme set bundled with the application_
* _Ports for Windows, macOS and BSD Unix_
* _Preconfigured systems configuration files for all supported operating systems_
* _A detailed user guide_
#### _v1.1_
* _Mix image generation based on screenshots, 3D boxes and marquee files (as in Skyscraper)_
* _Ability to display game media in full screen from the gamelist view_
* _Proper game launching screen_
* _New FFmpeg-based video player_
* _Better method to find installed emulators and cores_
* _Move to the SDL2 GameController API_
* _Different button graphics and names applied depending on controller type (Xbox, PlayStation or SNES style)_
#### _v1.2_
* _Support for pre-defined alternative emulators and cores (configured in es_systems.xml)_
* _Badges highlighting things like favorite games, completed games etc. (will require theme support)_
* _Virtual (on-screen) keyboard_
* _Support for the Raspberry Pi 4 (Raspberry Pi OS)_
* _Improve fullscreen support and make game launching more seamless, remove the temporary fullscreen hacks_
* _Add GLM library dependency for matrix and vector operations, decommission the built-in functions_
* _AppImage and AUR releases on Linux_
#### _v2.0_
* _New theme engine with generalized views (only System and Gamelist) and theme variants support_
* _Multiple new components (carousel support for the Gamelist view, grid component etc.)_
* _Support for Tate mode, i.e. vertical screen orientation for arcade cabinets and similar_
* _Lottie animation (vector graphics) and GIF animation support_
* _OpenGL ES 3.0 renderer for use on the Raspberry Pi_
* _Replace the OpenGL fixed function pipeline renderer with a shader-based renderer_
* _Replace NanoSVG with a more capable SVG rendering library_
* _Improve text and font functions, e.g. dynamic texture allocation and faster and cleaner text wrapping_
* _Improve GLSL shader post-processing performance_
* _Theme downloader_
#### v2.1 (in development)
* Theme engine composite element support for enabling advanced and finely controlled layouts
* Theme engine element animation support (storyboards)
* New texture/cache manager with improved memory management and performance
* Better and more accurate RAM and VRAM usage statistics
* Scraping of game manuals and maps plus a viewer for these (with PDF and raster image support)
* Support for additional scraper services
* Checksum support for the scraper for exact searches and for determining when to overwrite files
* _Selection between light and dark color schemes for the menu system_
**General functionality**
* Game manual viewer (PDF documents)
* RetroAchievements.org integration
#### v2.2
* Removal of legacy theme support
* Background music
* Proper audio mixer
* Controller button mappings from inside ES-DE (similar to pad2key in Batocera)
* Reorganize the menus, possibly adding basic/advanced modes
* Reduced amount of gamelist reloading to retain cached textures and improve overall performance
* Add "time played" counter per game, similar to how it works in Steam
* Replace the built-in Unicode functions and lookup tables with those of the ICU library
* Add text kerning support using the HarfBuzz library
#### v2.3
* Vulkan renderer for all supported operating systems
* Use of MoltenVK to get Metal support on macOS
* Localization/multi-language support
* "Time played" counter per game, similar to how it works in Steam
* Bulk metadata editor
* Scrollbar component for the gamelist view which can be used by themes
* Simple file browsing component
* Web proxy support for the scraper
* Improve multi-threading
#### v2.4
* Mouse/touch screen support
* Animated menu elements like switches and tick boxes
* Migration tools for importing game metadata and media from other frontend applications
* Background music
* Controller button mappings from inside ES-DE (similar to pad2key in Batocera)
* Localization/multi-language support
* Audit tools to clean up orphaned gamelist entries, media files etc.
* Auto-import tools for Steam, Lutris etc.
* Replace the abandoned FreeImage library
**User interface**
* Selection between light and dark color schemes for the menu system
* Menu reorganization, possibly adding basic/advanced modes
* Animated menu elements like switches and tick boxes
* Simple file browsing component
**Theme engine**
* Composite element support for enabling advanced and finely controlled layouts
* Element animation support (storyboards)
* Scrollbar component for the system and gamelist views
* Removal of legacy theme support
**Scraper**
* Scraping of game manuals
* Checksum support for the scraper for exact searches and for determining when to overwrite files
* Support for additional scraper services
**Infrastructure**
* New texture/cache manager with improved memory management and performance
* Better and more accurate RAM and VRAM usage statistics
* Vulkan renderer for all supported operating systems (via MoltenVK on macOS)
* Proper audio mixer
* Improved multi-threading
* Reduced amount of gamelist reloading to retain cached textures and improve overall performance
* Replace the built-in Unicode functions and lookup tables with those of the ICU library
* Text kerning support using the HarfBuzz library
* Replacement for the abandoned FreeImage library