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

Documentation update.

Browse source
This commit is contained in:
Leon Styhre 2022-04-21 23:04:45 +02:00
parent a45bd7a495
commit c2a1d2e914
2 changed files with 47 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CHANGELOG.md
View file

@ -26,6 +26,7 @@
* Added support for asterisks/wildcards for emulator name matching, usable both in es_find_rules.xml and es_systems.xml * Added support for asterisks/wildcards for emulator name matching, usable both in es_find_rules.xml and es_systems.xml
* The actual names for emulators with find rule entries are now displayed in the error popup window if they're not found during game launch * The actual names for emulators with find rule entries are now displayed in the error popup window if they're not found during game launch
* Reorganized the UI Settings menu a bit and added entries to set the variant and aspect ratio for newer theme sets * Reorganized the UI Settings menu a bit and added entries to set the variant and aspect ratio for newer theme sets
* Removed the "Preload gamelists on startup" setting
* Removed the "Play videos immediately (override theme)" setting * Removed the "Play videos immediately (override theme)" setting
* Renamed the sound menu option "Play audio for videos in the gamelist view" to "Play audio for gamelist and system view videos" * Renamed the sound menu option "Play audio for videos in the gamelist view" to "Play audio for gamelist and system view videos"
* Added support for defining which types of game media to use for all image elements (and also for the video component static image) * Added support for defining which types of game media to use for all image elements (and also for the video component static image)
@ -85,6 +86,7 @@
* Updated the build scripts to support native M1/ARM builds on macOS * Updated the build scripts to support native M1/ARM builds on macOS
* Improved the in-tree build on macOS to not needing to install any libraries when compiling the "external" dependencies * Improved the in-tree build on macOS to not needing to install any libraries when compiling the "external" dependencies
* Large refactoring to improve thread safety and improve singleton pattern usage * Large refactoring to improve thread safety and improve singleton pattern usage
* Added the build date to to main menu for alpha and dev builds
* Moved all Platform functions to the utility namespace instead of using the global namespace * Moved all Platform functions to the utility namespace instead of using the global namespace
* Implemented proper XML attribute support in ThemeData that eliminates the risk of name collisions * Implemented proper XML attribute support in ThemeData that eliminates the risk of name collisions
* Added size restrictions to images and fonts so incorrect theme configuration would not lead to crashes or excessive memory utilization * Added size restrictions to images and fonts so incorrect theme configuration would not lead to crashes or excessive memory utilization
@ -113,7 +115,7 @@
### Bug fixes ### Bug fixes
* A renderer heisenbug caused single-pixel alignment issues at multiple places throughout the application * A vertex rounding heisenbug caused single-pixel alignment issues at multiple places throughout the application
* During some menu operations that reloaded the gamelist view, the cached background could miss some components as they were not rendered in time * During some menu operations that reloaded the gamelist view, the cached background could miss some components as they were not rendered in time
* Changing some values using the metadata editor could lead to an incorrect sort order if the changes were done from within a grouped custom collection * Changing some values using the metadata editor could lead to an incorrect sort order if the changes were done from within a grouped custom collection
* Changing the setting "Group unthemed custom collections" could lead to incorrect custom collections sorting under some circumstances * Changing the setting "Group unthemed custom collections" could lead to incorrect custom collections sorting under some circumstances
@ -146,8 +148,11 @@ v1.2 maintenance release.
### Detailed list of changes ### Detailed list of changes
* Added a scraper setting to convert underscores _ to spaces when searching * Added a scraper setting to convert underscores _ to spaces when searching
* Added support for using the manually downloaded emulators Redream and Ryujinx on Unix/Linux
* Replaced the RetroArch core 4DO with Opera for the 3do system * Replaced the RetroArch core 4DO with Opera for the 3do system
* Added the .ps3 file extension to the ps3 system
* Added the .rom file extension to the atari800 system * Added the .rom file extension to the atari800 system
* Added the .svm file extension to the scummvm system and removed support for .7z and .zip extensions
* 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

60
USERGUIDE-DEV.md
View file

@ -530,7 +530,7 @@ cd ~/Applications
chmod +x ./rpcs3-v0.0.19-13103-cc21d1b3_linux64.AppImage chmod +x ./rpcs3-v0.0.19-13103-cc21d1b3_linux64.AppImage
``` ```
At the moment the following emulators are supported in AppImage format when using the bundled configuration: The following emulators are supported in AppImage format when using the bundled configuration:
| System name | Emulator | Filename configuration | | System name | Emulator | Filename configuration |
| :----------- | :---------- | :------------------------------ | | :----------- | :---------- | :------------------------------ |
@ -546,6 +546,32 @@ At the moment the following emulators are supported in AppImage format when usin
RetroArch does not embed any version information into the filename so no wildcard is required. RetroArch does not embed any version information into the filename so no wildcard is required.
## Using manually downloaded emulators on Linux
Normally on Linux you would install emulators using either one of the established package formats, i.e. Flatpak, AppImage or Snap, or you would install them using the operating system repository. Less likely would be to build from source code and install to a standard system directory. In all these instances ES-DE should be able to find the emulator when launching a game. But in some rare cases you may instead manually download an emulator as an archive file to unzip somewhere on the file system. Normally you would want to place these files in your home directory, and if running a distribution that has an immutable filesystem (such as SteamOS), you don't even have the choice to install them to a standard system directory.
For these situations ES-DE looks for emulators in the same directories where it looks for AppImages (as explained in the section above), meaning:
```
~/Applications/
~/.local/bin/
~/bin/
```
So placing a manually downloaded emulator binary in either of these directories will make ES-DE able to locate it during game launch.
The following manually downloaded emulators are supported when using the bundled configuration:
| System name | Emulator | Filename configuration |
| :----------- | :---------- | :------------------------------ |
| dreamcast | Redream | redream |
| switch | Ryujinx | publish/Ryujinx |
Note that the Ryujinx binary is not set as executable after unpacking the archive, so you need to do that once before ES-DE can run it:
```
cd ~/Applications/publish
chmod +x ./Ryujinx
```
## Running emulators in fullscreen mode ## Running emulators in fullscreen mode
In general ES-DE does not pass command line parameters to emulators to start them in fullscreen mode. This is so as for most (if not all) emulators, command line arguments overrides the settings the user has defined. This means that windowed mode would have become impossible to achieve without creating custom systems configuration entries if ES-DE enforced fullscreen mode. There are only a very few exceptions for emulators where there is no other way to enter fullscreen mode than by passing such options during game launch. In general ES-DE does not pass command line parameters to emulators to start them in fullscreen mode. This is so as for most (if not all) emulators, command line arguments overrides the settings the user has defined. This means that windowed mode would have become impossible to achieve without creating custom systems configuration entries if ES-DE enforced fullscreen mode. There are only a very few exceptions for emulators where there is no other way to enter fullscreen mode than by passing such options during game launch.
@ -652,17 +678,17 @@ There is a very special use case which ES-DE supports where you can interpret a
If you add the extension that is configured for the emulator to a directory name it will be loaded as if it was a file when ES-DE starts up. If you add the extension that is configured for the emulator to a directory name it will be loaded as if it was a file when ES-DE starts up.
As an example using the Sony PlayStation 3 system, the extension in es_systems.xml is .ps3dir so this is what such a directory could look like: As an example using the Sony PlayStation 3 system, the extension in es_systems.xml is .ps3 so this is what such a directory could look like:
``` ```
~/ROMs/ps3/Gran Turismo 5.ps3dir ~/ROMs/ps3/Gran Turismo 5.ps3
``` ```
It's also possible to combine these types of special directories with normal directories, for a setup like this: It's also possible to combine these types of special directories with normal directories, for a setup like this:
``` ```
~/ROMs/ps3/racing/Gran Turismo 5.ps3dir ~/ROMs/ps3/racing/Gran Turismo 5.ps3
``` ```
For all intents and purposes the `Gran Turismo 5.ps3dir` directory will now be considered a file within ES-DE, i.e. all file metadata fields can be used and the directory can be part of both automatic and custom collections. For all intents and purposes the `Gran Turismo 5.ps3` directory will now be considered a file within ES-DE, i.e. all file metadata fields can be used and the directory can be part of both automatic and custom collections.
The only exception is that the _Delete_ button in the metadata editor will be disabled for these special types of entries as ES-DE does not support deletion of directories for safety reasons. The only exception is that the _Delete_ button in the metadata editor will be disabled for these special types of entries as ES-DE does not support deletion of directories for safety reasons.
@ -732,33 +758,33 @@ But if using the AppImage release it's a bit more complicated. See [here](USERGU
If using the Flatpak release and your games are stored on an external device (such as a memory card if using a Steam Deck), you need to give RPCS3 the necessary permissions. The easiest way to do this is by using [Flatseal](https://flathub.org/apps/details/com.github.tchx84.Flatseal). The option you need to enable is _All system files_ in the _Filesystem_ section. If using the Flatpak release and your games are stored on an external device (such as a memory card if using a Steam Deck), you need to give RPCS3 the necessary permissions. The easiest way to do this is by using [Flatseal](https://flathub.org/apps/details/com.github.tchx84.Flatseal). The option you need to enable is _All system files_ in the _Filesystem_ section.
As for the game installation on both Windows and Linux as well as on macOS, you need to retain the directory structure of the Blu-ray disc or the directory created by installing the .pkg file. Each directory needs to be renamed by adding the .ps3dir extension, which will make ES-DE interpret the directory as if it were a file and pass that directory to the emulator when launching a game. As for the game installation on both Windows and Linux as well as on macOS, you need to retain the directory structure of the Blu-ray disc or the directory created by installing the .pkg file. Each directory needs to be renamed by adding the .ps3 extension, which will make ES-DE interpret the directory as if it were a file and pass that directory to the emulator when launching a game.
Here's an example of what a Blu-ray disc directory could look like: Here's an example of what a Blu-ray disc directory could look like:
``` ```
~/ROMs/ps3/Gran Turismo 5.ps3dir ~/ROMs/ps3/Gran Turismo 5.ps3
``` ```
It's possible to create a symlink instead, and in this case only the symlink needs to have the .ps3dir extension. It's possible to create a symlink instead, and in this case only the symlink needs to have the .ps3 extension.
Here's how to do it on Linux and macOS: Here's how to do it on Linux and macOS:
``` ```
cd ~/ROMs cd ~/ROMs
ln -s ~/games/PS3/Gran\ Turismo\ 5 Gran\ Turismo\ 5.ps3dir ln -s ~/games/PS3/Gran\ Turismo\ 5 Gran\ Turismo\ 5.ps3
``` ```
And here's how to do it on Windows (you need to run this as Administrator): And here's how to do it on Windows (you need to run this as Administrator):
``` ```
cd C:\Users\Myusername\ROMs\ps3 cd C:\Users\Myusername\ROMs\ps3
mklink /D "Gran Turismo 5.ps3dir" "C:\Games\PS3\Gran Turismo 5" mklink /D "Gran Turismo 5.ps3" "C:\Games\PS3\Gran Turismo 5"
``` ```
If you've installed a .pkg using RPCS3 you can either symlink to the installation directory or move the directory to the ROMs folder. Also in this case the directory (or symlink) needs to be named with the .ps3dir extension. If you've installed a .pkg using RPCS3 you can either symlink to the installation directory or move the directory to the ROMs folder. Also in this case the directory (or symlink) needs to be named with the .ps3 extension.
An example on Linux: An example on Linux:
``` ```
cd ~/ROMs cd ~/ROMs
ln -s ~/.config/rpcs3/dev_hdd0/game/NPUA30002 Bejeweled2.ps3dir ln -s ~/.config/rpcs3/dev_hdd0/game/NPUA30002 Bejeweled2.ps3
``` ```
This example is for the AppImage version of RPCS3, for the Snap or Flatpak versions, the installed games will be located in a different directory. This example is for the AppImage version of RPCS3, for the Snap or Flatpak versions, the installed games will be located in a different directory.
@ -766,10 +792,10 @@ This example is for the AppImage version of RPCS3, for the Snap or Flatpak versi
Here's how to achieve the same on Windows: Here's how to achieve the same on Windows:
``` ```
cd C:\Users\Myusername\ROMs\ps3 cd C:\Users\Myusername\ROMs\ps3
mklink /D "Bejeweled2.ps3dir" "C:\Emulators\RPCS3\dev_hdd0\game\NPUA30002" mklink /D "Bejeweled2.ps3" "C:\Emulators\RPCS3\dev_hdd0\game\NPUA30002"
``` ```
Of course you can name the symlink anything you want as long as it has the .ps3dir extension. Of course you can name the symlink anything you want as long as it has the .ps3 extension.
Apparently some specific games have issues launching when using symlinks so you need to test and experiment with what works for your collection. Apparently some specific games have issues launching when using symlinks so you need to test and experiment with what works for your collection.
@ -1616,10 +1642,6 @@ Enabling this option makes ES-DE continue to run while a game is launched. This
With this option enabled, videos with lower frame rates than 60 FPS, such as 24 and 30 will get upscaled to 60 FPS. This results in slightly smoother playback for some videos. There is a small performance hit from this option, so on weaker machines it may be necessary to keep it disabled for fluent video playback. With this option enabled, videos with lower frame rates than 60 FPS, such as 24 and 30 will get upscaled to 60 FPS. This results in slightly smoother playback for some videos. There is a small performance hit from this option, so on weaker machines it may be necessary to keep it disabled for fluent video playback.
**Preload gamelists on startup**
When this option is enabled, all gamelists will be loaded on application startup. This will increase the startup time slightly and lead to a higher initial memory utilization, but navigation will be smoother the first time a gamelist is entered. The improvement is especially noticeable when the _slide_ transition style has been selected.
**Enable alternative emulators per game** **Enable alternative emulators per game**
If enabled, you will be able to select alternative emulators per game using the metadata editor, which will be used when launching the game. If disabled, the corresponding entry in the metadata editor will be hidden, the alternative emulator badges will not be displayed and it will not be possible to filter the gamelist based on these values. As well, the game will be launched using the default emulator, or using the system-wide alternative emulator if this has been configured for the game system. It's only recommended to disable this option for testing purposes. If enabled, you will be able to select alternative emulators per game using the metadata editor, which will be used when launching the game. If disabled, the corresponding entry in the metadata editor will be hidden, the alternative emulator badges will not be displayed and it will not be possible to filter the gamelist based on these values. As well, the game will be launched using the default emulator, or using the system-wide alternative emulator if this has been configured for the game system. It's only recommended to disable this option for testing purposes.
@ -2172,7 +2194,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| pokemini | Nintendo Pokémon Mini | PokeMini | | No | | | pokemini | Nintendo Pokémon Mini | PokeMini | | No | |
| ports | Ports | N/A | | No | Shell/batch script in separate folder (possibly combined with game data) | | ports | Ports | N/A | | No | Shell/batch script in separate folder (possibly combined with game data) |
| ps2 | Sony PlayStation 2 | PCSX2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 **(Standalone)** [UW] | Yes | | | ps2 | Sony PlayStation 2 | PCSX2 [UW],<br>PCSX2 **(Standalone)** [M] | PCSX2 **(Standalone)** [UW] | Yes | |
| ps3 | Sony PlayStation 3 | RPCS3 **(Standalone)** [UMW*] | | Yes | In separate folder (one folder per game with complete file structure retained, renamed to the .ps3dir extension) | | ps3 | Sony PlayStation 3 | RPCS3 **(Standalone)** [UMW*] | | Yes | In separate folder (one folder per game with complete file structure retained, renamed to the .ps3 extension) |
| ps4 | Sony PlayStation 4 | _Placeholder_ | | | | | ps4 | Sony PlayStation 4 | _Placeholder_ | | | |
| psp | Sony PlayStation Portable | PPSSPP | PPSSPP **(Standalone)** | No | Single ISO file in root folder | | psp | Sony PlayStation Portable | PPSSPP | PPSSPP **(Standalone)** | No | Single ISO file in root folder |
| psvita | Sony PlayStation Vita | _Placeholder_ | | | | | psvita | Sony PlayStation Vita | _Placeholder_ | | | |