From ec4e1dbffe5e926605febb2f0f452e76a9daf39d Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Sun, 4 Feb 2024 17:30:51 +0100 Subject: [PATCH] Documentation update --- ANDROID.md | 8 ++++---- CHANGELOG.md | 3 ++- INSTALL-DEV.md | 6 +++--- USERGUIDE-DEV.md | 6 +++--- 4 files changed, 12 insertions(+), 11 deletions(-) diff --git a/ANDROID.md b/ANDROID.md index c17d56c88..8040ef835 100644 --- a/ANDROID.md +++ b/ANDROID.md @@ -68,9 +68,9 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | gameandwatch | Nintendo Game and Watch | Handheld Electronic (GW) | | No | | | gamecom | Tiger Electronics Game.com | _Placeholder_ | | | | | gamegear | Sega Game Gear | Genesis Plus GX | Genesis Plus GX Wide,
Gearsystem,
SMS Plus GX,
PicoDrive | No | Single archive or ROM file | -| gb | Nintendo Game Boy | Gambatte | SameBoy,
Gearboy,
TGB Dual,
Mesen-S,
bsnes,
mGBA,
VBA-M | No | Single archive or ROM file | +| gb | Nintendo Game Boy | Gambatte | SameBoy,
Gearboy,
TGB Dual,
DoubleCherryGB,
Mesen-S,
bsnes,
mGBA,
VBA-M | No | Single archive or ROM file | | gba | Nintendo Game Boy Advance | mGBA | VBA-M,
VBA Next,
gpSP | No | Single archive or ROM file | -| gbc | Nintendo Game Boy Color | Gambatte | SameBoy,
Gearboy,
TGB Dual,
Mesen-S,
bsnes,
mGBA,
VBA-M | No | Single archive or ROM file | +| gbc | Nintendo Game Boy Color | Gambatte | SameBoy,
Gearboy,
TGB Dual,
DoubleCherryGB,
Mesen-S,
bsnes,
mGBA,
VBA-M | No | Single archive or ROM file | | gc | Nintendo GameCube | Dolphin | Dolphin **(Standalone)** | No | Disc image file for single-disc games, .m3u playlist for multi-disc games | | genesis | Sega Genesis | Genesis Plus GX | Genesis Plus GX Wide,
PicoDrive | No | Single archive or ROM file | | gmaster | Hartung Game Master | _Placeholder_ | | | | @@ -105,10 +105,10 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | naomi | Sega NAOMI | Flycast | Flycast **(Standalone)** | Yes | Single archive file + .chd file in subdirectory if GD-ROM game | | naomi2 | Sega NAOMI 2 | Flycast | Flycast **(Standalone)** | Yes | Single archive file + .chd file in subdirectory if GD-ROM game | | naomigd | Sega NAOMI GD-ROM | Flycast | Flycast **(Standalone)** | Yes | Single archive file + .chd file in subdirectory if GD-ROM game | -| n3ds | Nintendo 3DS | Citra | Citra **(Standalone)**,
Citra MMJ **(Standalone)** | No | Single ROM file | +| n3ds | Nintendo 3DS | Citra | Citra **(Standalone)** [Play store version or Nightly],
Citra Canary **(Standalone)**,
Citra MMJ **(Standalone)** | No | Single ROM file | | n64 | Nintendo 64 | Mupen64Plus-Next | M64Plus FZ **(Standalone)**,
ParaLLEl N64 | No | Single archive or ROM file | | n64dd | Nintendo 64DD | Mupen64Plus-Next | ParaLLEl N64 | Yes | | -| nds | Nintendo DS | DeSmuME | DeSmuME 2015,
melonDS DS,
melonDS,
DraStic **(Standalone)** | No | Single archive or ROM file | +| nds | Nintendo DS | melonDS DS | melonDS @,
DeSmuME,
DeSmuME 2015,
DraStic **(Standalone)** | No | Single archive or ROM file | | neogeo | SNK Neo Geo | FinalBurn Neo | MAME4droid **(Standalone)** | Yes | Single archive or ROM file | | neogeocd | SNK Neo Geo CD | NeoCD | FinalBurn Neo | Yes | | | neogeocdjp | SNK Neo Geo CD [Japan] | NeoCD | FinalBurn Neo | Yes | | diff --git a/CHANGELOG.md b/CHANGELOG.md index 80af48c02..2ad4c99e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,7 +26,8 @@ * Added Mednafen standalone as an alternative emulator for the gb, gba and gbc systems * Added Mesen standalone as an alternative emulator for the gamegear, mastersystem, multivision and sg-1000 systems on Linux, Unix and Windows * Set Mesen standalone to specifically run in Super Game Boy mode for the sgb system on Linux, Unix and Windows -* Added the melonDS DS RetroArch core as an alternative emulator for the nds system +* Added the DoubleCherryGB RetroArch core as an alternative emulator for the gb and gbc systems on Linux, Unix and Windows +* Added the melonDS DS RetroArch core as the default emulator for the nds system * (Linux) Added support for the AppImage release of Vita3K * (Linux) Added support for the Flatpak release of puNES * Added the .zso file extension to the ps2 system diff --git a/INSTALL-DEV.md b/INSTALL-DEV.md index 3fe63c65c..dbbe57a4d 100644 --- a/INSTALL-DEV.md +++ b/INSTALL-DEV.md @@ -1117,7 +1117,7 @@ Normally the scraper will stop whenever an HTTP error code with value 400 or abo The passkey to use to change from the _Kiosk_ or _Kid_ UI modes to the _Full_ UI mode. -**UserThemeDirectory** +**UserThemeDirectory** _(All operating systems except Android)_ Sets the user theme directory. If left blank it will default to `~/ES-DE/themes/` @@ -1730,11 +1730,11 @@ The es_systems.xml file on Android utilizes variables heavily to implement the _ `%ACTION%` - The general Intent action to be performed, you need to assign its value using an equal sign. +`%MIMETYPE%` - Sets an explicit MIME type, which you need to assign using an equal sign such as %MIMETYPE%=text/plain. You will rarely, if ever, need to set an explicit MIME type so this variable is of limited use. By default Android will set the MIME type to application/octet-stream which is normally what you want. + There are two main ways to pass options to emulators, using _extras_ or using the _data_ URI. There can only be a single data URI but there can be an arbitrary amount of extras. To understand more about the way this works, you can read about the _putExtra()_ and and _setData()_ functions here:\ https://developer.android.com/reference/android/content/Intent -`%MIMETYPE%` - Sets an explicit MIME type, which you need to assign using an equal sign such as %MIMETYPE%=text/plain. You will rarely, if ever, need to set an explicit MIME type so this variable is of limited use. By default Android will set the MIME type to application/octet-stream which is normally what you want. - There are three approaches to passing game ROMs to emulators by using the following variables: `%ROM%` - Replaced with the absolute path to the selected ROM. This is a traditional method to provide the game ROM and its use will likely decrease or go away completely long term as emulators move to more modern methods. diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index d9ae009da..46e39edf4 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -4011,9 +4011,9 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | gameandwatch | Nintendo Game and Watch | MAME Local Artwork **(Standalone)** | MAME **(Standalone)**,
Handheld Electronic (GW) | No | See the specific _LCD handheld games_ section elsewhere in this guide | | gamecom | Tiger Electronics Game.com | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file | | gamegear | Sega Game Gear | Genesis Plus GX | Genesis Plus GX Wide,
Gearsystem,
SMS Plus GX,
PicoDrive,
Mednafen **(Standalone)**,
Mesen **(Standalone)** [LW],
ares **(Standalone)** | No | Single archive or ROM file | -| gb | Nintendo Game Boy | Gambatte | SameBoy,
SameBoy **(Standalone)**,
Gearboy,
Gearboy **(Standalone)** [LW],
TGB Dual,
Mesen-S,
Mesen **(Standalone)** [LW],
bsnes,
mGBA,
mGBA **(Standalone)**,
VBA-M,
VBA-M **(Standalone)**,
Mednafen **(Standalone)**,
ares **(Standalone)**,
SkyEmu **(Standalone)** | No | Single archive or ROM file | +| gb | Nintendo Game Boy | Gambatte | SameBoy,
SameBoy **(Standalone)**,
Gearboy,
Gearboy **(Standalone)** [LW],
TGB Dual,
DoubleCherryGB [LW],
Mesen-S,
Mesen **(Standalone)** [LW],
bsnes,
mGBA,
mGBA **(Standalone)**,
VBA-M,
VBA-M **(Standalone)**,
Mednafen **(Standalone)**,
ares **(Standalone)**,
SkyEmu **(Standalone)** | No | Single archive or ROM file | | gba | Nintendo Game Boy Advance | mGBA | mGBA **(Standalone)**,
VBA-M,
VBA-M **(Standalone)**,
VBA Next,
gpSP,
Mednafen **(Standalone)**,
ares **(Standalone)**,
SkyEmu **(Standalone)** | Yes for ares | Single archive or ROM file | -| gbc | Nintendo Game Boy Color | Gambatte | SameBoy,
SameBoy **(Standalone)**,
Gearboy,
Gearboy **(Standalone)** [LW],
TGB Dual,
Mesen-S,
Mesen **(Standalone)** [LW],
bsnes,
mGBA,
mGBA **(Standalone)**,
VBA-M,
VBA-M **(Standalone)**,
Mednafen **(Standalone)**,
ares **(Standalone)**,
SkyEmu **(Standalone)** | No | Single archive or ROM file | +| gbc | Nintendo Game Boy Color | Gambatte | SameBoy,
SameBoy **(Standalone)**,
Gearboy,
Gearboy **(Standalone)** [LW],
TGB Dual,
DoubleCherryGB [LW],
Mesen-S,
Mesen **(Standalone)** [LW],
bsnes,
mGBA,
mGBA **(Standalone)**,
VBA-M,
VBA-M **(Standalone)**,
Mednafen **(Standalone)**,
ares **(Standalone)**,
SkyEmu **(Standalone)** | No | Single archive or ROM file | | gc | Nintendo GameCube | Dolphin | Dolphin **(Standalone)**,
PrimeHack **(Standalone)** [LW],
Triforce **(Standalone)** [LW] | No | Disc image file for single-disc games, .m3u playlist for multi-disc games | | genesis | Sega Genesis | Genesis Plus GX | Genesis Plus GX Wide,
PicoDrive,
BlastEm,
BlastEm **(Standalone)** [L],
Mednafen **(Standalone)**,
ares **(Standalone)** | No | Single archive or ROM file | | gmaster | Hartung Game Master | MAME - Current | MAME **(Standalone)** | Yes | Single archive or ROM file | @@ -4051,7 +4051,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | n3ds | Nintendo 3DS | Citra [LW],
Citra **(Standalone)** [M] | Citra 2018 [LW],
Citra **(Standalone)** [LW] | No | Single ROM file | | n64 | Nintendo 64 | Mupen64Plus-Next | Mupen64Plus **(Standalone)**,
ParaLLEl N64,
simple64 **(Standalone)** [LW],
Rosalie's Mupen GUI **(Standalone)** [LW],
Project64 **(Standalone)** [W],
ares **(Standalone)**,
sixtyforce **(Standalone)** [M] | No | Single archive or ROM file | | n64dd | Nintendo 64DD | ParaLLEl N64 [LW],
Mupen64Plus-Next [M] | Mupen64Plus-Next [LW],
ParaLLEl N64 [M],
Rosalie's Mupen GUI **(Standalone)** [LW],
ares **(Standalone)** | Yes | See the specific _Nintendo 64DD_ section elsewhere in this guide | -| nds | Nintendo DS | DeSmuME | DeSmuME 2015,
DeSmuME **(Standalone)** [L],
melonDS DS,
melonDS @,
melonDS **(Standalone)**,
SkyEmu **(Standalone)** | No | Single archive or ROM file | +| nds | Nintendo DS | melonDS DS | melonDS @,
melonDS **(Standalone)**,
DeSmuME,
DeSmuME 2015,
DeSmuME **(Standalone)** [L],
SkyEmu **(Standalone)** | No | Single archive or ROM file | | neogeo | SNK Neo Geo | FinalBurn Neo | FinalBurn Neo **(Standalone)** [LW],
MAME **(Standalone)** | Yes | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | | neogeocd | SNK Neo Geo CD | NeoCD | FinalBurn Neo,
FinalBurn Neo **(Standalone)** [L],
MAME **(Standalone)** | Yes | .chd (NeoCD and MAME only) or .cue file | | neogeocdjp | SNK Neo Geo CD [Japan] | NeoCD | FinalBurn Neo,
FinalBurn Neo **(Standalone)** [L],
MAME **(Standalone)** | Yes | .chd (NeoCD and MAME only) or .cue file |