From 0fc51b59f4efd759b8511524cce9394493bbf557 Mon Sep 17 00:00:00 2001 From: Leon Styhre Date: Thu, 5 May 2022 21:06:43 +0200 Subject: [PATCH] Documentation update. --- CHANGELOG.md | 12 +++++++++++- USERGUIDE-DEV.md | 12 ++++++++++++ USERGUIDE.md | 12 ++++++++++++ 3 files changed, 35 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ec9989a0..96de8698e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -138,6 +138,16 @@ * The device text flickered in GuiDetectDevice when configuring a controller * The selector bar was not aligned correctly during menu scale-up animations +## Version 1.2.4 (in development) + +**Release date:** TBD + +### Release overview + +### Detailed list of changes + +### Bug fixes + ## Version 1.2.3 **Release date:** 2022-05-04 @@ -184,7 +194,7 @@ v1.2 maintenance release. Support has been added for displaying multi-disc/multi * The MAME standalone emulator couldn't be launched * Using a custom image directory for the slideshow screensaver would hang the application if there was only a single image -* On Unix and macOS, staticpaths rules in es_find_rules.xml containing blank spaces would not work +* On Unix and macOS, staticpaths rules in es_find_rules.xml containing spaces would not work * %ESPATH% variables could not be used in es_systems.xml * Navigating the list of alternative emulators would sometimes lead to an incorrect row positioning * On Windows, the find rule for the Mupen64Plus standalone emulator was not setup correctly diff --git a/USERGUIDE-DEV.md b/USERGUIDE-DEV.md index bb9f7f895..19b3faa2c 100644 --- a/USERGUIDE-DEV.md +++ b/USERGUIDE-DEV.md @@ -691,6 +691,18 @@ For the first scenario, to automatically launch a file inside a directory, just In this case the directory is named _Jet Grind Radio.cue_, i.e. exactly the same name as one of the files inside the directory. This means that when launching the game, `~/ROMs/dreamcast/Jet Grind Radio.cue/Jet Grind Radio.cue` will actually be passed to the emulator. +Here's another example when using .m3u files: + +``` +~/ROMs/psx/Final Fantasy VII.m3u/ +~/ROMs/psx/Final Fantasy VII.m3u/Final Fantasy VII (Disc 1).chd +~/ROMs/psx/Final Fantasy VII.m3u/Final Fantasy VII (Disc 2).chd +~/ROMs/psx/Final Fantasy VII.m3u/Final Fantasy VII (Disc 3).chd +~/ROMs/psx/Final Fantasy VII.m3u/Final Fantasy VII.m3u +``` + +In exactly the same manner, the file `~/ROMs/psx/Final Fantasy VII.m3u/Final Fantasy VII.m3u` will be passed to the emulator on game launch. See the section just above this one, _Multiple game files installation_ for details on how .m3u files work. + The second scenario is when an emulator supports passing a directory rather than a file to launch a game. Such an example is the PlayStation 3 emulator RPCS3. For PS3 games the extension in es_systems.xml is .ps3 so this is what a game directory could look like: diff --git a/USERGUIDE.md b/USERGUIDE.md index 13c777e76..2dc4a7f0b 100644 --- a/USERGUIDE.md +++ b/USERGUIDE.md @@ -707,6 +707,18 @@ For the first scenario, to automatically launch a file inside a directory, just In this case the directory is named _Jet Grind Radio.cue_, i.e. exactly the same name as one of the files inside the directory. This means that when launching the game, `~/ROMs/dreamcast/Jet Grind Radio.cue/Jet Grind Radio.cue` will actually be passed to the emulator. +Here's another example when using .m3u files: + +``` +~/ROMs/psx/Final Fantasy VII.m3u/ +~/ROMs/psx/Final Fantasy VII.m3u/Final Fantasy VII (Disc 1).chd +~/ROMs/psx/Final Fantasy VII.m3u/Final Fantasy VII (Disc 2).chd +~/ROMs/psx/Final Fantasy VII.m3u/Final Fantasy VII (Disc 3).chd +~/ROMs/psx/Final Fantasy VII.m3u/Final Fantasy VII.m3u +``` + +In exactly the same manner, the file `~/ROMs/psx/Final Fantasy VII.m3u/Final Fantasy VII.m3u` will be passed to the emulator on game launch. See the section just above this one, _Multiple game files installation_ for details on how .m3u files work. + The second scenario is when an emulator supports passing a directory rather than a file to launch a game. Such an example is the PlayStation 3 emulator RPCS3. For PS3 games the extension in es_systems.xml is .ps3 so this is what a game directory could look like: