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-02-28 18:39:49 +01:00
parent 6dc3a2011c
commit 9310ce6f8d
7 changed files with 32 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md
View file

@ -44,11 +44,14 @@ Overall application speed and performance has been greatly improved with faster
* Changed the start button for the screensaver from "Back" to "X"
* Changed the help system description for the "A" button in the gamelist view from "Launch" to "Select"
* Changed the menu header for the gamelist options menu from "Options" to "Gamelist options"
* Added support for the Emerson Arcadia 2001 (arcadia) game system
* Added support for the Arduboy Miniature Game System (arduboy)
* Added support for the Acorn Computers BBC Micro (bbcmicro) game system by adding the MAME standalone emulator
* Added support for the Capcom Play System I, II and III (cps1, cps2 and cps3) game systems
* Added support for the VTech CreatiVision (crvision) game system
* Added support for the LCD Handheld Games (lcdgames) game system
* Added support for the Sega Mega Drive (megadrivejp) game system (Japanese region)
* Added support for the Casio PV-1000 (pv1000) game system
* Added support for the VTech V.Smile (vsmile) game system
* Added support for the WASM-4 Fantasy Console (wasm4) game system
* Added support for the Microsoft Windows (windows) game system

4
CONTRIBUTING.md
View file

@ -10,11 +10,11 @@ Development is tracked using a Kanban board which is publicly visible at the pro
[https://gitlab.com/es-de/emulationstation-de/-/boards](https://gitlab.com/es-de/emulationstation-de/-/boards)
Development takes place in the `master` branch, and bug fixes/point releases are handled in the `stable` branches (only the latest stable version is maintained).
Development takes place in the master branch, and bug fixes/point releases are handled in the stable branches (only the latest stable version is maintained).
### Coding style
Code formatting is applied automatically using clang-format, so to understand the exact formatting rules, refer to the .clang-format file in the root of the ES-DE repository. You can read in [INSTALL.md](INSTALL.md#using-clang-format-for-automatic-code-formatting) how clang-format is installed and used.
Code formatting is applied automatically using clang-format, so to understand the exact formatting rules refer to the .clang-format file in the root of the ES-DE repository. You can read in [INSTALL.md](INSTALL.md#using-clang-format-for-automatic-code-formatting) how clang-format is installed and used.
But as clang-format won't change actual code content or fix all code style choices, here are some additional key points:

9
CREDITS.md
View file

@ -119,6 +119,15 @@ https://gitlab.com/recalbox/recalbox-themes
Carbon (some graphics taken from this theme) \
https://github.com/RetroPie/es-theme-carbon
Some logotype graphics by Dan Patrick
# Modern theme set
Nintendo Switch Theme for RetroPie (Modern is based on this theme): \
https://github.com/lilbud/es-theme-switch
Some logotype graphics by Dan Patrick
# Sounds
Used by the default Slate theme as well as for fallback sounds (for themes that lack navigation sounds).

4
INSTALL-DEV.md
View file

@ -159,7 +159,7 @@ make
```
Due to buggy AMD GPU drivers it could be a good idea to use the `LSAN_suppressions` file included in the repository to avoid reports of a lot of irrelevant issue, for example:
```
LSAN_OPTIONS="suppressions=LSAN_suppressions" ./emulationstation --debug --resolution 2560 1440
LSAN_OPTIONS="suppressions=tools/LSAN_suppressions" ./emulationstation --debug --resolution 2560 1440
```
This applies to LeakSanitizer specifically, which is integrated into AddressSanitizer.
@ -172,7 +172,7 @@ make
It could also be a good idea to use the `TSAN_suppressions` file included in the repository to suppress issues reported by some third party libraries, for example:
```
TSAN_OPTIONS="suppressions=TSAN_suppressions" ./emulationstation --debug --resolution 2560 1440
TSAN_OPTIONS="suppressions=tools/TSAN_suppressions" ./emulationstation --debug --resolution 2560 1440
```
To enable UndefinedBehaviorSanitizer which helps with identifying bugs that may otherwise be hard to find, build with the UBSAN option:

10
README.md
View file

@ -22,7 +22,7 @@ You can find the complete list of supported systems and emulators [here](USERGUI
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).
### Download
## Download
The latest stable version is **1.2.6** (released 2022-08-03) and the latest prerelease is **2.0.0-beta-2023-02-26**
@ -30,7 +30,7 @@ Visit https://es-de.org/ to download ES-DE or go to the [package registry](https
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).
# Additional information
## Additional information
[FAQ.md](FAQ.md) - Frequently Asked Questions
@ -48,7 +48,7 @@ If you're using a Raspberry Pi or if you run FreeBSD, NetBSD or OpenBSD then you
[CREDITS.md](CREDITS.md) - An attempt to credit the individuals and projects which made ES-DE possible
# Some feature highlights
## Some feature highlights
Here are some highlights, displayed using the default Slate theme set.
@ -74,7 +74,7 @@ _There are many settings for the scraper including options to define which type
_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")
_There are four built-in screensaver types, including a slideshow and a video screensaver that display random games from your collection._
_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")
_ES-DE is fully themeable, so if you prefer another look than what the default theme Slate offers, it's possible to apply another theme set. The image above is of the Modern theme that is also bundled with the application._
_ES-DE is fully themeable, in case you prefer another look than what the default theme Slate offers. The screenshot above depicts the Modern theme that is also bundled with the application._

2
ROADMAP.md
View file

@ -2,7 +2,7 @@
This roadmap is under constant review so expect it to change from time to time.
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.
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_

15
USERGUIDE-DEV.md
View file

@ -1926,6 +1926,8 @@ When scraping in interactive mode it's recommended to keep the _Auto-accept sing
Under normal circumstances the scraper service will only return games for the platforms used for searching, but sometimes when it's not sure about the results it will also include games from other platforms. If this happens, these additional platform names will be displayed within square brackets after the game name in the result list. And if a game system is configured for multiple platforms, then the specific platform returned per result will always be displayed within square brackets. The exception for these two scenarios is if the multi-scraper is running in fully automatic mode as the additional platform information is then always omitted. Note that the additional platform information will not be included in the scraped game name, it's only used for clarification within the scraper result list.
It's also possible to apply a filter for which games to scrape, which is very useful if for example continuing scraping a system that was previously not fully completed, or for re-scraping after new games have been added. This is accomplished using the _Scrape these games_ option on the main scraper menu. Possible values are _All games, Favorite games, No metadata, No game image, No game video_ or _Folders only_.
By default, ES-DE will search using the metadata name of the game. If no name has previously been defined via scraping or via manually entering it using the metadata editor, the name used for searching will correspond to the physical filename minus all text inside either normal brackets `()` or square brackets `[]`. So for example the physical filename `Mygame (U) [v2].zip` will be stripped to simply `Mygame` when performing the scraper search.
By disabling the option _Search using metadata name_, the physical filename will be used even if there is a scraped or manually entered name for the game.
@ -2037,7 +2039,7 @@ Scraper service selection, currently ScreenScraper.fr and TheGamesDB.net are sup
**Scrape these games**
Criteria for what games to include. It can be set to _All games, Favorite games, No metadata, No game image, No game video_ or _Folders only_.
Criteria for what games to include. It can be set to _All games, Favorite games, No metadata, No game image, No game video_ or _Folders only_. The _No metadata_ option checks if the game has a description and the _No game image_ checks for a miximage, then screenshot, then title screen and last box cover and if any of these images exist then the game is considered as already scraped.
**Scrape these systems**
@ -3021,11 +3023,11 @@ The **Default emulator** column lists the primary emulator as configured in es_s
The **Alternative emulators** column lists additional emulators configured in es_systems.xml that can be selected per system and per game. In the same manner as the _Default emulator_ column, differences between Unix, macOS and Windows are marked using square brackets.
The **Needs BIOS** column indicates if additional BIOS/system ROMs are required. Additional details should be covered by the emulator documentation.
The **Needs BIOS** column indicates if any BIOS/system ROMs are required. Additional details should be covered by the emulator documentation.
As for file extensions, normally those configured should cover everything that all emulators combined support for a given system.
As for file extensions, normally those configured in ES-DE should cover everything that all emulators combined support for a given system.
In general .zip or .7z files are recommended for smaller-sized games like those from older systems (assuming the emulator supports it). But for disc-based systems it's not a good approach as uncompressing these large files lead to slow game launches. For such systems it's instead generally recommended to use CHD files as this format offers compression without delaying game launches. The CHD format is also supported by most emulators.
In general .zip or .7z files are recommended for smaller-sized games like those from older systems (assuming the emulator supports it). But for disc-based systems it's not a good approach as decompression of these large files lead to delayed game launches. For such systems it's instead generally recommended to use CHD files as this format offers effective compression while providing decompression on the fly. The CHD format is also supported by most emulators.
On Windows the following emulators provide a way to inform ES-DE where they have been installed, meaning you don't need to add them to your Path environment variable as described elsewhere in this guide (this is only relevant for the installer release of ES-DE, not the portable release):
* BlueStacks
@ -3042,7 +3044,7 @@ On Windows the following emulators provide a way to inform ES-DE where they have
Default emulator/Alternative emulators columns: \
**[U]**: Unix, **[M]**: macOS, **[W]**: Windows
All emulators are RetroArch cores unless marked as **(Standalone**)
All emulators are RetroArch cores unless marked as **(Standalone)**
The **@** symbol indicates that the emulator is _deprecated_ and will be removed in a future ES-DE release.
@ -3059,6 +3061,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| apple2 | Apple II | LinApple **(Standalone)** [U],<br>Mednafen **(Standalone)** [M],<br>AppleWin **(Standalone)** [W] | Mednafen **(Standalone)** [UW],<br>MAME **(Standalone)** | Yes for Mednafen and MAME | See the specific _Apple II_ section elsewhere in this guide |
| apple2gs | Apple IIGS | MAME **(Standalone)** | | Yes | See the specific _Apple IIGS_ section elsewhere in this guide |
| arcade | Arcade | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)**,<br>FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [UW],<br>FB Alpha 2012,<br>Flycast,<br>Flycast **(Standalone)**,<br>Kronos [UW],<br>Model 2 Emulator **(Standalone)** [W],<br>Model 2 Emulator [Suspend ES-DE] **(Standalone)** [W],<br>Supermodel **(Standalone)** [UW],<br>Supermodel [Fullscreen] **(Standalone)** [UW] | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| arcadia | Emerson Arcadia 2001 | MAME **(Standalone)** | | No | Single archive or ROM file |
| arduboy | Arduboy Miniature Game System | Arduous | | No | Single archive or .hex file |
| astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** | | See the specific _Bally Astrocade_ section elsewhere in this guide |
| atari2600 | Atari 2600 | Stella | Stella 2014,<br>ares **(Standalone)** | No | Single archive or ROM file |
@ -3084,6 +3087,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| cps1 | Capcom Play System I | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)**,<br>FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [UW],<br>FB Alpha 2012,<br>FB Alpha 2012 CPS-1 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| cps2 | Capcom Play System II | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)**,<br>FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [UW],<br>FB Alpha 2012,<br>FB Alpha 2012 CPS-2 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| cps3 | Capcom Play System III | MAME - Current | MAME 2010,<br>MAME 2003-Plus,<br>MAME 2000,<br>MAME **(Standalone)**,<br>FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [UW],<br>FB Alpha 2012,<br>FB Alpha 2012 CPS-3 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| crvision | VTech CreatiVision | MAME **(Standalone)** | | Yes | Single archive or ROM file |
| daphne | Daphne Arcade LaserDisc Emulator | Hypseus [Daphne] **(Standalone)** [UW] | Hypseus [Singe] **(Standalone)** [UW] | Yes for Daphne games | See the specific _Hypseus Singe (Daphne)_ section elsewhere in this guide |
| desktop | Desktop Applications | _Suspend ES-DE_ | _Keep ES-DE running_ | | See the specific _Ports and desktop applications_ section elsewhere in this guide |
| doom | Doom | PrBoom | Boom 3 [UW],<br>Boom 3 xp [UW],<br>_Shortcut or script_ | No | |
@ -3164,6 +3168,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| psp | Sony PlayStation Portable | PPSSPP | PPSSPP **(Standalone)** | No | Single disc image file |
| psvita | Sony PlayStation Vita | Vita3K **(Standalone)** [UW] | | Yes | See the specific _Sony PlayStation Vita_ section elsewhere in this guide |
| psx | Sony PlayStation | Beetle PSX | Beetle PSX HW,<br>PCSX ReARMed,<br>SwanStation,<br>DuckStation **(Standalone)**,<br>Mednafen **(Standalone)** | Yes | .chd file for single-disc games, .m3u playlist for multi-disc games |
| pv1000 | Casio PV-1000 | MAME **(Standalone)** | | No | Single archive or ROM file |
| samcoupe | MGT SAM Coupé | SimCoupé **(Standalone)** | | No | Single archive or ROM file |
| satellaview | Nintendo Satellaview | Snes9x - Current | Snes9x 2010,<br>Snes9x **(Standalone)**,<br>bsnes,<br>bsnes-hd,<br>bsnes-mercury Accuracy,<br>bsnes **(Standalone)** [UW],<br>Mesen-S | | |
| saturn | Sega Saturn | Beetle Saturn | Kronos [UW],<br>YabaSanshiro [UW],<br>Yabause,<br>Mednafen **(Standalone)**,<br>SSF **(Standalone)** [W] | Yes | In separate folder interpreted as a file, with .m3u playlist if multi-disc game |