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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-10-02 17:11:18 +02:00
parent 355269c731
commit 13a603a687
5 changed files with 46 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
CHANGELOG.md
View file

@ -34,7 +34,13 @@
* Added MAME standalone as an alternative emulator for the gx4000 system * Added MAME standalone as an alternative emulator for the gx4000 system
* Added the .bin file extension to the gx4000 system * Added the .bin file extension to the gx4000 system
* Added the .m3u file extension to the pcfx system * Added the .m3u file extension to the pcfx system
* Removed the .7z and .zip file extensions from the 3do system * Removed the .7z and .zip file extensions from the 3do, neogeocd and neogeocdjp systems
* Removed the .ccd and .cue file extensions from the fbneo system
* Removed the .ccd, .cue and .iso file extensions from the neogeo system
* Added the FinalBurn Neo RetroArch core as an alternative emulator for the neogeocd and neogeocdjp systems
* Added MAME standalone as an alternative emulator for the neogeo, neogeocd and neogeocdjp systems
* Added FinalBurn Neo standalone as an alternative emulator for the fbneo, neogeo, neogeocd and neogeocdjp systems on Unix
* Added FinalBurn Neo standalone as an alternative emulator for the fbneo and neogeo system on Windows
* Set DOSBox-X and DOSBox Staging to start in the game directory so per-game dosbox.conf files can be used * Set DOSBox-X and DOSBox Staging to start in the game directory so per-game dosbox.conf files can be used
* (macOS) Added an additional find rule entry for DOSBox-X as the binary name has been changed * (macOS) Added an additional find rule entry for DOSBox-X as the binary name has been changed
* (Linux) Added Flatpak support for Mednafen using the Mednaffe package * (Linux) Added Flatpak support for Mednafen using the Mednaffe package
@ -116,8 +122,8 @@
* Added shader support for performing BGRA to RGBA color conversion * Added shader support for performing BGRA to RGBA color conversion
* Added opacity support to the scanline shader * Added opacity support to the scanline shader
* Added the rlottie library as a Git subtree * Added the rlottie library as a Git subtree
* Updated to build correctly with FFmpeg 5.0 * Updated to build correctly with FFmpeg 5.1
* Updated FFmpeg to 5.0 and SDL to 2.24.0 on Windows and macOS * Updated FFmpeg to 5.1.2 and SDL to 2.24.0 on Windows and macOS
* Added a workaround for playing broken video files with invalid PTS values * Added a workaround for playing broken video files with invalid PTS values
* Refactored the rendering code from a shared namespace into proper classes * Refactored the rendering code from a shared namespace into proper classes
* Removed the deprecated OpenGL ES 1.0 renderer * Removed the deprecated OpenGL ES 1.0 renderer
@ -187,6 +193,7 @@
* The rating icons would not fit into the designated space in the scraper GUI when running at some vertically oriented screen resolutions * The rating icons would not fit into the designated space in the scraper GUI when running at some vertically oriented screen resolutions
* The game description would start to scroll too late when running the multi-scraper in semi-automatic mode * The game description would start to scroll too late when running the multi-scraper in semi-automatic mode
* If setting an origin other than 0.5 for a video with pillarboxes enabled, the video would not get centered on the black rectangle * If setting an origin other than 0.5 for a video with pillarboxes enabled, the video would not get centered on the black rectangle
* The video player output frame width was not set correctly which made some videos render as garbled when using FFmpeg 5.1 and later
* If a gamelist scroll fade-in animation was playing when opening a menu, it would continue to play after closing the menu * If a gamelist scroll fade-in animation was playing when opening a menu, it would continue to play after closing the menu
* The gamelist quick list scrolling overlay would not disappear as intended under some circumstances * The gamelist quick list scrolling overlay would not disappear as intended under some circumstances
* When a legacy theme set had a video view style but did not have a valid md_video entry then the video player would still start (and play the audio) * When a legacy theme set had a video view style but did not have a valid md_video entry then the video player would still start (and play the audio)

7
CONTRIBUTING.md
View file

@ -85,9 +85,9 @@ The roadmap is under constant review so expect it to change from time to time. S
#### v2.2 #### v2.2
* Animated menu elements like switches and tick boxes * Theme downloader
* Simple file browsing component
* Scrollbar component for the gamelist view which can be used by the themes * Scrollbar component for the gamelist view which can be used by the themes
* Reorganize the menus, possibly adding basic/advanced modes
* Background music * Background music
* Proper audio mixer * Proper audio mixer
* Checksum support for the scraper for exact searches and for determining when to overwrite files * Checksum support for the scraper for exact searches and for determining when to overwrite files
@ -100,12 +100,13 @@ The roadmap is under constant review so expect it to change from time to time. S
* Localization/multi-language support * Localization/multi-language support
* Dependency on MoltenVK to get Metal support on macOS * Dependency on MoltenVK to get Metal support on macOS
* Better and more accurate GPU and memory usage statistics overlay * Better and more accurate GPU and memory usage statistics overlay
* Simple file browsing component
* Bulk metadata editor * Bulk metadata editor
* Improve multi-threading * Improve multi-threading
#### v2.4 #### v2.4
* Reorganize the menus, possibly adding basic/advanced modes * Animated menu elements like switches and tick boxes
* Migration tools for importing game metadata and media from other frontend applications * Migration tools for importing game metadata and media from other frontend applications
* Audit tools to clean up orphaned gamelist entries, media files etc. * Audit tools to clean up orphaned gamelist entries, media files etc.
* Auto-import tools for Steam, Lutris etc. * Auto-import tools for Steam, Lutris etc.

4
THEMES-DEV.md
View file

@ -906,7 +906,7 @@ Properties:
* `gameselector` - type: STRING * `gameselector` - type: STRING
- If more than one gameselector element has been defined, this property makes it possible to state which one to use. If multiple gameselector elements have been defined and this property is missing then the first entry will be chosen and a warning message will be logged. If only a single gameselector has been defined, this property is ignored. The value of this property must match the `name` attribute value of the gameselector element. - If more than one gameselector element has been defined, this property makes it possible to state which one to use. If multiple gameselector elements have been defined and this property is missing then the first entry will be chosen and a warning message will be logged. If only a single gameselector has been defined, this property is ignored. The value of this property must match the `name` attribute value of the gameselector element.
* `audio` - type: BOOLEAN * `audio` - type: BOOLEAN
- Whether to enable or disable audio playback for the video. - Whether to enable or disable audio playback for the video. For static videos in the gamelist view it's strongly recommended to set this to `false` if there is also a separate video element playing game videos.
- Default is `true` - Default is `true`
* `interpolation` - type: STRING * `interpolation` - type: STRING
- Interpolation method to use when scaling raster images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. Note that this property only affects the static image, not the video scaling. This property also has no effect on scalable vector graphics (SVG) images. - Interpolation method to use when scaling raster images. Nearest neighbor (`nearest`) preserves sharp pixels and linear filtering (`linear`) makes the image smoother. Note that this property only affects the static image, not the video scaling. This property also has no effect on scalable vector graphics (SVG) images.
@ -1465,7 +1465,7 @@ Properties:
- `titlescreen` - This will look for a title screen image. - `titlescreen` - This will look for a title screen image.
- `miximage` - This will look for a miximage. - `miximage` - This will look for a miximage.
- `fanart` - This will look for a fan art image. - `fanart` - This will look for a fan art image.
- `none` - No image will be used, instead the game name will be displayed as text - `none` - No image will be used, instead the game name will be displayed as text.
- Default is `marquee` - Default is `marquee`
* `defaultItem` - type: PATH * `defaultItem` - type: PATH
- Path to the default image file which will be displayed if the image defined via the `staticItem` or `itemType` property is not found. Most common extensions are supported (including .svg, .jpg, .png, and unanimated .gif). - Path to the default image file which will be displayed if the image defined via the `staticItem` or `itemType` property is not found. Most common extensions are supported (including .svg, .jpg, .png, and unanimated .gif).

17
USERGUIDE-DEV.md
View file

@ -164,6 +164,8 @@ _This is the dialog shown if no game files were found. It lets you configure the
**Note:** Before upgrading ES-DE, make sure that you have not made any system customizations anywhere in the installation directory structure as these files will be overwritten during the upgrade process. All customizations should go into ~/.emulationstation/custom_systems/ as described elsewhere in this guide. None of the upgrade methods mentioned below will ever touch any files inside your .emulationstation directory. **Note:** Before upgrading ES-DE, make sure that you have not made any system customizations anywhere in the installation directory structure as these files will be overwritten during the upgrade process. All customizations should go into ~/.emulationstation/custom_systems/ as described elsewhere in this guide. None of the upgrade methods mentioned below will ever touch any files inside your .emulationstation directory.
It's possible that the new ES-DE release adds support for more systems and emulators compared to the version you previously had installed, so you may want to recreate the ROMs directory tree after you've completed the installation. The easiest way to do that is to start ES-DE once with the _--create-system-dirs_ command line option which will create any missing system directories and also update the systems.txt and systeminfo.txt files. Note that this is a safe operation as it will not overwrite or delete your game files. Alternatively you can rename your ROMs directory to ROMs_TEMP or similar which will display the missing games dialog on application startup, and from there you can create the directories and update the info files. But this approach is a bit more cumbersome as you then need to manually move back your games from ROMs_TEMP to your newly created ROMs directory tree. If you have installed ES-DE using EmuDeck then the upgrade process will be handled by their installer so this overall section of the user guide does not apply.
**Linux .deb and .rpm packages** **Linux .deb and .rpm packages**
Upgrading ES-DE using these packages is very straightforward, just run them through the package manager of your operating system and the process should be entirely automatic. Note that you need to manually download the packages from [https://es-de.org](https://es-de.org) as ES-DE is not currently included in any operating system repositories. Upgrading ES-DE using these packages is very straightforward, just run them through the package manager of your operating system and the process should be entirely automatic. Note that you need to manually download the packages from [https://es-de.org](https://es-de.org) as ES-DE is not currently included in any operating system repositories.
@ -678,13 +680,14 @@ So placing a manually downloaded emulator binary in either of these directories
The following manually downloaded emulators are supported when using the bundled configuration: The following manually downloaded emulators are supported when using the bundled configuration:
| System name | Emulator | Filename configuration | | System name | Emulator | Filename configuration |
| :----------------------- | :------------ | :------------------------------ | | :------------------------------- | :------------ | :------------------------------ |
| amstradcpc | CPCemu | cpcemu/cpcemu | | amstradcpc | CPCemu | cpcemu/cpcemu |
| apple2 | LinApple | linapple/linapple | | apple2 | LinApple | linapple/linapple |
| coco/dragon32/tanodragon | XRoar | xroar/xroar | | coco/dragon32/tanodragon | XRoar | xroar/xroar |
| daphne | Hypseus Singe | hypseus-singe/hypseus.bin | | daphne | Hypseus Singe | hypseus-singe/hypseus.bin |
| dreamcast | Redream | redream/redream | | dreamcast | Redream | redream/redream |
| easyrpg | EasyRPG | easyrpg/easyrpg-player | | easyrpg | EasyRPG | easyrpg/easyrpg-player |
| fbneo/neogeo/neogeocd/neogeocdjp | FinalBurn Neo | fbneo/fbneo |
| flash | Lightspark | lightspark/lightspark | | flash | Lightspark | lightspark/lightspark |
| flash | Ruffle | ruffle/ruffle | | flash | Ruffle | ruffle/ruffle |
| fmtowns | Tsugaru | tsugaru/Tsugaru_CUI | | fmtowns | Tsugaru | tsugaru/Tsugaru_CUI |
@ -923,6 +926,8 @@ The EMULATOR.INI file is found in the _Model 2 Emulator_ installation directory.
Also note that Model 2 Emulator is a bit broken and on most GPU drivers it will only work correctly if ES-DE keeps running in the background while the game is launched. However, for some GPU drivers the opposite is true and the emulator will only work if ES-DE is suspended. To use the latter setup, switch to the alternative emulator entry _Model 2 Emulator [Suspend ES-DE] (Standalone)_. Also note that Model 2 Emulator is a bit broken and on most GPU drivers it will only work correctly if ES-DE keeps running in the background while the game is launched. However, for some GPU drivers the opposite is true and the emulator will only work if ES-DE is suspended. To use the latter setup, switch to the alternative emulator entry _Model 2 Emulator [Suspend ES-DE] (Standalone)_.
Likewise, if using the standalone release of FinalBurn Neo you also need to define the ROM directory in the fbneo.ini file or via the user interface as this emulator does not support passing the full path to the game ROM on game launch.
#### Nintendo Game and Watch #### Nintendo Game and Watch
There are two ways to play these games, either via simulation or via emulation. There are two ways to play these games, either via simulation or via emulation.
@ -2997,8 +3002,8 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| easyrpg | EasyRPG Game Engine | EasyRPG | EasyRPG Player **(Standalone)** [UMW*] | No | See the specific _EasyRPG Game Engine_ section elsewhere in this guide | | easyrpg | EasyRPG Game Engine | EasyRPG | EasyRPG Player **(Standalone)** [UMW*] | No | See the specific _EasyRPG Game Engine_ section elsewhere in this guide |
| epic | Epic Games Store | Epic Games Store application **(Standalone)** | | No | Shortcut in root folder | | epic | Epic Games Store | Epic Games Store application **(Standalone)** | | No | Shortcut in root folder |
| famicom | Nintendo Family Computer | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>QuickNES,<br>Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*],<br>ares FDS **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder | | famicom | Nintendo Family Computer | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>QuickNES,<br>Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*],<br>ares FDS **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder |
| fba | FinalBurn Alpha | FB Alpha 2012 | FB Alpha 2012 Neo Geo,<br>FB Alpha 2012 CPS-1,<br>FB Alpha 2012 CPS-2,<br>FB Alpha 2012 CPS-3 | Yes | Single archive file following MAME name standard in root folder | | fba | FinalBurn Alpha | FB Alpha 2012 | FB Alpha 2012 Neo Geo,<br>FB Alpha 2012 CPS-1,<br>FB Alpha 2012 CPS-2,<br>FB Alpha 2012 CPS-3 | Yes | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| fbneo | FinalBurn Neo | FinalBurn Neo | | Yes | Single archive file following MAME name standard in root folder | | fbneo | FinalBurn Neo | FinalBurn Neo | FinalBurn Neo **(Standalone)** [UW*] | Yes | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| fds | Nintendo Famicom Disk System | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*] | Yes | Single archive or ROM file in root folder | | fds | Nintendo Famicom Disk System | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*] | Yes | Single archive or ROM file in root folder |
| flash | Adobe Flash | Ruffle **(Standalone)** [UMW*] | Lightspark **(Standalone)** [U],<br>ArcadeFlashWeb **(Standalone)** [W*] | No | Single .swf file in root folder | | flash | Adobe Flash | Ruffle **(Standalone)** [UMW*] | Lightspark **(Standalone)** [U],<br>ArcadeFlashWeb **(Standalone)** [W*] | No | Single .swf file in root folder |
| fmtowns | Fujitsu FM Towns | Tsugaru **(Standalone)** [UW*] | | Yes | See the specific _Fujitsu FM Towns_ section elsewhere in this guide | | fmtowns | Fujitsu FM Towns | Tsugaru **(Standalone)** [UW*] | | Yes | See the specific _Fujitsu FM Towns_ section elsewhere in this guide |
@ -3041,9 +3046,9 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| n64 | Nintendo 64 | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | Mupen64Plus **(Standalone)** [UMW*],<br>ParaLLEl N64 [UW],<br>simple64 **(Standalone)** [UW*],<br>Rosalie's Mupen GUI **(Standalone)** [U],<br>Project64 **(Standalone)** [W*],<br>ares **(Standalone)** [UMW*],<br>sixtyforce **(Standalone)** [M] | No | Single archive or ROM file in root folder | | n64 | Nintendo 64 | Mupen64Plus-Next [UW],<br>ParaLLEl N64 [M] | Mupen64Plus **(Standalone)** [UMW*],<br>ParaLLEl N64 [UW],<br>simple64 **(Standalone)** [UW*],<br>Rosalie's Mupen GUI **(Standalone)** [U],<br>Project64 **(Standalone)** [W*],<br>ares **(Standalone)** [UMW*],<br>sixtyforce **(Standalone)** [M] | No | Single archive or ROM file in root folder |
| n64dd | Nintendo 64DD | ParaLLEl N64 | Mupen64Plus-Next [UW] | Yes | See the specific _Nintendo 64DD_ section elsewhere in this guide | | n64dd | Nintendo 64DD | ParaLLEl N64 | Mupen64Plus-Next [UW] | Yes | See the specific _Nintendo 64DD_ section elsewhere in this guide |
| nds | Nintendo DS | DeSmuME | DeSmuME 2015,<br>DeSmuME **(Standalone)** [U],<br>melonDS,<br>melonDS **(Standalone)** [UMW*] | No | | | nds | Nintendo DS | DeSmuME | DeSmuME 2015,<br>DeSmuME **(Standalone)** [U],<br>melonDS,<br>melonDS **(Standalone)** [UMW*] | No | |
| neogeo | SNK Neo Geo | FinalBurn Neo | | Yes | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | | neogeo | SNK Neo Geo | FinalBurn Neo | FinalBurn Neo **(Standalone)** [UW*],<br>MAME **(Standalone)** [UMW*] | Yes | See the specific _Arcade and Neo Geo_ section elsewhere in this guide |
| neogeocd | SNK Neo Geo CD | NeoCD | | Yes | Single archive in root folder (which includes the CD image and ripped audio) | | neogeocd | SNK Neo Geo CD | NeoCD | FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [U],<br>MAME **(Standalone)** [UMW*] | Yes | .chd (NeoCD and MAME only) or .cue file in root folder |
| neogeocdjp | SNK Neo Geo CD [Japan] | NeoCD | | Yes | Single archive in root folder (which includes the CD image and ripped audio) | | neogeocdjp | SNK Neo Geo CD [Japan] | NeoCD | FinalBurn Neo,<br>FinalBurn Neo **(Standalone)** [U],<br>MAME **(Standalone)** [UMW*] | Yes | .chd (NeoCD and MAME only) or .cue file in root folder |
| nes | Nintendo Entertainment System | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>QuickNES,<br>Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*],<br>ares FDS **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder | | nes | Nintendo Entertainment System | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>QuickNES,<br>Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*],<br>ares FDS **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder |
| ngp | SNK Neo Geo Pocket | Beetle NeoPop | RACE,<br>Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*] | | | | ngp | SNK Neo Geo Pocket | Beetle NeoPop | RACE,<br>Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*] | | |
| ngpc | SNK Neo Geo Pocket Color | Beetle NeoPop | RACE,<br>Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*] | | | | ngpc | SNK Neo Geo Pocket Color | Beetle NeoPop | RACE,<br>Mednafen **(Standalone)** [UMW*],<br>ares **(Standalone)** [UMW*] | | |

2
USERGUIDE.md
View file

@ -162,6 +162,8 @@ _This is the dialog shown if no game files were found. It lets you configure the
**Note:** Before upgrading ES-DE, make sure that you have not made any system customizations anywhere in the installation directory structure as these files will be overwritten during the upgrade process. All customizations should go into ~/.emulationstation/custom_systems/ as described elsewhere in this guide. None of the upgrade methods mentioned below will ever touch any files inside your .emulationstation directory. **Note:** Before upgrading ES-DE, make sure that you have not made any system customizations anywhere in the installation directory structure as these files will be overwritten during the upgrade process. All customizations should go into ~/.emulationstation/custom_systems/ as described elsewhere in this guide. None of the upgrade methods mentioned below will ever touch any files inside your .emulationstation directory.
It's possible that the new ES-DE release adds support for more systems and emulators compared to the version you previously had installed, so you may want to recreate the ROMs directory tree after you've completed the installation. The easiest way to do that is to start ES-DE once with the _--create-system-dirs_ command line option which will create any missing system directories and also update the systems.txt and systeminfo.txt files. Note that this is a safe operation as it will not overwrite or delete your game files. Alternatively you can rename your ROMs directory to ROMs_TEMP or similar which will display the missing games dialog on application startup, and from there you can create the directories and update the info files. But this approach is a bit more cumbersome as you then need to manually move back your games from ROMs_TEMP to your newly created ROMs directory tree. If you have installed ES-DE using EmuDeck then the upgrade process will be handled by their installer so this overall section of the user guide does not apply.
**Linux .deb and .rpm packages** **Linux .deb and .rpm packages**
Upgrading ES-DE using these packages is very straightforward, just run them through the package manager of your operating system and the process should be entirely automatic. Note that you need to manually download the packages from [https://es-de.org](https://es-de.org) as ES-DE is not currently included in any operating system repositories. Upgrading ES-DE using these packages is very straightforward, just run them through the package manager of your operating system and the process should be entirely automatic. Note that you need to manually download the packages from [https://es-de.org](https://es-de.org) as ES-DE is not currently included in any operating system repositories.