Commit 394f9989 authored by Leon Styhre's avatar Leon Styhre
Browse files

Documentation update.

parent 25b1e390
......@@ -159,6 +159,7 @@ v1.2 maintenance release.
* Added experimental support for Vita3K for the psvita system on Unix and Windows
* Added support for the Fujitsu FM Towns (fmtowns) game system on Unix and Windows
* Added support for the EasyRPG game engine (easyrpg) game system
* Added support for the Creatronic Mega Duck (megaduck) game system
* Added support for the Watara Supervision (supervision) game system
* Added support for the M.U.G.E.N Game Engine (mugen) game system on Windows
......@@ -167,7 +168,7 @@ v1.2 maintenance release.
* Added emulator configuration for the macintosh system
* Added emulator configuration for the solarus system
* Added Mednafen standalone as an alternative emulator for many systems
* Added experimental support for PCSX2 Qt standalone for the ps2 system on Unix
* Added PCSX2 Qt standalone as an alternative emulator for the ps2 system on Unix
* Added ScummVM standalone as an alternative emulator for the scummvm system
* Added Cxbx-Reloaded standalone as an alternative emulator for the xbox system on Windows
* Added Atari800 standalone as an alternative emulator for the a5200 system
......
......@@ -442,10 +442,7 @@ tools/create_AppImage_SteamDeck.sh
This is similar to the regular AppImage but does not build with the BUNDLED_CERTS option and changes some settings like the VRAM limit.
Both _appimagetool_ and _linuxdeploy_ are required for the build process but they will be downloaded automatically by the script if they don't exist. So to force an update to the latest build tools, delete these two AppImages prior to running the build script. Be aware though that some releases of linuxdeploy may be broken and could lead to the inclusion of invalid dependencies that will make the package unusable on some distributions. The release with the following -V output has been tested and is working correctly:
```
linuxdeploy version 1-alpha (git commit ID 9aa59f3), GitHub actions build 41 built on 2021-11-20 01:00:04 UTC
```
Both _appimagetool_ and _linuxdeploy_ are required for the build process but they will be downloaded automatically by the script if they don't exist. So to force an update to the latest build tools, delete these two AppImages prior to running the build script.
## Building on macOS
......@@ -1146,6 +1143,8 @@ The bundled es_systems.xml file is located in the resources directory that is pa
It doesn't matter in which order you define the systems as they will be sorted by the `<fullname>` tag or by the optional `<systemsortname>` tag when displayed inside the application. But it's still a good idea to add the systems in alphabetical order to make the configuration file easier to maintain.
Note that the `<systemsortname>` tags are sorted in [lexicographic order](https://en.wikipedia.org/wiki/Lexicographic_order) so 11 will be sorted above 2 but 002 will be sorted above 011.
Wildcards are supported for emulator binaries, but not for directories:
```xml
<!-- This is supported, first matching file will be selected -->
......@@ -1178,7 +1177,7 @@ Below is an overview of the file layout with various examples. For the command t
<!-- By default the systems are sorted by their full names, but this can be overridden by setting the optional
<systemsortname> tag to an arbitrary value. As far as sorting is concerned, the effect will be identical to
changing the <fullname> tag. Apart for system sorting, this tag has no effect and its actual value will not
be displayed anywhere within the appliction. -->
be displayed anywhere within the appliction. Note that the sorting is done in lexicographic order. -->
<systemsortname>Super Nintendo</systemsortname>
<!-- The path to look for ROMs in. '~' will be expanded to $HOME or %HOMEPATH%, depending on the operating system.
......
......@@ -466,10 +466,7 @@ tools/create_AppImage_SteamDeck.sh
This is similar to the regular AppImage but does not build with the BUNDLED_CERTS option and changes some settings like the VRAM limit.
Both _appimagetool_ and _linuxdeploy_ are required for the build process but they will be downloaded automatically by the script if they don't exist. So to force an update to the latest build tools, delete these two AppImages prior to running the build script. Be aware though that some releases of linuxdeploy may be broken and could lead to the inclusion of invalid dependencies that will make the package unusable on some distributions. The release with the following -V output has been tested and is working correctly:
```
linuxdeploy version 1-alpha (git commit ID 9aa59f3), GitHub actions build 41 built on 2021-11-20 01:00:04 UTC
```
Both _appimagetool_ and _linuxdeploy_ are required for the build process but they will be downloaded automatically by the script if they don't exist. So to force an update to the latest build tools, delete these two AppImages prior to running the build script.
## Building on macOS
......@@ -1401,6 +1398,8 @@ The bundled es_systems.xml file is located in the resources directory that is pa
It doesn't matter in which order you define the systems as they will be sorted by the `<fullname>` tag or by the optional `<systemsortname>` tag when displayed inside the application. But it's still a good idea to add the systems in alphabetical order to make the configuration file easier to maintain.
Note that the `<systemsortname>` tags are sorted in [lexicographic order](https://en.wikipedia.org/wiki/Lexicographic_order) so 11 will be sorted above 2 but 002 will be sorted above 011.
Wildcards are supported for emulator binaries, but not for directories:
```xml
<!-- This is supported, first matching file will be selected -->
......@@ -1433,7 +1432,7 @@ Below is an overview of the file layout with various examples. For the command t
<!-- By default the systems are sorted by their full names, but this can be overridden by setting the optional
<systemsortname> tag to an arbitrary value. As far as sorting is concerned, the effect will be identical to
changing the <fullname> tag. Apart for system sorting, this tag has no effect and its actual value will not
be displayed anywhere within the appliction. -->
be displayed anywhere within the appliction. Note that the sorting is done in lexicographic order. -->
<systemsortname>Super Nintendo</systemsortname>
<!-- The path to look for ROMs in. '~' will be expanded to $HOME or %HOMEPATH%, depending on the operating system.
......
......@@ -91,6 +91,13 @@ chmod +x EmulationStation-DE-x64.AppImage
For a better desktop integration it's recommended to install [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher) which will add an ES-DE entry to the application menu and move the AppImage file to the `~/Applications` directory (which is the recommended location for all AppImages).
To run AppImage files you need libfuse2 installed, but some newer distributions like Ubuntu 22.04 LTS no longer ship with this library preinstalled. You can however easily install it like this:
```
sudo apt install libfuse2
```
Of course, if you're not using a Debian-based distribution, you may need to use another package manager than apt to install the library.
**Installing on macOS and Windows**
There's not really much to say about these operating systems, just install ES-DE as you would any other application. On macOS it's via the .dmg drag-and-drop installer, and on Windows via the normal application installer or by unpacking the portable zip file somewhere on your filesystem.
......@@ -616,20 +623,22 @@ chmod +x ./rpcs3-v0.0.19-13103-cc21d1b3_linux64.AppImage
The following emulators are supported in AppImage format when using the bundled configuration:
| System name | Emulator | Filename configuration |
| :----------- | :---------- | :------------------------------ |
| _Multiple_ | RetroArch | RetroArch-Linux-x86_64.AppImage |
| gba | mGBA | mGBA*.AppImage |
| gc | Dolphin | Dolphin_Emulator*.AppImage |
| macintosh | Basilisk II | BasiliskII-x86_64.AppImage |
| macintosh | SheepShaver | SheepShaver-x86_64.AppImage |
| ps2 | Play! | Play!*.AppImage |
| ps3 | RPCS3 | rpcs3*.AppImage |
| psx | DuckStation | duckstation-nogui-x64.AppImage |
| psx | DuckStation | duckstation-qt-x64.AppImage |
| switch | Yuzu | yuzu*.AppImage |
| xbox | xemu | Xemu*.AppImage |
| wii | Dolphin | Dolphin_Emulator*.AppImage |
| System name | Emulator | Filename configuration |
| :----------- | :---------- | :--------------------------------------- |
| _Multiple_ | RetroArch | RetroArch-Linux-x86_64.AppImage |
| easyrpg | EasyRPG | easyrpg/easyrpg-player |
| gba | mGBA | mGBA*.AppImage |
| gc | Dolphin | Dolphin_Emulator*.AppImage |
| macintosh | Basilisk II | BasiliskII-x86_64.AppImage |
| macintosh | SheepShaver | SheepShaver-x86_64.AppImage |
| ps2 | PCSX2 | pcsx2-*-linux-AppImage-64bit-Qt.AppImage |
| ps2 | Play! | Play!*.AppImage |
| ps3 | RPCS3 | rpcs3*.AppImage |
| psx | DuckStation | duckstation-nogui-x64.AppImage |
| psx | DuckStation | duckstation-qt-x64.AppImage |
| switch | Yuzu | yuzu*.AppImage |
| xbox | xemu | Xemu*.AppImage |
| wii | Dolphin | Dolphin_Emulator*.AppImage |
RetroArch does not embed any version information into the filename so no wildcard is required.
......@@ -1474,6 +1483,23 @@ This system is only available on Windows and these games are commonly shipped as
Neither ScreenScraper nor TheGamesDB support scraping of M.U.G.E.N games so you will need to manually enter metadata and add game media.
#### EasyRPG Game Engine
Some Linux distributions ship with EasyRPG Player in the repository and on Ubuntu-based systems it's available as a Snap. But for some distributions it may need to be manually downloaded. For these scenarios see the [Using manually downloaded emulators on Linux](USERGUIDE-DEV.md#using-manually-downloaded-emulators-on-linux) section of this guide.
Games are usually provided as .zip archives which you need to unzip into the `~/ROMs/easyrpg` directory. Following this you should rename the directory by adding the .easyrpg extension. The final step is to create an empty file inside the directory with the same name as the folder itself.
Optionally you can also add a file with the .easycfg extension to the game directory to pass game-specific command line parameters on launch. See the EasyRPG documentation for a list of valid options.
Here's an example of what a setup could look like:
```
~/ROMs/easyrpg/Dreamscape.easyrpg/
~/ROMs/easyrpg/Dreamscape.easyrpg/Dreamscape.easyrpg
~/ROMs/easyrpg/Dreamscape.easyrpg/Dreamscape.easycfg
~/ROMs/easyrpg/The Chimera Report.easyrpg/
~/ROMs/easyrpg/The Chimera Report.easyrpg/The Chimera Report.easyrpg
```
#### PICO-8
PICO-8 Fantasy Console is a game engine developed by [Lexaloffle Games](https://www.lexaloffle.com/pico-8.php) that you need to buy a license to use. Doing so will provide you with download links to releases for Linux, macOS and Windows. Make sure to use the 64-bit release as the 32-bit release reportedly has some technical issues. On macOS and Windows the installation is straightforward, but on Linux you need to place PICO-8 in a location recognized by ES-DE. See the [Using manually downloaded emulators on Linux](USERGUIDE-DEV.md#using-manually-downloaded-emulators-on-linux) section of this guide for more details.
......@@ -2780,6 +2806,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed
| dos | DOS (PC) | DOSBox-Pure | DOSBox-Core,<br>DOSBox-SVN,<br>DOSBox-X **(Standalone)**,<br>DOSBox Staging **(Standalone)** [UMW*] | No | See the specific _DOS / PC_ section elsewhere in this guide |
| dragon32 | Dragon 32 | _Placeholder_ | | | |
| dreamcast | Sega Dreamcast | Flycast | Flycast **(Standalone)** [UMW*],<br>Redream **(Standalone)** [UMW*] | No | In separate folder |
| easyrpg | EasyRPG Game Engine | EasyRPG Player **(Standalone)** | | 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 |
| famicom | Nintendo Family Computer | Mesen | Nestopia UE,<br>Nestopia UE **(Standalone)** [U],<br>FCEUmm,<br>QuickNES,<br>Mednafen **(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 |
......
......@@ -89,6 +89,13 @@ chmod +x EmulationStation-DE-x64.AppImage
For a better desktop integration it's recommended to install [AppImageLauncher](https://github.com/TheAssassin/AppImageLauncher) which will add an ES-DE entry to the application menu and move the AppImage file to the `~/Applications` directory (which is the recommended location for all AppImages).
To run AppImage files you need libfuse2 installed, but some newer distributions like Ubuntu 22.04 LTS no longer ship with this library preinstalled. You can however easily install it like this:
```
sudo apt install libfuse2
```
Of course, if you're not using a Debian-based distribution, you may need to use another package manager than apt to install the library.
**Installing on macOS and Windows**
There's not really much to say about these operating systems, just install ES-DE as you would any other application. On macOS it's via the .dmg drag-and-drop installer, and on Windows via the normal application installer or by unpacking the portable zip file somewhere on your filesystem.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment