From 41d601b88a9daf69f3e5ef50463bf994f70478d1 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Sat, 17 Dec 2022 19:51:57 +0100 Subject: [PATCH] Documentation update. --- CHANGELOG.md | 10 ++++++--- CONTRIBUTING.md | 25 ++++++++++++----------- USERGUIDE-DEV.md | 10 ++++----- es-app/assets/Windows_Portable_README.txt | 1 + 4 files changed, 26 insertions(+), 20 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 476f4a9dd..22aae5fd1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -54,18 +54,21 @@ * Added support for the mugen system on Linux and macOS using the Ikemen GO game engine * Added CPCemu standalone as an alternative emulator for the amstradcpc system * Added MAME standalone as an alternative emulator for the gx4000 system +* Added MAME standalone as an alternative emulator for the atarijaguar system +* (Windows) Added BigPEmu standalone as an alternative emulator for the atarijaguar system +* Reverted the atarijaguarcd system to placeholder status as no emulators including Virtual Jaguar run these games properly * Added the . (dot) file extension to the xbox360 system on Windows to support extensionless XBLA games * Added the .car and .rom file extensions to the a5200 system * Added the .car file extension to the atari800 system * Added the .bin file extension to the gx4000 system * Added the .m3u file extension to the pcfx system -* Removed the .7z and .zip file extensions from the 3do, neogeocd and neogeocdjp systems +* Removed the .7z and .zip file extensions from the 3do, neogeocd, neogeocdjp and switch 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 Linux -* Added FinalBurn Neo standalone as an alternative emulator for the fbneo and neogeo system on Windows +* (Linux) Added FinalBurn Neo standalone as an alternative emulator for the arcade, cps, fbneo, mame, neogeo, neogeocd and neogeocdjp systems +* (Windows) Added FinalBurn Neo standalone as an alternative emulator for the arcade, cps, fbneo, mame and neogeo system * 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 * (Linux) Added Flatpak support for Mednafen using the Mednaffe package @@ -231,6 +234,7 @@ * Multiple levels of symlinking in the ROMs directory tree could crash the application on startup * Adding a dot (.) to the es_systems.xml extension tag (to setup extensionless entries) lead to a crash if the system contained folders +* Parsing of .desktop files on Unix did not properly handle escaping of % characters which made game launching fail for some RPCS3 games * For the cps system, MAME standalone was configured with the wrong system directory for the -rompath option, pointing to "arcade" instead of "cps" * During some menu operations that reloaded the gamelist view, the cached background could miss some components as they were not rendered in time * Text wrapping did not work correctly for text that typically does not contain spaces, like Japanese diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3abc02e78..44b6adbd3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,22 +77,22 @@ The roadmap is under constant review so expect it to change from time to time. S #### v2.1 -* Add element transition animations to the theme engine -* New texture/cache manager with improved memory management and support for GIF and Lottie animations -* Reduced amount of gamelist reloading to retain cached textures and improve overall performance -* Add scraping of game manuals and maps and create a viewer for these (with PDF, GIF, JPG and PNG support) -* Support for additional scraper services (if feasible?) -* Web proxy support for the scraper +* Theme engine composite element support for enabling advanced and finely controlled layouts +* Theme engine element animation support (storyboards) +* New texture/cache manager with improved memory management and performance +* Better and more accurate RAM and VRAM usage statistics +* Scraping of game manuals and maps plus a viewer for these (with PDF and raster image support) +* Support for additional scraper services * RetroAchievements.org integration -* Add "time played" counter per game, similar to how it works in Steam #### v2.2 * Theme downloader -* Scrollbar component for the gamelist view which can be used by the themes -* Reorganize the menus, possibly adding basic/advanced modes * Background music * Proper audio mixer +* Reorganize the menus, possibly adding basic/advanced modes +* Reduced amount of gamelist reloading to retain cached textures and improve overall performance +* Add "time played" counter per game, similar to how it works in Steam * Checksum support for the scraper for exact searches and for determining when to overwrite files * Support for portrait orientation, e.g. for Tate Mode arcade cabinets * Replace the built-in Unicode functions and lookup tables with those of the ICU library @@ -101,11 +101,12 @@ The roadmap is under constant review so expect it to change from time to time. S #### v2.3 * Vulkan renderer for all supported operating systems +* Use of MoltenVK to get Metal support on macOS * Localization/multi-language support -* Dependency on MoltenVK to get Metal support on macOS -* Better and more accurate GPU and memory usage statistics overlay -* Simple file browsing component * Bulk metadata editor +* Scrollbar component for the gamelist view which can be used by themes +* Simple file browsing component +* Web proxy support for the scraper * Improve multi-threading #### v2.4 diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index bf137b108..3b890d85a 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -3054,14 +3054,14 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | android | Google Android | BlueStacks **(Standalone)** [W] | | No | Shortcut (.lnk) file in root folder | | apple2 | Apple II | LinApple **(Standalone)** [U],
Mednafen **(Standalone)** [M],
AppleWin **(Standalone)** [W*] | Mednafen **(Standalone)** [UW*],
MAME **(Standalone)** [UMW*] | Yes for Mednafen and MAME | See the specific _Apple II_ section elsewhere in this guide | | apple2gs | Apple IIGS | MAME **(Standalone)** [UMW*] | | Yes | See the specific _Apple IIGS_ section elsewhere in this guide | -| arcade | Arcade | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)** [UMW*],
FinalBurn Neo,
FB Alpha 2012,
Flycast,
Flycast **(Standalone)** [UMW*],
Kronos [UW],
Model 2 Emulator **(Standalone)** [W*],
Model 2 Emulator [Suspend ES-DE] **(Standalone)** [W*],
Supermodel **(Standalone)** [UW*],
Supermodel [Fullscreen] **(Standalone)** [UW*] | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | +| arcade | Arcade | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)** [UMW*],
FinalBurn Neo,
FinalBurn Neo **(Standalone)** [UW*],
FB Alpha 2012,
Flycast,
Flycast **(Standalone)** [UMW*],
Kronos [UW],
Model 2 Emulator **(Standalone)** [W*],
Model 2 Emulator [Suspend ES-DE] **(Standalone)** [W*],
Supermodel **(Standalone)** [UW*],
Supermodel [Fullscreen] **(Standalone)** [UW*] | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | | astrocde | Bally Astrocade | MAME - Current | MAME **(Standalone)** [UMW*] | | See the specific _Bally Astrocade_ section elsewhere in this guide | | atari2600 | Atari 2600 | Stella | Stella 2014,
ares **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder | | atari5200 | Atari 5200 | a5200 | Atari800,
Atari800 **(Standalone)** [UMW*] | Yes | | | atari7800 | Atari 7800 ProSystem | ProSystem | | Yes | | | atari800 | Atari 800 | Atari800 | Atari800 **(Standalone)** [UMW*] | No | | -| atarijaguar | Atari Jaguar | Virtual Jaguar | | No | | -| atarijaguarcd | Atari Jaguar CD | Virtual Jaguar | | | | +| atarijaguar | Atari Jaguar | Virtual Jaguar | BigPEmu **(Standalone**) [W*],
MAME **(Standalone)** [UMW*] | Yes for MAME | Single archive or ROM file in root folder | +| atarijaguarcd | Atari Jaguar CD | _Placeholder_ | | | | | atarilynx | Atari Lynx | Handy | Beetle Lynx,
Mednafen **(Standalone)** [UMW*] | | | | atarist | Atari ST [also STE and Falcon] | Hatari | | | | | atarixe | Atari XE | Atari800 | Atari800 **(Standalone)** [UMW*] | No | | @@ -3075,7 +3075,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | channelf | Fairchild Channel F | FreeChaF | | | | | coco | Tandy Color Computer | XRoar CoCo 2 NTSC **(Standalone)** [UMW*] | XRoar CoCo 2 PAL **(Standalone)** [UMW*] | Yes | See the specific _Tandy Color Computer_ section elsewhere in this guide | | colecovision | ColecoVision | blueMSX | Gearcoleco,
openMSX **(Standalone)** [UMW*],
ares **(Standalone)** [UMW*] | Yes | Single archive or ROM file in root folder | -| cps | Capcom Play System | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)** [UMW*],
FinalBurn Neo,
FB Alpha 2012,
FB Alpha 2012 CPS-1,
FB Alpha 2012 CPS-2,
FB Alpha 2012 CPS-3 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | +| cps | Capcom Play System | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)** [UMW*],
FinalBurn Neo,
FinalBurn Neo **(Standalone)** [UW*],
FB Alpha 2012,
FB Alpha 2012 CPS-1,
FB Alpha 2012 CPS-2,
FB Alpha 2012 CPS-3 | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | | daphne | Daphne Arcade LaserDisc Emulator | Hypseus [Daphne] **(Standalone)** [UW*] | Hypseus [Singe] **(Standalone)** [UW*] | Yes for Daphne games | See the specific _Hypseus Singe (Daphne)_ section elsewhere in this guide | | desktop | Desktop Applications | _Suspend ES-DE_ | _Keep ES-DE running_ | | See the specific _Ports and desktop applications_ section elsewhere in this guide | | doom | Doom | PrBoom | Boom 3 [UW],
Boom 3 xp [UW],
_Shortcut or script_ | No | | @@ -3104,7 +3104,7 @@ The **@** symbol indicates that the emulator is _deprecated_ and will be removed | lutris | Lutris Open Gaming Platform | Lutris application **(Standalone)** [U] | | No | See the specific _Lutris_ section elsewhere in this guide | | lutro | Lutro Game Engine | Lutro | | | | | macintosh | Apple Macintosh | Basilisk II **(Standalone)** [UMW*] | SheepShaver **(Standalone)** [UMW*] | Yes | See the specific _Apple Macintosh_ section elsewhere in this guide | -| mame | Multiple Arcade Machine Emulator | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)** [UMW*],
FinalBurn Neo,
FB Alpha 2012,
Flycast,
Flycast **(Standalone)** [UMW*],
Kronos [UW],
Model 2 Emulator **(Standalone)** [W*],
Model 2 Emulator [Suspend ES-DE] **(Standalone)** [W*],
Supermodel **(Standalone)** [UW*],
Supermodel [Fullscreen] **(Standalone)** [UW*] | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | +| mame | Multiple Arcade Machine Emulator | MAME - Current | MAME 2010,
MAME 2003-Plus,
MAME 2000,
MAME **(Standalone)** [UMW*],
FinalBurn Neo,
FinalBurn Neo **(Standalone)** [UW*],
FB Alpha 2012,
Flycast,
Flycast **(Standalone)** [UMW*],
Kronos [UW],
Model 2 Emulator **(Standalone)** [W*],
Model 2 Emulator [Suspend ES-DE] **(Standalone)** [W*],
Supermodel **(Standalone)** [UW*],
Supermodel [Fullscreen] **(Standalone)** [UW*] | Depends | See the specific _Arcade and Neo Geo_ section elsewhere in this guide | | mame-advmame | AdvanceMAME | _Placeholder_ | | Depends | | | mame-mame4all | MAME4ALL | _Placeholder_ | | Depends | | | mastersystem | Sega Master System | Genesis Plus GX | Genesis Plus GX Wide,
SMS Plus GX,
Gearsystem,
PicoDrive,
Mednafen **(Standalone)** [UMW*],
ares **(Standalone)** [UMW*] | No | Single archive or ROM file in root folder | diff --git a/es-app/assets/Windows_Portable_README.txt b/es-app/assets/Windows_Portable_README.txt index 30679bea1..d71a21856 100644 --- a/es-app/assets/Windows_Portable_README.txt +++ b/es-app/assets/Windows_Portable_README.txt @@ -30,6 +30,7 @@ Emulators\ArcadeFlashWeb\ArcadeFlashWeb.exe Emulators\ares\ares.exe Emulators\atari800\atari800.exe Emulators\BasiliskII\BasiliskII.exe +Emulators\BigPEmu\BigPEmu.exe Emulators\bsnes\bsnes.exe Emulators\cemu\Cemu.exe Emulators\Citra\canary-mingw\citra-qt.exe