From e22662432732deb4817125cc0d0bb26cfae7cb14 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Fri, 12 Aug 2022 13:44:47 +0200 Subject: [PATCH] Documentation update. --- CHANGELOG.md | 4 ++++ INSTALL-DEV.md | 11 +++++++++++ USERGUIDE-DEV.md | 12 ++++++------ 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1d2247409..72f0d1ff0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,9 @@ * Renamed the default theme set from rbsimple-DE to slate-DE * (Windows) Made game launching more seamless by making the application window one pixel wider instead of one pixel less in height * Added ares standalone as an alternative emulator for many systems +* Added VICE standalone as an alternative emulator for the c64 (x64sc only) and vic20 systems +* (Linux) Added Flatpak support for Mednafen using the Mednaffe package +* (Linux) Added Flatpak support for Solarus using the Solarus Launcher package * Added support for folder links, used for launching game files inside folders without having to enter them * Added a folder badge, including a folder link overlay in case a link has been configured * Added a collection badge, shown when editing custom collections to indicate that a game is part of the collection @@ -25,6 +28,7 @@ * OpenGL: Added an OpenGLVersion setting for choosing between OpenGL 3.3, 4.2 and 4.6 (has to be manually set in es_settings.xml) * OpenGL ES: Added an OpenGLVersion setting for choosing between OpenGL ES 3.0, 3.1 and 3.2 (has to be manually set in es_settings.xml) * Greatly improved the performance of shader post-processing such as scanlines and blur rendering +* Added support for substituting the emulator binary in staticpath rules with an explicit command (useful for launching specific binaries in Flatpaks) * 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 * Removed the "Preload gamelists on startup" setting diff --git a/INSTALL-DEV.md b/INSTALL-DEV.md index 263da97e4..fa8942aae 100644 --- a/INSTALL-DEV.md +++ b/INSTALL-DEV.md @@ -1521,6 +1521,17 @@ The other rules are probably self-explanatory with `systempath` searching the PA ``` +There is also support for substituting the emulator binary in a staticpath rule with an explicit command. To accomplish this add a pipe (|) character after the emulator entry followed by the command to execute. This is for example useful for Flatpaks when you want to check the presence of a package while still launching a specific command inside the package using the --command option. For example: + +``` xml + + /var/lib/flatpak/exports/bin/com.github.AmatCoder.mednaffe|flatpak run --command=mednafen com.github.AmatCoder.mednaffe + ~/.local/share/flatpak/exports/bin/com.github.AmatCoder.mednaffe|flatpak run --command=mednafen com.github.AmatCoder.mednaffe + +``` + +This will execute the regular logic of checking if the Mednaffe Flatpak is installed but will actually run the command after the pipe character when launching the game. Note that no checks or controls are in place for the explicitly defined command, it's just blindly executed. + The winregistrypath rules are always processed first, followed by winregistryvalue, then systempath and finally staticpath. This is done regardless of which order they are defined in the es_find_rules.xml file. As for `corepath` this rule is simply a path to search for the emulator core. diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index 520cf0abd..1ebcb6ef7 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -2907,7 +2907,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | atarixe | Atari XE | Atari800 | Atari800 **(Standalone)** [UMW*] | No | | | atomiswave | Atomiswave | Flycast | Flycast **(Standalone)** [UMW*] | | | | bbcmicro | BBC Micro | _Placeholder_ | | | | -| c64 | Commodore 64 | VICE x64sc Accurate | VICE x64 Fast,
VICE x64 SuperCPU,
VICE x128,
Frodo | No | Single disk, tape or cartridge image in root folder and/or multi-disc images in separate folder | +| c64 | Commodore 64 | VICE x64sc Accurate | VICE x64sc Accurate **(Standalone)** [UMW*],
VICE x64 Fast,
VICE x64 SuperCPU,
VICE x128,
Frodo | No | Single disk, tape or cartridge image in root folder and/or multi-disc images in separate folder | | cavestory | Cave Story (NXEngine) | NXEngine | | | | | cdimono1 | Philips CD-i | SAME CDi | CDi 2015 | Yes | Single .bin/.cue pair in root folder | | cdtv | Commodore CDTV | PUAE | PUAE 2021 | Yes | | @@ -3003,16 +3003,16 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | sega32xjp | Sega Super 32X [Japan] | PicoDrive | ares **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder | | sega32xna | Sega Genesis 32X [North America] | PicoDrive | ares **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder | | segacd | Sega CD | Genesis Plus GX | Genesis Plus GX Wide,
PicoDrive,
ares **(Standalone)** [UMW*] | Yes | | -| sfc | Nintendo SFC (Super Famicom) | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)** [UMW*],
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [UW*],
Beetle Supafaust [UW],
Mesen-S | No | Single archive or ROM file in root folder | +| sfc | Nintendo SFC (Super Famicom) | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)** [UMW*],
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [UW*],
Beetle Supafaust [UW],
Mesen-S,
Mednafen **(Standalone)** [UMW*],
ares **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder | | sg-1000 | Sega SG-1000 | Genesis Plus GX | Genesis Plus GX Wide,
Gearsystem,
blueMSX,
ares **(Standalone)** [UMW*] | No | | | sgb | Nintendo Super Game Boy | Mesen-S | mGBA,
mGBA **(Standalone)** | | Single archive or ROM file in root folder | -| snes | Nintendo SNES (Super Nintendo) | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)** [UMW*],
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [UW*],
Beetle Supafaust [UW],
Mesen-S | No | Single archive or ROM file in root folder | -| snesna | Nintendo SNES (Super Nintendo) [North America] | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)** [UMW*],
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [UW*],
Beetle Supafaust [UW],
Mesen-S | No | Single archive or ROM file in root folder | +| snes | Nintendo SNES (Super Nintendo) | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)** [UMW*],
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [UW*],
Beetle Supafaust [UW],
Mesen-S,
Mednafen **(Standalone)** [UMW*],
ares **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder | +| snesna | Nintendo SNES (Super Nintendo) [North America] | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)** [UMW*],
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [UW*],
Beetle Supafaust [UW],
Mesen-S,
Mednafen **(Standalone)** [UMW*],
ares **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder | | solarus | Solarus Game Engine | Solarus **(Standalone)** [UMW*] | | No | Single .solarus game file in root folder | | spectravideo | Spectravideo | blueMSX | | | | | steam | Valve Steam | Steam application **(Standalone)** | | No | See the specific _Steam_ section elsewhere in this guide | | stratagus | Stratagus Game Engine | _Placeholder_ | | | | -| sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)** [UMW*],
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [UW*] | | | +| sufami | Bandai SuFami Turbo | Snes9x - Current | Snes9x 2010,
Snes9x **(Standalone)** [UMW*],
bsnes,
bsnes-hd,
bsnes-mercury Accuracy,
bsnes **(Standalone)** [UW*],
ares **(Standalone)** [UMW*] | | | | supergrafx | NEC SuperGrafx | Beetle SuperGrafx | Beetle PCE,
ares **(Standalone)** [UMW*] | | | | supervision | Watara Supervision | Potator | | No | Single archive or ROM file in root folder | | switch | Nintendo Switch | Yuzu **(Standalone)** [UW] | Ryujinx **(Standalone)** [UW*] | Yes | | @@ -3026,7 +3026,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | trs-80 | Tandy TRS-80 | sdl2trs DOS Diskette **(Standalone)** [UW*] | sdl2trs Bootable Diskette **(Standalone)** [UW*],
sdl2trs CMD File **(Standalone)** [UW*] | Yes | See the specific _Tandy TRS-80_ section elsewhere in this guide | | uzebox | Uzebox | Uzem | | | | | vectrex | Vectrex | vecx | | No | | -| vic20 | Commodore VIC-20 | VICE xvic | | | Single disk, tape or cartridge image in root folder | +| vic20 | Commodore VIC-20 | VICE xvic | VICE xvic **(Standalone)** [UMW*] | No | Single disk, tape or cartridge image in root folder | | videopac | Philips Videopac G7000 | O2EM | | | | | virtualboy | Nintendo Virtual Boy | Beetle VB | Mednafen **(Standalone)** [UMW*] | No | | | wii | Nintendo Wii | Dolphin | Dolphin **(Standalone)** [UMW*],
PrimeHack **(Standalone)** [U] | | |